Windows.Foundation.UniversalApiContract

Specifies various options for adding a resource package to an app.

Downloads all package updates if they are available.

Restarts the application when resource packages are successfully added.

Downloads the specific package requested.

Provides an application's name, description, and logo

Gets the application's description.

The description of the application as defined in the package manifest (Package.appxmanifest).

Gets the application's display name.

The display name of the application as defined in the package manifest (Package.appxmanifest).

Get the application's logo.

The size of the rectangle in which the logo must fit. The largest logo in your Package.appxmanifest file that will fit in the specified *Size*.

Provides information about an application such as its name, logo, package information, ID.

An identifier that uniquely identifies the app.

The application user model ID for the application.

Retrieves the AppInfo object corresponding to the currently running process.

The AppInfo that corresponds to the process.

Gets information that describes the application.

An object containing information about the app's name, description, and logo.

Gets the app identifier.

The id of the app as defined by the package name in the Package.appxmanifest file.

Retrieves the full Package object for the calling AppInfo object.

The Package associated with the AppInfo.

An identifier that uniquely identifies the app's package.

The package family name

Retrieves the AppInfo object associated with an AppUserModelId (AUMID).

The AUMID of the app from which to retrieve the AppInfo. The AppInfo corresponding to the given AUMID.

Retrieves the AppInfo object associated with a specified User and AppUserModelId (AUMID).

The User whose AppInfos you wish to access. The AUMID of the app from which to retrieve the AppInfo. The AppInfo corresponding to the given AUMID and user.

Provides read-only access to the URI of the .appinstaller XML file location. This allows app developers to retrieve the .appinstaller XML file location when needed by their app.

Provides read-only access to the URI of the .appinstaller XML file location. This allows app developers to retrieve the .appinstaller XML file location when needed by their app.

The URI for the XML file location.

Represents an instance of an app.

Whether the current instance of the app is the registered instance of the app for the specific key that this instance has defined.

A Boolean that indicates whether the current app is the registered instance of the app.

The key for the current instance.

The app-defined key for the current instance.

A shell can recommend an instance of an app to which an application activation is redirected.

The app instance that the shell prefers to use for an app, or `null` if there is no preference.

Registers an app instance with the platform, or finds an existing instance if another instance has already registered this key.

A non-empty string as a key for the instance. An app instance that represents the first app that registered the key.

Gets the current **IActivatedEventArgs**, the same as would normally be passed in to the *OnActivated* method of the app.

The current **IActivatedEventArgs**, or `null`.

Gets the registered instances of the current app.

A list of the registered instances of the current app.

Redirects activation of the current app instance to the specified instance.

Updates the system cache so that the current instance is no longer available for activation redirection.

Enables you to detect whether your app is in design mode in a visual designer.

Used to enable or disable user code inside a XAML designer that targets the Windows 10 Fall Creators Update SDK, or later.

**True** if called from code running inside a XAML designer that targets the Windows 10 Fall Creators Update, or later; otherwise **false**.

Gets a value that indicates whether the process is running in design mode.

**True** if the process is running in design mode; otherwise **false**.

Gets the deferral object when an app has entered the background state.

Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls Deferral.Complete or the deadline for navigation has passed.

The deferral object you will use to indicate when your processing is complete.

Provides an interface definition for the AppInfo class.

Provides an interface definition for the AppInfo.Current method.

The AppInfo that corresponds to the currently running process.

Provides an interface definition for the AppInfo.GetFromAppUserModelId method.

The AUMID to retrieve the AppInfo from. The AppInfo corresponding to the given AUMID.

Provides an interface definition for the AppInfo.GetFromAppUserModelIdForUser method.

The User whose AppInfos you wish to access. The AUMID to retrieve the AppInfo from. The AppInfo corresponding to the given AUMID and user.

Gets the deferral object when an app has entered the background state.

Gets the deferral object which delays the transition from running in the background state to the suspended state until the app calls Deferral.Complete or the deadline for navigation has passed.

The deferral object you will use to indicate when your processing is complete.

Gets the deferral object when the app is leaving the background state.

Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls Deferral.Complete or the deadline for navigation has passed.

The deferral object you will use to indicate that your processing is complete.

Manages a delayed app suspending operation.

Notifies the system that the app has saved its data and is ready to be suspended.

Provides data for an app suspending event.

Gets the app suspending operation.

The suspending operation.

Provides information about an app suspending operation.

Gets the time remaining before a delayed app suspending operation continues.

The time remaining.

Requests that the app suspending operation be delayed.

The suspension deferral.

Gets the deferral object when the app is leaving the background state.

Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls Deferral.Complete or the deadline for navigation has passed.

The deferral object you will use to indicate that your processing is done.

An object returned from a LimitedAccessFeatures.TryUnlockFeature request, which contains information on the feature and its availability.

Provides the estimate date that the current version of the requested feature will become unavailable.

The estimated date at which the token used to gain access to the feature will expire, if known.

Provides the feature ID associated with the request made.

The feature's ID, as provided by Microsoft.

Provides the result of the feature request, which indicates the availability of the feature in question.

A LimitedAccessFeatureStatus value corresponding to the result of the feature request.

This API enables applications to request access to Limited Access Features.

Submits a request to Microsoft to authorize use of a specific Limited Access Feature. Users must have previously obtained a feature ID and a token from Microsoft in order to successfully call this API.

The ID, provided by Microsoft. that identifies the feature being requested. The string receieved from Microsoft upon agreeing to the requirements for use of the feature. A plain-english statement declaring that the publisher has permission to use the feature. A LimitedAccessFeatureRequestResult value indicating the response to the user request.

Provides the result of an attempt to authorize the use of a Limited Access Feature with the LimitedAccessFeatures.TryUnlockFeature API.

Indicates that the user has permission to use the feature, and that the feature is still in the "limited access" state.

Indicates that the feature is no longer in the "limited access" state, and that permission is no longer required for its use.

Indicates that the user does not have access to the feature.

Indicates that the feature could not be found. This is likely due to an incorrect or deleted feature ID.

Provides information about a package.

Gets the package for the current app.

The package.

Gets the packages on which the current package depends.

The packages on which the current package depends.

Gets the description of the package.

The description of the package.

Gets the display name of the package.

The display name.

Gets the location of the machine-wide or per-user external folder specified in the package manifest for the current package, depending on how the app is installed.

The location of the machine-wide or per-user machine-wide external folder specified in the package manifest for the current package, depending on how the app is installed.

Gets the location of the machine-wide or per-user external folder specified in the package manifest for the current package, depending on how the app is installed.

The location of the machine-wide or per-user machine-wide external folder specified in the package manifest for the current package, depending on how the app is installed.

Gets either the location of the installed folder or the mutable folder for the installed package, depending on whether the app is declared to be mutable in its package manifest.

The location of the installed folder or the mutable folder for the installed package, depending on whether the app is declared to be mutable in its package manifest.

Gets either the path of the installed folder or the mutable folder for the installed package, depending on whether the app is declared to be mutable in its package manifest.

The path of the installed folder or the mutable folder for the installed package, depending on whether the app is declared to be mutable in its package manifest.

Gets the package identity of the current package.

The package identity.

Windows Phone only. Gets the date the application package was installed on the user's phone.

The date the application package was installed on the user's phone.

Gets the date on which the application package was installed or last updated.

The date on which the application package was installed or last updated.

Gets the current package's path in the original install folder for the current package.

The current package's path in the original install folder for the current package.

Gets the current package's path in the original install folder for the current package.

The current package's path in the original install folder for the current package.

Indicates whether the package is a bundle package.

A Boolean value that indicates whether the package is a bundle package. **TRUE** indicates that the package is a bundle package; otherwise **FALSE**.

Indicates whether the package is installed in development mode.

A Boolean value that indicates whether the package is installed in development mode. **TRUE** indicates that the package is installed in development mode; otherwise **FALSE**.

Indicates whether other packages can declare a dependency on this package.

True if other packages can declare a dependency on this package; otherwise false.

Indicates whether the package is optional.

Returns **true** if the package is optional; **false** otherwise.

Indicates whether the package is a resource package.

A Boolean value that indicates whether the package is a resource package. **TRUE** indicates that the package is a resource package; otherwise **FALSE**.

Gets a value that indicates whether the application in the current package is a stub application.

**TRUE** indicates that the application is a stub application; otherwise, **FALSE**.

Gets the logo of the package.

The logo of the package.

Gets the location of the machine-wide external folder specified in the package manifest for the current package.

The location of the machine-wide external folder specified in the package manifest for the current package.

Gets the location of the machine-wide external folder specified in the package manifest for the current package.

The location of the machine-wide external folder specified in the package manifest for the current package.

Gets the current package's path in the mutable folder for the installed package, if the app is declared to be mutable in its package manifest.

The location of the mutable folder for the installed package.

Gets the current package's path in the mutable folder for the installed package, if the app is declared to be mutable in its package manifest.

The location of the mutable folder for the installed package.

Gets the publisher display name of the package.

The publisher display name.

How the app package is signed.

The signature kind.

Get the current status of the package for the user.

The current status of the package for the user.

Gets the location of the per-user external folder specified in the package manifest for the current package.

The location of the per-user external folder specified in the package manifest for the current package.

Gets the path of the per-user external folder specified in the package manifest for the current package.

The path of the per-user external folder specified in the package manifest for the current package.

The **CheckUpdateAvailabilityAsync** method allows developers to check for updates to the main app package listed in the .appinstaller file. It allows the developer to determine if the updates are required due to .appinstaller policy. This method currently only works for applications installed via .appinstaller files.

A PackageUpdateAvailabilityResult that indicates if an application has an update, and if the update is required.

Returns the .appinstaller XML file location. Use this method when you need to retrieve the .appinstaller XML file location for your app. For example, this is useful if your app needs to share a URI to its associated .appinstaller file. You can optionally add arguments to the URI.

The .appinstaller XML file location.

Enumerates the packaged apps on the device and returns the list synchronously. Only apps included in the current package are returned.

A list of AppListEntry objects that specify the packaged apps along with their display name, description, and logo.

Enumerates the packaged apps on the device and returns the list asynchronously. Only apps included in the current package are returned.

A list of AppListEntry objects that specify the packaged apps along with their display name, description, and logo.

Provides information about the package content group such as its state, name, whether it is required, and so on.

The name of the content group to get. A PackageContentGroup that contains information such as whether the content group is required, its state, the package associated with the content group, and so on.

Provides information about all of the package content groups in the app and their state, name, whether they are required, and so on.

A list of package content group objects.

Gets the application logo of the package as a random access stream.

The size of the application logo to get. A random access stream that contains the logo.

Windows Phone only. Returns a token that can be used to retrieve the thumbnail image associated with this application package.

A token that can be used to retrieve the thumbnail image associated with this application package.

Windows Phone only. Launches the specified application.

Launch may be altered or unavailable for releases after Windows 8.1. Instead, for SmartCardTrigger scenarios use SmartCardTriggerDetails.TryLaunchSelfAsync The navigation URI that specifies the page to launch and optional parameters. Use an empty string to specify the default page for the app.

Sets whether the package is in use or not.

**True** to specify that the package is in use; **false** otherwise. **True** indicates that the operation to set whether the package is in use or not was successful; **false** otherwise.

Put the packages in the specified content groups into the staging queue.

The names of the content groups to stage. A list of PackageContentGroup objects for each content group specified by the _names_ parameter.

Put the packages in the specified content groups into the staging queue; optionally placing the content groups at the head of the queue.

The names of the content groups to stage. **True** to move the content group to the head of the staging queue; **false** otherwise. A list of PackageContentGroup objects for each content group specified by the _names_ parameter.

Ensures that the package has not been modified or tampered with before being loaded.

**true** - the package has not been modified; **false** otherwise.

Provides access to app packages on the device.

The event that is fired when a package content group starts staging.

Indicates that an app package is installing.

Indicates that an app package is staging.

Indicates that an app package has been removed or updated

Indicates that an app package is uninstalling.

Indicates that an app package is being updated.

Adds an optional package to the package catalog.

The package family of the optional package to add to the catalog. The result of starting the asynchronous operation to add the package.

Adds a resource package to an existing app package.

Package family name that uniquely identifies the app's package. The resource ID of the package. Options to specify the behavior when adding a resource package to an app. The progress report of adding a resource package.

Opens the catalog of packages for the main package.

The package catalog for the main package.

Opens the catalog of app packages on the device that are available to the current user.

The catalog of packages for the current user.

Removes installed optional app packages from the user account.

A list of optional package family name strings. The result of removing the optional package in the form of: PackageCatalogRemoveOptionalPackagesResult.

Removes resource packages from an existing app package.

An iterable collection of resourcePackages to be removed. The result of an attempt to remove the specified resourcePackages.

Provides information about the result of adding an optional package to the package catalog.

Provides error information about the attempt to add an optional package to the catalog.

The exception if one occurred while adding the optional package; **null** otherwise.

Get the optional package that was added to the package catalog.

The optional package or **null** if the package could not be added.

Provides information on the status of adding resource packages to an app package.

An extended error code generated when adding a resource package to an app package.

The extended error code from installing a resource package.

A boolean value that specifies if the resource package has been completely addded to an app.

True if the resource package is completely added; False otherwise.

Gets the app package that the resource package was added to.

The app package.

Provides information on the status of removing optional packages.

Contains the extended error information for removing optional packages.

The extended error information.

A list of the optional packages that were successfully removed from the user account.

A list of optional packages that were removed.

Provides information on the status of removing resource packages from an app package.

An extended error code generated when removing a resource package from an app package.

The extended error code from removing a resource package.

Gets the resource packages that were removed from the app package.

The resource packages that were removed.

Provides information about a package content group.

Indicates whether this package content group is required or automatic.

**True** indicates that the content group is required; **false** otherwise.

Gets the name of this package content group.

The content group name.

Gets the package for this content group.

The package for this content group.

Gets the name of the required content group.

The name of the required content group.

Gets the state of the package content group.

A value describing the package content group state.

Provides information about the package content group that is being staged.

Gets the identifier of the content group staging operation.

A unique value that an app can use to correlate events that relate to a particular content group staging operation.

Gets the name of the content group that is being staged.

The name of the content group.

Gets the result of the package content group staging operation.

The result of the package content group staging operation.

Indicates whether the content group is done staging.

**True** indicates that the content group is done staging; **false**, otherwise.

Indicates whether the content group is required.

**True** indicates that the package content group is required; **false**, otherwise.

Gets the package that is being staged.

The package containing the content group being staged.

Gets an approximation of the package content group's staging progress.

A value in the range of 0 through 100 which represents approximately how far along the content group is in the staging process.

Describes the staging state of the package content group.

The package group has not been staged and is not in the staging queue.

The package has not been staged but is in the queue of packages to be staged.

The package group has been staged.

The package group is currently being staged.

Provides package identification info, such as name, version, and publisher.

Gets the processor architecture for which the package was created.

The processor architecture.

Windows Phone only. Gets the value of the Author attribute for the specified application package.

The value of the Author attribute for the specified application package.

Gets the family name of the package.

The family name.

Gets the full name of the package.

The full name.

Gets the name of the package.

The package name.

Windows Phone only. Gets the value of the ProductID attribute associated with this XAP application package.

The value of the ProductID attribute associated with this XAP application package.

Gets the publisher of the package.

The publisher.

Gets the publisher ID of the package.

The publisher ID.

Gets the resource ID of the package.

The resource ID. If there is no resource ID for the package, this property is null.

Gets the package version info.

The package version information.

Provides information about the app package that is being installed.

Gets the id for the install operation.

A unique value that an app can use to correlate events that relate to a single deployment operation.

Gets the result of the package installation operation.

The code for the error. **S_OK** if no error.

Indicates whether the app package is done installing.

**True** indicates that the app package is done installing; **false**, otherwise.

Gets the package that is installing.

The incoming package.

Gets an approximation of the package's installation progress.

A value in the range of 0 through 1.0 which represents approximately how far along the package is in the installation process.

Gets the installation progress of installing a resource package or an app package.

The percent of the package that has been installed.

Specifies the ways that an app package may be signed.

Deployed in your development environment. The package is signed with a private certificate.

Signed using a certificate used in enterprises.

Not signed.

Signed by the Windows Store.

Built-in system app.

Provides information about the app package that is being staged.

Gets the id for the staging operation.

A unique value that an app can use to correlate events that relate to a single deployment operation.

Gets the result of the package staging operation.

The code for the error. **S_OK** if no error.

Indicates whether the app package is done staging.

**True** indicates that the app package is done staging; **false**, otherwise.

Gets the package that is staging.

The package being staged.

Gets an approximation of the package's staging progress.

A value in the range of 0 through 1.0 which represents approximately how far along the package is in the staging process.

Provides the status of the package.

Indicates whether the data for the package is offline.

**TRUE** indicates that the data for the package is installed on a volume which is currently offline or cannot be accessed; otherwise **FALSE**.

Indicates whether this package depends on a package that can't be used.

**TRUE** indicates that there is a problem with a package that this package depends on; otherwise **FALSE**.

Indicates whether the package is being serviced.

**TRUE** indicates that the package is being serviced and consequently cannot be used; otherwise **FALSE**.

Indicates whether the package has been disabled.

**TRUE** indicates that the package is disabled; otherwise **FALSE**.

Indicates whether the package is partially staged.

**True** means that the package is partially staged; **false**, otherwise.

Indicates whether there is a problem with the license for this package.

**TRUE** indicates that there is a problem with the license for this package; otherwise **FALSE**.

Indicates whether the package is missing files, system information, etc.

**TRUE** indicates that there is a problem with the package such as missing files; otherwise **FALSE**.

Indicates whether the package is unusable.

**FALSE** indicates that the package is in a usable state; otherwise **TRUE**.

Indicates whether the package is available.

**TRUE** indicates that the package is not available; otherwise **FALSE**.

Indicates whether the package is offline and cannot be used.

**TRUE** indicates that the package is offline; otherwise **FALSE**.

Indicates whether the package is being serviced.

**TRUE** indicates that the package is being serviced; otherwise **FALSE**.

Indicates whether the package may have been tampered with.

**TRUE** indicates that the package has been tampered with; otherwise **FALSE**.

Indicates whether the package is in good condition and may be used.

**TRUE** indicates that the package is in good condition; otherwise **FALSE**.

Provides access to the package that has changed.

The package that has changed.

The package that has changed. A package is changed when it is installed, uninstalled, or updated.

Provides information about the app package that is being uninstalled.

Gets the id for the uninstall operation.

A unique value that an app can use to correlate events that relate to a single deployment operation.

Gets the result of the package uninstall operation.

The result of the package uninstall operation.

Indicates whether the app package is done uninstalling.

**True** indicates that the app package is done uninstalling; **false**, otherwise.

Gets the package that is uninstalling.

The package being uninstalled.

Gets an approximation of the package's uninstall progress.

A value in the range of 0 through 1.0 which represents approximately how far along the package is in the uninstall process.

An enum that indicates if an application has an update, and if the update is required.

This value is returned when an update for the application is available, and the update is not required.

This value is returned when an error is encountered.

This value is returned when no updates are available for the application.

This value is returned when an update for the application is available, and the update is required.

This value is returned when this function is called on a package that does not have an AppInstaller file association.

Describes whether the main app package listed in the .appinstaller file requires updates.

Describes the type of package update that's available.

A PackageUpdateAvailability value that indicates the type of update available.

If there is a problem checking for an update via Package.CheckUpdateAvailabilityAsync, this error can provide details.

The error triggered by checking for the update.

Provides information about the package that is being updated.

Gets the id for the update operation.

A unique value that an app can use to correlate events that relate to a single deployment operation.

Gets the result of the package uninstall operation.

The result of the package uninstall operation.

Indicates whether the app package is done updating.

**True** if the app package is done updating; **false** otherwise.

Gets an approximation of the package's update progress.

A value in the range of 0 through 1.0 which represents approximately how far along the package is in the update process.

Gets the package that is being updated.

The package being updated. This is the original package that was on the machine that is now being updated.

Gets the updated package.

This is the new package that is an update to the old package on the device.

Represents the package version info.

The build version number of the package.

The major version number of the package.

The minor version number of the package.

The revision version number of the package.

Manages a delayed app suspending operation.

Notifies the operating system that the app has saved its data and is ready to be suspended.

Provides data for an app suspending event.

Gets the app suspending operation.

The suspending operation.

Provides info about an app suspending operation.

Gets the time when the delayed app suspending operation continues.

The time.

Requests that the app suspending operation be delayed.

The suspension deferral.

Specifies the type of activation.

The user wants to manage appointments that are provided by the app.

The app was activated as a barcode scanner provider.

The user wants to save a file that the app provides content management for.

The app captures photos or video from an attached camera.

The app was launched from the command line. Introduced in Windows 10, version 1709 (10.0.16299)

Reserved for system use. Introduced in Windows 10, version 1507 (10.0.10240).

Windows Store only. The user wants to handle calls or messages for the phone number of a contact that is provided by the app.

The app was launched from the **My People** UI. Note: introduced in Windows 10, version 1703 (10.0.15063), but not used. Now used starting with Windows 10, version 1709 (10.0.16299).

The user wants to pick contacts.

The app handles AutoPlay.

This app was activated as a result of pairing a device.

This app was launched by another app on a different device by using the DIAL protocol. Introduced in Windows 10, version 1507 (10.0.10240).

An app launched a file whose file type this app is registered to handle.

The user wants to pick files that are provided by the app.

Reserved for system use. Introduced in Windows 10, version 1607 (10.0.14393).

The user wants to save a file and selected the app as the location.

The app was activated because it was launched by the OS due to a game's request for Xbox-specific UI. Introduced in Windows 10, version 1703 (10.0.15063).

The user launched the app or tapped a content tile.

The app was activated as the lock screen. Introduced in Windows 10, version 1507 (10.0.10240).

Windows Store only. The app launches a call from the lock screen. If the user wants to accept the call, the app displays its call UI directly on the lock screen without requiring the user to unlock. A lock-screen call is a special type of launch activation.

Reserved for system use. Introduced in Windows 10, version 1703 (10.0.15063).

Windows Phone only. The app was activated after the completion of a picker.

Windows Phone only. The app was activated after the app was suspended for a file picker operation.

Windows Phone only. The app was activated after the app was suspended for a folder picker operation.

Windows Phone only. The app was activated after the app was suspended for a file save picker operation.

This app was launched by another app to provide a customized printing experience for a 3D printer. Introduced in Windows 10, version 1507 (10.0.10240).

The app handles print tasks.

The app was activated because the user is printing to a printer that has a Print Workflow Application associated with it which has requested user input.

An app launched a URI whose scheme name this app is registered to handle.

The app was launched by another app with the expectation that it will return a result back to the caller. Introduced in Windows 10, version 1507 (10.0.10240).

Windows Store only. The user launched the restricted app.

The user wants to search with the app.

The app is activated as a target for share operations.

The app was activated because the app is specified to launch at system startup or user log-in. Introduced in Windows 10, version 1703 (10.0.15063).

The app was activated when a user tapped on the body of a toast notification or performed an action inside a toast notification. Introduced in Windows 10, version 1507 (10.0.10240).

The app was launched to handle the user interface for account management. In circumstances where the system would have shown the default system user interface, it instead has invoked your app with the UserDataAccountProvider contract. The activation payload contains information about the type of operation being requested and all the information necessary to replicate the system-provided user interface. This activation kind is limited to 1st party apps.

The app was activated as the result of a voice command.

Windows Phone only. The app was activated to perform a Wallet operation.

The app was activated by a web account provider. Introduced in Windows 10, version 1507 (10.0.10240).

Windows Phone only. The app was activated after the app was suspended for a web authentication broker operation.

Specifies the execution state of the app.

The app was closed by the user.

The app is not running.

The app is running.

The app is suspended.

The app was terminated after being suspended.

Provides data when an app is activated to add an appointment to the user’s calendar.

Gets the appointment that is provided to the app when the user tries to add it.

The appointment that is added.

Gets the activation type.

The ActivationKind.AppointmentsProvider enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to remove an appointment from the user’s calendar.

Gets the activation type.

The ActivationKind.AppointmentsProvider enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the appointment that is provided to the app when the user tries to remove it.

The appointment that is removed.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to replace an appointment in the user’s calendar.

Gets the activation type.

The ActivationKind.AppointmentsProvider enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the appointment that is provided to the app when the user tries to replace it.

The appointment that is replaced.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to show the details of an appointment.

Gets the start date of the appointment instance for which the app should display details.

The start date of the appointment instance for which the app should display details.

Gets the activation type.

The ActivationKind.AppointmentsProvider enumeration value.

Gets the local identifier of the appointment for which the app should display details.

The local identifier of the appointment for which the app should display details.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the roaming identifier of the appointment for which the app should display details.

The roaming identifier of the appointment for which the app should display details.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to show a specified time frame on the user’s calendar.

Gets the duration of the time frame to be shown.

The duration of the time frame.

Gets the activation type.

The ActivationKind.AppointmentsProvider enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the starting date and time of the time frame to be shown.

The starting date and time of the time frame.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Makes all data available from the IBackgroundTask.Run method available to your event handler when your app is activated by a background trigger.

Get the data that was available to the IBackgroundTask.Run method that resulted in your app being activated.

The IBackgroundTaskInstance that activated your app.

Specifies the event arguments for activating the barcode scanner preview.

Gets a connection ID used to match the service connection.

A connection ID.

Gets the activation type.

Activation kind.

Gets the execution state of the app before it was activated.

The previous state.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user for the barcode scanner preview.

The user.

Provides information about the activated event that fires when the user saves or opens a file that needs updates from the app.

Gets the letterbox UI of the file picker that is displayed when a file needs updates from the app.

The letterbox UI of the file picker that is displayed when a file needs updates from the app.

Gets the activation type.

The ActivationKind.CachedFileUpdater enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information, such as the command-line arguments, when an app is activated from the command line.

Gets the type of activation that launched the app.

The activation kind.

Gets info about the activation of the app such as what arguments were provided and the current directory path.

The activation info.

Gets the execution state of the app before it was activated.

The execution state before the app was activated.

Gets info about the transition from the splash screen to the activated app.

The splash screen transition info.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides info about the activation of the app such as what arguments were provided and the current directory path.

Gets the command-line arguments passed to the app when it was activated.

The command line arguments.

Gets the directory path from which the app was activated from the command line.

The current directory path.

Sets the exit code for the app that was launched from the command line.

The code the app returned when it exits.

Gets a deferral object for this operation.

A **Deferral** object that your code uses to signal when it has finished processing the activation.

Provides data when an app is activated because it uses the Contact Panel.

Gets the selected contact from the Contact Panel.

The selected contact.

Gets the contact panel.

The contact panel.

Gets the activation type.

The ActivationKind.Contact enumeration value.

Gets the execution state of the app before it was activated.

A ApplicationExecutionState -typed value.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user the app was activated for.

The user the app was activated for.

Provides information for a device that invokes AutoPlay.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the device identifier for the device that invoked AutoPlay.

The device identifier for the device that invoked AutoPlay.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action associated with the activated device.

The action associated with the activated device.

Gets the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Provides information when an app is activated as a result of a device pairing.

Gets the DeviceInformation object for the device object that is being paired.

The information of the device object.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user the app was activated for.

The user the app was activated for.

Provides data when an app is activated from another app by using the DIAL protocol.

Gets the name of the app that invoked the dial receiver app.

The name of the app that invoked the dial receiver app.

Gets the arguments passed by the calling app.

The arguments passed by the calling app.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the activation type.

The ActivationKind.DialReceiver enumeration value.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the unique tile identifier for the calling app.

The unique tile identifier for the calling app.

Gets the user the app was activated for.

The user the app was activated for.

Gets the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Provides data when an app is activated because it is the app associated with a file.

The package family name of the app that launched your app.

The caller's package family name.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the files for which the app was activated.

The StorageFile objects representing the files being passed to the app.

Gets the activation type.

One of the enumeration values.

Gets the neighboring files of the files for which the app was activated.

The StorageFile objects that represent the neighboring files of the files being passed to the app.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action associated with the activated file.

The action.

Provides the object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Provides information about an activated event that fires when the user tries to pick files or folders that are provided by the app.

The package family name of the app that launched your app.

The caller's package family name.

Gets the letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

The letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

Gets the activation type.

The ActivationKind.FileOpenPicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a file open picker operation.

FileOpenPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets a set of values populated by the app before a FileOpenPicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FileOpenPicker operation that deactivates the app.

Gets the list of files selected by the user during the file open picker operation.

The list of files selected by the user during the file open picker operation.

Gets the activation type.

The ActivationKind.ContinueFileOpenPicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires when the user saves a file through the file picker and selects the app as the location.

The package family name of the app that launched this app.

The caller's package family name.

Gets the ID of the enterprise that owns the file.

The ID of the enterprise to owns the file.

Gets the letterbox UI of the file picker that is displayed when the user saves a file and selects the app as the save location.

The letterbox UI of the file picker that is displayed when the user saves a file and uses the app as the location.

Gets the activation type.

The ActivationKind.FileSavePicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a file save picker operation.

FileSavePickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets a set of values populated by the app before a FileSavePicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FileSavePicker operation that deactivates the app.

Gets the file selected by the user during the file save picker operation.

The file selected by the user during the file save picker operation.

Gets the activation type.

The ActivationKind.ContinueFileSavePicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a folder picker operation.

FolderPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets a set of values populated by the app before a FolderPicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FolderPicker operation that deactivates the app.

Gets the folder selected by the user during the folder picker operation.

The folder selected by the user during the folder picker operation.

Gets the activation type.

The ActivationKind.ContinueFolderPicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides common properties for all activation types.

Gets the reason that this app is being activated.

One of the enumeration values.

Gets the execution state of the app before this activation.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Provides information about the user that the app was activated for.

Gets the user that the app was activated for.

The user that the app was activated for. This property returns the logged-in user on platforms that only support single-user sessions. For platforms that support multiple users in a session (such as Xbox) this property returns the logged-in user that the app was activated for.

Provides data when an app is activated to show its current view.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Provides data when an app is activated.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to add an appointment to the user’s calendar.

Gets the appointment that is provided to the app when the user tries to add it.

The appointment that is added.

Provides data when an app is activated to remove an appointment from the user’s calendar.

Gets the appointment that is provided to the app when the user tries to remove it.

The appointment that is removed.

Provides data when an app is activated to replace an appointment in the user’s calendar.

Gets the appointment that is provided to the app when the user tries to replace it.

The appointment that is replaced.

Provides data when an app is activated to show the details of an appointment.

Gets the start date of the appointment instance for which the app should display details.

The start date of the appointment instance for which the app should display details.

Ges the local identifier of the appointment for which the app should display details.

The local identifier of the appointment for which the app should display details.

Gets the roaming identifier of the appointment for which the app should display details.

The roaming identifier of the appointment for which the app should display details.

Provides data when an app is activated to show a specified time frame on the user’s calendar.

Gets the duration of the time frame to be shown.

The duration of the time frame.

Gets the starting date and time of the time frame to be shown.

The starting date and time of the time frame.

Makes all data available from the IBackgroundTask.Run method available to your event handler when your app is activated by a background trigger.

Get the data that was available to the IBackgroundTask.Run method that resulted in your app being activated.

The data that was available to the IBackgroundTask.Run method.

Describes event arguments used in activating the barcode scanner preview.

Gets a connection ID used to match the service connection.

A connection ID.

Provides information about the activated event that fires when the user saves a file that requires content management from the app.

The letterbox UI of the file picker that is displayed when a file requires content management from the app.

The letterbox UI of the file picker that is displayed when a file requires content management from the app.

Defines the interface for providing info, such as the command-line arguments, when an app is activated from the command line.

Provides info about the activation of the app such as what arguments were provided and the current directory path.

The activation info.

Provides data when an app is activated by the contact panel.

Gets the contact.

The contact.

Gets the contact panel.

The contact panel.

Provides data when an app is activated after an operation that suspends the app.

Gets a set of values populated by the app before an operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before an operation that deactivates the app.

Provides information for a device that invokes AutoPlay.

Gets the device identifier for the device that invoked AutoPlay.

The device identifier for the device that invoked AutoPlay.

Gets the action associated with the activated device.

The action associated with the activated device.

Provides information when an app is activated as a result of a device pairing.

Gets the DeviceInformation object for the device object that is being paired.

The information of the device object.

Provides data when an app is activated from another app by using the DIAL protocol.

Gets the name of the app that invoked the dial receiver app.

The name of the app that invoked the dial receiver app.

Provides data when an app is activated because it is the program associated with a file.

Gets the files for which the app was activated.

The files.

Gets the action associated with the activated file.

The action.

Provides data when an app is activated because it is the program associated with a file.

The package family name of the app that launched this app.

The caller's package family name.

Provides data when an app is activated because it is the program associated with the neighboring files.

Gets the neighboring files of the files for which the app was activated.

The StorageFile objects that represent the neighboring files of the files being passed to the app.

Provides information about the activated event that fires when the user tries to pick files or folders that are provided by the app.

The letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

The letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

Provides information about the activated event that fires when the user tries to pick files or folders that are provided by the app.

The package family name of the app that launched your app.

The caller's package family name.

Provides information about an activated event that fires after the app was suspended for a file open picker operation.

IFileOpenPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the list of files selected by the user during the file open picker operation.

The list of files selected by the user during the file open picker operation.

Provides information about the activated event that fires when the user saves a file through the file picker and selects the app as the location.

The letterbox UI of the file picker that is displayed when the user saves a file and selects the app as the save location.

The letterbox UI of the file picker that is displayed when the user saves a file and selects the app as the location.

Provides information about the activated event that fires when the user saves a file through the file picker and selects the app as the location.

The package family name of the app that launched your app.

The caller's package family name.

Gets the ID of the enterprise that owns the file.

The ID of the enterprise that owns the file.

Provides information about an activated event that fires after the app was suspended for a file save picker operation.

IFileSavePickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the file selected by the user during the file save picker operation.

The file selected by the user during the file save picker operation.

Provides information about an activated event that fires after the app was suspended for a folder picker operation.

IFolderPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the folder selected by the user during the folder picker operation.

The folder selected by the user during the folder picker operation.

Provides event information when an app is launched.

Gets the arguments that are passed to the app during its launch activation.

The list of arguments.

Gets the ID of the tile that was invoked to launch the app.

The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the SecondaryTile.TileId value, assigned to the secondary tile when it was created, is returned.

Provides additional information about the tile that launched your app.

Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property.

Information about the tile that launched the app.

Provides information about an event that occurs when the app is activated as the lock screen.

Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data.

An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data.

Provides data for the Activated event when it occurs after a picker returns.

Gets an identifier indicating the type of picker operation that was performed prior to the activation.

An identifier indicating the type of picker operation that was performed prior to the activation.

Provides event information about whether an app is in pre-launch state.

Gets an indication about whether a pre-launch has been activated.

Indicates whether a pre-launch has been activated. **TRUE** indicates activated; otherwise, **FALSE**.

Provides data when an app is activated because it is the program associated with a protocol.

Gets the Uniform Resource Identifier (URI) for which the app was activated.

The Uniform Resource Identifier (URI).

Provides data and the package family name of the app that activated the current app.

Gets the package family name of the application that activated the current application.

The package family name of the application that activated the current application.

Data received from the application that activated the current application.

User-defined data.

Describes the activation arguments when an app is launched via LaunchUriForResultsAsync.

Gets the **ProtocolForResultsOperation** that you can then use to signal that your app is ready to return to the app that launched it for results.

The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its ProtocolForResultsOperation.ReportCompleted method.

Provides event information when a restricted app is launched.

Gets information about a shared context for the restricted launch.

The object that provides shared context information.

Provides information about the activated event that fires when an app is used to search.

The Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

The Internet Engineering Task Force (IETF) BCP 47 standard language tag.

The text that the user wants the app to search for. The user entered this text into the search box of the search pane.

The text to find.

Provides information about the activated event that fires when an app is used to query text.

Gets a SearchPaneQueryLinguisticDetails object that provides info about query text that the user enters through an Input Method Editor (IME).

The object that provides info about query text.

Provides information for an application that is a target for share operations.

Contains information about data included in a share operation.

An object that includes the data included in a send operation.

Provides information when an app is activated at device startup or user login.

Gets the unique ID of the startup task

Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

Gets the arguments that the app can retrieve after it is activated through an interactive toast notification.

The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value:

Gets a set of values that you can use to obtain the user input from an interactive toast notification.

A set of values that you can use to obtain the user input from an interactive toast notification.

Provides data when an app is activated to manage user accounts.

Gets the user account management operation.

The user account management operation.

Provides the object that allows you to set the view for the application.

Provides the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Represents the activated event object that contains the event info when the app is launched through a voice command.

Gets the SpeechRecognitionResult object representing the voice command that activated the app.

The SpeechRecognitionResult object representing the voice commands that activated the app.

Contains methods for providing information to an app activated as a result of a web account provider operation.

Gets the web account provider operation.

The web account provider operation.

Provides information to an app that was launched after being suspended for a web authentication broker operation.

Gets the WebAuthenticationResult object returned from the web authentication broker operation.

The result of the web authentication broker operation.

Provides event information when an app is launched.

Gets the arguments that are passed to the app during its launch activation.

The list of arguments. This value can be used to control the behavior of the app when it is launched through a secondary tile or through a toast.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the reason that this app is being activated.

One of the enumeration values.

Indicates whether the app was pre-launched.

Indicates whether the app was pre-launched. **TRUE** indicates it was; otherwise, **FALSE**.

Gets the execution state of the app before this activation.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property.

Information about the tile that launched the app.

Gets the ID of the tile that was invoked to launch the app.

The ID of the tile that launched the app. If the app's main tile was used, this value is "App". If a secondary tile is used, the SecondaryTile.TileId value, assigned to the secondary tile when it was created, is returned.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the view switcher object that allows you to set the view for the application.

The view switcher

Provides information about an event that occurs when the app is activated as the lock screen.

Gets an object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data.

An object that allows an app that is activated as the lock screen to get the same data that the default lock screen can access, and to register for updates to that data.

Gets the reason for the activation of the app for this event.

The reason for the activation of the app for this event. For the event that occurs when an app is activated as the lock screen, this value is **ActivationKind.LockScreen**.

Gets the execution state of the app before the app was activated as the lock screen.

The execution state of the app before the app was activated as the lock screen.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object that provides information about the transition from the splash screen to the activated app.

Gets the user the app was activated for.

The user the app was activated for.

Provides data when an app is activated as part of a lock screen component.

Gets the activation type.

The activation type.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Provides data for the Activated event when it occurs after a picker returns.

Gets the reason that this app is being activated.

The reason that this app is being activated.

Gets an identifier indicating the picker operation that was performed prior to the activation.

An application-defined identifier indicating the picker operation that was performed prior to the activation.

Gets the execution state of the app before this activation.

The execution state of the app before this activation.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Provides data when an app is activated because it is the app associated with a URI scheme name.

Gets the package family name of the application that activated the current application.

The package family name of the application that activated the current application.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Data received from the application that activated the current application.

User-defined data. May be **null**.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the Uniform Resource Identifier (URI) for which the app was activated.

The Uniform Resource Identifier (URI).

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Received by an application when it is launched by another application with the expectation that it will return results back to the caller.

Gets the package family name of the application that activated the current application.

The package family name of the application that activated the current application.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Data received from the application that activated the current application.

User-defined data. May be **null**.

Gets the activation type.

A enumeration value.

Gets the execution state of the app before it was activated.

An ApplicationExecutionState enumeration value.

Gets the **ProtocolForResultsOperation** that you use to signal that your app is ready to return to the app that launched it for results.

The **ProtocolForResultsOperation** object that you can use to signal that your app is ready to return by calling its ProtocolForResultsOperation.ReportCompleted method.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the Uniform Resource Identifier (URI) used to activate the app.

The Uniform Resource Identifier (URI).

Gets the user the app was activated for.

The user the app was activated for.

Gets the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Provides event information when a restricted app is launched.

Gets the activation type.

The ActivationKind.RestrictedLaunch enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets information about a shared context for the restricted launch.

The object that provides shared context information.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about the activated event that fires when the user searches the app from the Search charm and the app isn't the main app on screen.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the activation type.

The ActivationKind.Search enumeration value.

Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

The Internet Engineering Task Force (IETF) BCP 47 standard language tag.

Gets a SearchPaneQueryLinguisticDetails object that provides info about query text that the user enters through an Input Method Editor (IME).

The object that provides info about query text.

Gets the execution state of the app before it was activated.

One of the ApplicationExecutionState enumeration values.

Gets the text that the user wants the app to search for. The user entered this text into the search box of the search pane.

The text to search for.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the view switcher object that allows you to set the view for the application.

Use the ActivationViewSwitcher to show or switch the view in response to the activation. The value will be **null** in hosted scenarios such as Share and File Picker activations.

Provides information for an application that is a target for share operations.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets information about data included in a share operation.

An object that includes the data included in a send operation.

Gets the splash screen object which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides a dismissal event and image location information for the app's splash screen.

The coordinates of the app's splash screen image relative to the window.

The coordinates of the splash screen image relative to the window and scaled for the dots per inch (dpi) of the device.

Fires when the app's splash screen is dismissed.

Provides information when an app is activated at device startup or user login.

Gets the reason that this app is being activated.

The expected value is **ActivationKind.StartupTask**.

Gets the execution state of the app before it was activated.

The execution state before the app was activated.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the unique identifier for your task.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about the tile that launched your app.

Gets the notifications that have been shown on the tile that activated your app from most recent to oldest. The first notification represents what was on the tile when the user clicked it. If the tile was blank, the list is empty.

The tile notifications that have been shown from most recent to oldest.

Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

Gets the arguments that the app can retrieve after it is activated through an interactive toast notification.

The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value:

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the reason for the activation of the app for this event.

The reason for the activation of the app for this event. For the event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification, this value is **ActivationKind.ToastNotification**.

Gets the execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

The execution state of the app before the app was activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object that provides information about the transition from the splash screen to the activated app.

Gets the user the app was activated for.

The user the app was activated for.

Gets a set of values that you can use to obtain the user input from an interactive toast notification.

A set of values that you can use to obtain the user input from an interactive toast notification.

Provides data when an app is activated to manage user accounts.

Gets the activation type.

The activation type.

Gets the user account management operation.

The user account management operation.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Contains info for the app's activated event when the app is launched through a voice command.

Gets the activation type.

The ActivationKind.VoiceCommand enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the SpeechRecognitionResult object representing the voice command that activated the app.

The SpeechRecognitionResult object representing the voice commands that activated the app.

Gets info about the transition from the splash screen to the activated app.

The splash screen transition info.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information to an app activated as a result of a web account provider operation.

Gets the kind of web account provider activation.

The kind of web account provider activation.

Gets the web account provider operation.

Gets the web account provider operation.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object which provides information about the transition from the splash screen to the activated app.

The splash screen object which provides information about the transition from the splash screen to the activated app.

Gets the user the app was activated for.

The user the app was activated for.

Provides information to an app that was launched after being suspended for a web authentication broker operation.

Gets a set of values populated by the app before a web authentication broker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a web authentication broker operation that deactivates the app.

Gets the activation type.

The ActivationKind.WebAuthenticationBrokerContinuation enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the WebAuthenticationResult object returned from the web authentication broker operation.

The result of the web authentication broker operation.

Provides information about an application extension.

Provides information such as the app extension's name, logo, package information, and app identifier, that the host app may choose to show to the user.

The application information.

Provides the description of this app extension.

Description of the extension.

Provides the display name of this extension.

The display name.

The extension's instance identifier.

Instance identifier.

Gets the package information for the app extension.

The package information which includes the package description, logo, display name, and so on.

Used by the extension to specify any extra information that the hosting app can query.

A collection of key-value pairs.

Gets the readable subfolder in the extension's isolated storage.

The public sub-folder.

Provides information about available extensions within an extension group.

Event that is fired when an extension package is installed.

Event that is fired when an extension package in the catalog removed, updated, or installed.

Event that is fired when an extension package is being uninstalled.

Event that is fired when an extension package in the catalog is updated.

Event that is fired when an extension package is being updated.

Provides the list of extensions in the catalog.

The list of extensions in the catalog. Note that this method returns a list of AppExtensions, not Packages. You can get the **Package** for each **AppExtension** with AppExtension.Package.

Opens a catalog of extensions.

The extension namespace name. A catalog containing the extensions declared with the specified extension namespace name.

Attempts to remove the specified extension package from the machine.

The name of the package to remove, which you can get from AppExtension.Package.Id.FullName. Returns **true** if the request to the user to remove the package was made; otherwise, **false**.

Provides information for the AppExtensionCatalog.PackageInstalled event.

Gets the name of the extension package that was installed.

The name of the extension.

Provides a list of extensions in the extension package that was just installed.

The list of extensions within the extension package.

Gets the package containing the extension that was installed.

The extension package that was installed.

Provides information for the AppExtensionCatalog.PackageStatusChanged event.

Gets the name of the app extension that has been updated or uninstalled.

The name of the app extension.

Gets the package containing the extension that is being updated or uninstalled.

The extension package that changed.

Provides information for the AppExtensionCatalog.PackageUninstalling event.

Gets the name of the app extension that is uninstalling.

The name of the app extension.

Gets the app extension package that is uninstalilng.

The app extension package that was uninstalled.

Provides information for the AppExtensionCatalog.PackageUpdated event.

Gets the name of the app extension that was updated.

The name of the updated app extension.

Provides a list of extensions that are in the extension package that was updated

A list of extensions within the updated extension package.

Provides the package containing the extension that was updated.

The updated app extension package.

Provides information for the AppExtensionCatalog.PackageUpdating event.

Gets the name of the app extension that is being updated.

The name of the app extension.

Provides the package containing the extension that is updating.

The updated app extension package.

Represents an appointment in a calendar. This class is used when an app is activated using the **AppointmentsProvider** value for ActivationKind, as a value for AppointmentInformation properties.

Initializes a new instance of the Appointment class.

Gets or sets a Boolean value that indicates whether the appointment will last all day. The default is **FALSE** for won't last all day.

A Boolean value that indicates whether the appointment will last all day. **TRUE** indicates that the appointment will last all day; otherwise **FALSE**.

Gets or sets a value that indicates whether the appointment will allow users to propose a new time.

A Boolean value that indicates whether the appointment will allow users to propose a new time. **TRUE** indicates that the appointment does allow new time proposal; otherwise **FALSE**.

Gets or sets a AppointmentBusyStatus -typed value that indicates the busy status for a participant of an appointment.

A AppointmentBusyStatus -typed value that indicates the busy status for a participant of an appointment.

Gets the unique identifier for the calendar associated with the appointment.

The unique identifier for the calendar associated with the appointment.

Gets the current change number of the local version of the Appointment.

The current change number of the local version of the Appointment.

Gets or sets a string value. The string contains extended details that describe the appointment. Details is of type String and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string.

The extended details that describe the appointment.

Gets or sets the type of appointment details, plain text or HTML.

The type of appointment details.

Gets or sets a time span that represents the time duration of the appointment. Duration is of type TimeSpan and must be non-negative.

A time span that represents the duration of the appointment. The duration can't be a negative value.

Gets a value that indicates whether the appointment has invitees.

A value that indicates whether the appointment has invitees.

Gets the list of participants for the appointment. Invitees is of type IVector(AppointmentInvitee). If an organizer is set and invitee length is greater than 0, a call to an AppointmentManager API fails with **E_INVALIDARG**. The number of invitees is unlimited.

The list of participants for the appointment.

Gets or sets a value that indicates whether the appointment has been cancelled.

A Boolean value that indicates whether the appointment has been cancelled. **TRUE** indicates that the appointment has been cancelled; otherwise **FALSE**.

Gets or sets a value that indicates whether the appointment was organized by the current user.

A Boolean value that indicates whether the appointment was organized by the current user **TRUE** indicates that the appointment was organized by the user; otherwise **FALSE**.

Gets or sets a value that indicates whether a response to the appointment invitation is requested.

A Boolean value that indicates whether a response is requested. **TRUE** indicates that a response is requested; otherwise **FALSE**.

Gets a string that uniquely identifies the appointment on the local device.

A string that uniquely identifies the appointment on the local device.

Gets or sets a string that communicates the physical location of the appointment. Location is of type String and a maximum of 32,768 characters in length.

The location of the appointment.

Gets or sets a string value that is a URL used to join the online meeting for the appointment.

A string value that is a URL used to join the online meeting for the appointment.

Gets or sets the organizer of the appointment. Organizer is of type AppointmentOrganizer. If an organizer is set and invitee length is greater than 0, a call to an AppointmentManager API fails with **E_INVALIDARG**. The number of invitees is unlimited.

A AppointmentOrganizer object that indicates the organizer of the appointment.

Gets the original starting time for a recurring appointment.

The original starting time for a recurring appointment..

Gets or sets the object that describes when and how often the appointment occurs. Recurrence is of type AppointmentRecurrence.

A AppointmentRecurrence object that describes when and how often the appointment occurs.

Gets or sets a time span value. The value declares the amount of time to subtract from the StartTime, and that time used as the issue time for a reminder for an appointment. A **null** value indicates that the appointment will not issue a reminder. Reminder is of type IReference(TimeSpan).

A time span value, or **null** to issue no reminder.

Gets or sets the current change number of the server version of the Appointment.

The current change number of the server version of the Appointment.

Gets or sets the date and time that the user responded to the appointment request.

The date and time that the user responded to the appointment request.

Gets or sets a string that uniquely identifies an appointment across devices.

A string that uniquely identifies an appointment across devices.

Gets or sets a AppointmentSensitivity -typed value that indicates the sensitivity of the appointment.

A AppointmentSensitivity -typed value that indicates the sensitivity of the appointment.

Gets or sets the starting time for the appointment. StartTime is of type DateTime.

The date and time to use as the starting time for the appointment.

Gets or sets a string that communicates the subject of the appointment. Subject is of type String and a maximum of 255 characters in length.

The subject of the appointment.

Gets the Uniform Resource Identifier (Uri ) for the appointment. Allows the Calendar app to perform an association launch to go back to the source app or other URI that represents this appointment.

The URI for the appointment.

Gets or sets the user's response to the appointment request.

The user's response to the appointment request.

Specifies the busy status for a participant of an appointment.

The participant is busy and so can't attend the appointment.

The participant is free and so can attend the appointment.

The participant is out of office.

The participant might be able to attend the appointment.

The participant is working elsewhere.

Represents a calendar with appointments.

Gets or sets a Boolean value that indicates if the calendar supports cancelling meetings.

Boolean value that indicates if the calendar supports cancelling meetings.

Gets or sets a Boolean value that indicates if the calendar supports creating or updating appointments.

Boolean value that indicates if the calendar supports creating or updating appointments.

Gets or sets a Boolean value that indicates if the calendar supports forwarding meetings.

Boolean value that indicates if the calendar supports forwarding meetings.

Gets or sets a Boolean value that indicates if the calendar supports notifying attendees.

Boolean value that indicates if the calendar supports notifying attendees.

Gets or sets a Boolean value that indicates if the calendar supports proposing new meeting times.

Boolean value that indicates if the calendar supports proposing new meeting times.

Gets or sets a Boolean value that indicates if the calendar supports updating meeting responses.

Boolean value that indicates if the calendar supports updating meeting responses.

Gets the color that the built-in calendar app uses for appointments associated with the calendar.

An unsigned integer representing the color that the built-in calendar app uses for appointments associated with the calendar.

Gets a string representing the display name for the AppointmentCalendar.

A string representing the display name for the AppointmentCalendar.

Gets whether the AppointmentCalendar is hidden in the device's built-in calendar UI.

A boolean value indicating whether the AppointmentCalendar is hidden in the device's built-in calendar UI.

Gets a string that uniquely identifies the appointment calendar on the local device.

A string that uniquely identifies the appointment calendar on the local device.

Gets or sets a Boolean value that indicates if invitees must be sent notifications.

A Boolean value that indicates if invitees must be sent notifications.

Gets or sets a boolean value indicating whether other apps on the device have read access to the appointment calendar.

A boolean value indicating whether other apps on the device have read access to the appointment calendar.

Gets or sets a boolean value indicating whether other apps on the device have write access to the appointment calendar.

A boolean value indicating whether other apps on the device have write access to the appointment calendar.

Gets the remote ID for the AppointmentCalendar.

The remote ID for the AppointmentCalendar.

Gets a string that describes the provider for the appointment calendar.

A string that describes the provider for the appointment calendar.

Gets or sets how the summary card for the calendar's appointments are displayed.

An AppointmentSummaryCardView value indicating how the summary card for the calendar's appointments are displayed.

Gets the AppointmentCalendarSyncManager which can be used to sync with the remote server.

The AppointmentCalendarSyncManager which can be used to sync with the remote server.

Get the identifier of the user account data for the AppointmentCalendar.

The identifier of the user account data for the AppointmentCalendar.

Asynchronously deletes the appointment with the specified ID.

The LocalId of the appointment to be deleted. An asynchronous action.

Asynchronously deletes the appointment instance with the specified start time of a master appointment with the specified ID.

The LocalId of the master appointment associated with the appointment instance to be deleted. The start time of the appointment instance to be deleted. This must be the original start date of the instance. An asynchronous action.

Asynchronously deletes the appointment calendar.

An asynchrounous action.

Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria.

The LocalId of the master appointment for which appointment instances are retrieved. The start time of the time window for which appointment instances are retrieved. The length of the time window for which appointment instances are retrieved. An asynchronous operation that returns IVectorView on successful completion.

Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria.

The LocalId of the master appointment for which appointment instances are retrieved. The start time of the time window for which appointment instances are retrieved. The length of the time window for which appointment instances are retrieved. A FindAppointmentsOptions object that is used to specify more options for this operation. An asynchronous operation that returns IVectorView on successful completion.

Asynchronously retrieves a list of appointments belonging to the current AppointmentCalendar that meet the specified criteria.

The start time of the time window for which appointments are retrieved. The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the *rangeStart* value, the returned list will be empty. An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Asynchronously retrieves a list of appointments belonging to the current AppointmentCalendar that meet the specified criteria.

The start time of the time window for which appointments are retrieved. The length of the time window for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the *rangeStart* value, the returned list will be empty. A FindAppointmentsOptions object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Asynchronously retrieves a list of appointment instances that are exceptions from the specified master appointment.

The LocalId of the master appointment for which exceptional appointment instances are retrieved. An asynchronous operation that returns IVectorView on successful completion.

Asynchronously retrieves a list of appointments that meet the specified criteria.

An asynchronous operation that returns IVectorView on successful completion.

Asynchronously retrieves a list of appointments that meet the specified criteria.

A FindAppointmentsOptions object that is used to specify more options for this operation. An asynchronous operation that returns IVectorView on successful completion.

Asynchronously retrieves the Appointment with the specified ID.

The LocalId of the appointment to be retrieved. An asynchronous operation that returns Appointment on successful completion.

Asynchronously retrieves the appointment instance of the specified master appointment that has the specified start time.

The ID of the master appointment to which the retrieved appointment instance belongs. The start time of the appointment instance to be retrieved. An asynchronous operation that returns Appointment on successful completion.

Registers the AppointmentCalendar as a sync provider.

An asynchronous action.

Asynchronously saves the provided appointment to the calendar.

The appointment to be saved. An asynchronous action.

Asynchronously saves changes to the appointment calendar.

An asynchronous action.

Asynchronously attempts to cancel a meeting.

The meeting to cancel. The subject for the cancellation notification. The body of the cancellation notification. A Boolean value indicating if invitees should be notified. A Boolean value indicating if the operation was successful.

Asynchronously attempts to create or update a meeting.

The meeting to create or update. A Boolean value indicating if invitees should be notified. A Boolean value indicating if the operation was successful.

Asynchronously attempts to forward a meeting.

The meeting to forward. A list of new invitees to receive the forwarded meeting. The subject of the meeting invitation. A new meeting header that includes the new invitees. The body of the forwarded meeting invitation. A Boolean value indicating if the operation was successful.

Asynchronously attempts to propose a new meeting time.

The meeting to update. The proposed new start time. A new duration for the meeting. The subject of the meeting invitation. The body of the meeting invitation. A Boolean value indicating if the operation was successful.

Asynchronously attempts to update the response to a meeting invitation.

The meeting to update. The response to the meeting invitation, such as accept, tentative or decline. The subject of the response. The body of the response. A Boolean value indicating whether or not to send the response to the meeting organizer. A Boolean value indicating if the operation was successful.

Specifies the level of read access provided to an app calendar.

Other apps on the device can read all properties of appointments in the calendar.

Other apps on the device can read the Subject, StartTime, Duration, AllDay, LocalId properties of appointments in the calendar and the LocalId property of the calendar

Other apps on the device cannot read any properties of appointments in the calendar.

Only the operating system can read data from the app calendar.

Specifies the level of write access provided to an app calendar.

Other apps on the device can perform any write-level actions that use a DataProviderConnection.

Only the app that created the calendar can write to it.

The operating system can write to the calendar.

Provides access to sync functionality for an AppointmentCalendar object.

Gets or sets the last date and time that a sync with the AppointmentCalendar server was attempted.

The last date and time that a sync with the AppointmentCalendar server was attempted.

Gets or sets the last date and time that a sync with the AppointmentCalendar server was successful.

The last date and time that a sync with the AppointmentCalendar server was successful.

Gets or sets the current status of the AppointmentCalendarSyncManager.

The current status of the AppointmentCalendarSyncManager.

Occurs when the status of an AppointmentCalendar sync operation changes.

Initiates a sync operation on the AppointmentCalendar.

A Boolean value indicating if the sync was successfully initiated.

Specifies the current sync status of an AppointmentCalendar.

An authentication error occurred when trying to connect to the server.

There is no sync operation currently occurring.

The account must be manually removed.

A policy error occurred.

A sync operation is in progress.

An unknown error occurred.

The local machine and server are up to date.

Represents a conflict between appointments.

Gets the date of the appointment conflict.

The date of the appointment conflict.

Gets a value indicating the type of appointment conflict.

A value indicating the type of appointment conflict.

Specifies the way in which an appointment conflicts with another appointment.

The appointment is adjacent to another appointment.

There is no appointment conflict.

The appointment overlaps another appointment.

Specifies the days of the week on which an appointment occurs.

The appointment occurs on Friday.

The appointment occurs on Monday.

The appointment doesn't occur on any days of the week.

The appointment occurs on Saturday.

The appointment occurs on Sunday.

The appointment occurs on Thursday.

The appointment occurs on Tuesday.

The appointment occurs on Wednesday.

Defines the type of content in appointment details.

Content is in HTML markup.

Content is in plain text.

Represents an appointment instance that is an exception from the master appointment.

Gets the appointment that is an exception from the master appointment.

The appointment that is an exception from the master appointment.

Gets a list of the names of the appointment properties for which an exception was found.

A list of the names of the appointment properties for which an exception was found.

Gets a value indicating whether the exception is that the appointment instance has been deleted.

A value indicating whether the exception is that the appointment instance has been deleted.

Represents a participant of an appointment in a calendar.

Initializes a new instance of the AppointmentInvitee class.

Gets or sets a string that communicates the address of a participant of an appointment. The address is inherited from IAppointmentParticipant and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type String and between 1 and 321 characters in length (non-empty).

The address of a participant of an appointment.

Gets or sets a string that communicates the display name of a participant of an appointment. The display name is inherited from IAppointmentParticipant, of type String, and a maximum of 256 characters in length.

The display name of a participant of an appointment.

Gets or sets a AppointmentParticipantResponse -typed value that indicates the response from a participant concerning an appointment invitation.

A AppointmentParticipantResponse -typed value that indicates the response from a participant concerning an appointment invitation.

Gets or sets a AppointmentParticipantRole -typed value that indicates the role of a participant concerning an appointment invitation.

A AppointmentParticipantRole -typed value that indicates the role of a participant concerning an appointment invitation.

Provides API to interact with the user’s Appointments provider app (for example, the Calendar app). Call static methods to display provider-specific UI so that the user can perform tasks.

Gets the AppointmentManagerForUser object for the specified user.

The user account to use to get the AppointmentManagerForUser object. Returns the appointment manager for the account specified by the *user* parameter.

Requests the AppointmentStore object associated with the calling application.

An AppointmentStoreAccessType value indicating the level of access the returned appointment store will have. An asynchronous operation that returns an AppointmentStore upon successful completion.

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

The object representing the information for the appointment to add. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

The object representing the information for the appointment to add. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Add Appointment UI. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. A DateTime object with the start time of the appointment instance to be displayed. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment.

The appointment to be added. An asynchronous operation that returns a string containing an appointment ID upon successful completion.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Remove Appointment UI. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Remove Appointment UI. The start date and time of the appointment instance to remove. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Replace Appointment UI. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Replace Appointment UI. The start date and time of the appointment instance to replace. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar.

A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. A timespan that hints to the Appointments provider app how long the time frame shown should be. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Represents an appointment manager for a specific user.

Gets the User represented by this appointment manager.

The User represented by this appointment manager.

Retrieves an AppointmentStore object that enables searching or retrieving appointments on the device.

Specifies the type of read/write access requested. An asynchronous operation that returns an AppointmentStore object upon successful completion.

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

The object representing the information for the appointment to add. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

The object representing the information for the appointment to add. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Add Appointment UI. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. A DateTime object with the start time of the appointment instance to be displayed. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment.

The new appointment to be added. An asynchronous operation that returns a string containing an appointment ID upon successful completion.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Remove Appointment UI. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Remove Appointment UI. The start date and time of the appointment instance to remove. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Replace Appointment UI. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call. The object representing the information for the appointment to replace the current appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Replace Appointment UI. The start date and time of the appointment instance to replace. When this method completes, it returns a **String** object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar.

A date and time object that specifies the beginning of the time frame that the Appointments provider app should display. A timespan that hints to the Appointments provider app how long the time frame shown should be. When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Represents the organizer of an appointment in a calendar.

Initializes a new instance of the AppointmentOrganizer class.

Gets or sets a string that communicates the address of the organizer of an appointment. The address is required, inherited from IAppointmentParticipant, and a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type String and between 1 and 321 characters in length (non-empty).

The address of the organizer of an appointment.

Gets or sets a string that communicates the display name of the organizer of an appointment. The display name is optional, inherited from IAppointmentParticipant, of type String, and a maximum of 256 characters in length.

The display name of the organizer of an appointment.

Specifies the response from a participant concerning an appointment invitation.

The participant accepted the appointment invitation.

The participant declined the appointment invitation.

No response.

The participant might attend the appointment.

The response is unknown.

Specifies the role of an item concerning an appointment invitation.

The participant's attendance at the appointment is optional.

The participant's attendance at the appointment is required.

The item is a resource that is needed at the appointment.

Provides strings that identify the properties of an appointment.

Gets the name of the AllDay property.

The name of the AllDay property.

Gets the name of AllowNewTimeProposal the property.

The name of AllowNewTimeProposal the property.

Gets the name of the BusyStatus property.

The name of the BusyStatus property.

Gets the current change number of the local version of the Appointment.

The current change number of the local version of the Appointment.

Gets a list of names for the default appointment properties.

A list of names for the default appointment properties.

Gets the name of the Details property.

The name of the Details property.

Gets the format of the appointment details, plain text or HTML.

The format of the appointment details, plain text or HTML.

Gets the name of the Duration property.

The name of the Duration property.

Gets the name of the HasInvitees property.

The name of the HasInvitees property.

Gets the name of the Invitees property.

The name of the Invitees property.

Gets the name of the IsCanceledMeeting property.

The name of the IsCanceledMeeting property.

Gets the name of the IsOrganizedByUser property.

The name of the IsOrganizedByUser property.

Gets the name of the IsResponseRequested property.

The name of the IsResponseRequested property.

Gets the name of the Location property.

The name of the Location property.

Gets the name of the OnlineMeetingLink property.

The name of the OnlineMeetingLink property.

Gets the name of the Organizer property.

The name of the Organizer property.

Gets the name of the OriginalStartTime property.

The name of the OriginalStartTime property.

Gets the name of the Recurrence property.

The name of the Recurrence property.

Gets the name of the Reminder property.

The name of the Reminder property.

Gets or sets the current change number of the server version of the Appointment.

The current change number of the server version of the Appointment.

Gets the name of the ReplyTime property.

The name of the ReplyTime property.

Gets the name of the Sensitivity property.

The name of the Sensitivity property.

Gets the name of the StartTime property.

The name of the StartTime property

Gets the name of the Subject property.

The name of the Subject property.

Gets the name of the Uri property.

The name of the Uri property.

Gets the name of the UserResponse property.

The name of the UserResponse property.

Represents when and how often an appointment occurs.

Initializes a new instance of the AppointmentRecurrence class.

Gets a string that identifies the type of the calendar as represented by CalendarIdentifiers.

A string that identifies the type of the calendar.

Gets or sets the day on which an appointment occurs. Day is of type UInt32, has a default value of 1, and can be a value from 1 to 31.

The day on which an appointment occurs.

Gets or sets a combination of AppointmentDaysOfWeek -typed values for all the days of the week on which an appointment occurs.

A combination of AppointmentDaysOfWeek -typed values that are combined by using a bitwise OR operation. The resulting value specifies all the days of the week on which an appointment occurs.

Gets or sets the interval between occurrences of an appointment. Interval is of type UInt32 and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on.

The interval on which an appointment occurs.

Gets or sets the month on which an appointment occurs. Month is of type UInt32, has a default value of 1, and can be a value from 1 to 12.

The month on which an appointment occurs.

Gets or sets the number of times an appointment recurs. Occurrences is of type IReference(UInt32) and is **NULL** by default. Occurrences is mutually exclusive with Until.

The number of times an appointment recurs.

Gets a value indicating what type of recurrence applies to the associated appointment.

A value indicating what type of recurrence applies to the associated appointment.

Gets or sets the time zone for the recurrence.

The time zone for the recurrence.

Gets or sets a AppointmentRecurrenceUnit -typed value that indicates the frequency for which the appointment occurs.

A AppointmentRecurrenceUnit -typed value that indicates the frequency for which the appointment occurs.

Gets or sets the date and time until which an appointment is valid. Until is of type IReference(DateTime) and is **NULL** by default. Until is mutually exclusive with Occurrences.

The date and time until which an appointment is valid.

Gets or sets a AppointmentWeekOfMonth -typed value that indicates the week of the month for which the appointment occurs. The first week is the default.

A AppointmentWeekOfMonth -typed value that indicates the week of the month for which the appointment occurs.

Specifies the frequency for which an appointment occurs.

Appointment occurs daily.

Appointment occurs monthly.

Appointment occurs monthly on a particular day of the month.

Appointment occurs weekly.

Appointment occurs yearly.

Appointment occurs yearly on a particular day of the year.

Specifies the sensitivity of an appointment.

The appointment is private and can't be viewed publicly.

The appointment is publicly available to view.

Represents a store that contains appointments.

Returns the AppointmentStoreChangeTracker associated with the appointment store.

The AppointmentStoreChangeTracker associated with the appointment store.

Occurs when the AppointmentStore changes.

Asynchronously creates a new AppointmentCalendar within the appointment store using the specified parameters.

The name for the new AppointmentCalendar. An async operation that provides access to the newly created AppointmentCalendar.

Asynchronously creates a new AppointmentCalendar within the appointment store with the specified name and user data account ID.

The name for the new AppointmentCalendar. The identifier for the user data account used to create the AppointmentCalendar. An async operation that provides access to the newly created AppointmentCalendar.

Retrieves a list of all of the appointment calendars in the appointment store.

An asynchronous operation that returns an IVectorView upon successful completion.

Retrieves a list of appointment calendars in the appointment store that meet the criteria specified by the supplied FindAppointmentCalendarsOptions object..

The object that specifies the criteria that determines which appointment calendars are returned. An asynchronous operation that returns an IVectorView upon successful completion.

Retrieves a list of appointments in the appointment calendar that fall within the specified date range.

The start of the date range for which appointments are retrieved. The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the *rangeStart* value, the returned list will be empty. An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Retrieves a list of appointments in the appointment calendar that fall within the specified date range and meet the criteria specified by the supplied FindAppointmentsOptions object..

The start of the date range for which appointments are retrieved. The length of the date range for which appointments are retrieved. If the *rangeLength* parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the *rangeStart* value, the returned list will be empty. A FindAppointmentsOptions object that is used to specify more options for this operation. You must set the *options* parameter to specify the values to retrieve. An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Returns an AppointmentConflictResult representing a conflict between the specified appointment and an existing appointment in the appointment store.

The appointment for which a conflict is sought. An asynchronous operation that returns an AppointmentConflictResult upon successful completion. For conflicts that are in the past, the returned AppointmentConflictResult object will have a Type of AppointmentConflictType.None.

Returns an AppointmentConflictResult representing a conflict between the specified appointment and an existing appointment instance in the appointment store.

The appointment for which a conflict is sought. The start time of the appointment instance for which a conflict is sought. An asynchronous operation that returns an AppointmentConflictResult upon successful completion. For conflicts that are in the past, the returned AppointmentConflictResult object will have a Type of AppointmentConflictType.None.

Returns a list of LocalId values for appointment instances with the specified RoamingId value.

The RoamingId value for which local ID values are sought. An asynchronous operation that returns an IVectorView upon successful completion.

Retrieves the Appointment with the specified LocalId.

The LocalId of the appointment to be retrieved. An asynchronous operation that returns an Appointment upon successful completion.

Retrieves the AppointmentCalendar with the specified LocalId.

The LocalId of the AppointmentCalendar to be retrieved. An asynchronous operation that returns an AppointmentCalendar upon successful completion.

Retrieves the instance of the Appointment with the specified LocalId and the specified start time.

The LocalId of the appointment instance to be retrieved. The start time of the appointment instance to be retrieved. The value of this parameter must be the original start date of the instance. An asynchronous operation that returns an Appointment upon successful completion.

Gets a AppointmentStoreChangeTracker that provides functionality for monitoring changes to Appointment objects in the AppointmentStore.

A string that identifies the AppointmentStoreChangeTracker instance in the store. A AppointmentStoreChangeTracker that provides functionality for monitoring changes to Appointment objects in the AppointmentStore.

Moves the specified Appointment object to the specified AppointmentCalendar.

The appointment to be moved. The appointment calendar to which the appointment is moved. An asynchronous action.

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

The object representing the information for the appointment to add. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the RoamingId of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. An asynchronous action.

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

The LocalId of the appointment to be displayed. A DateTime object with the start time of the appointment instance to be displayed. This parameter must be the original start date of the instance. An asynchronous action.

Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment.

The appointment to be added. When this method completes, it returns a **String** object that represents the RoamingId of the appointment. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The LocalId of the appointment to be removed. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

The LocalId of the appointment to be removed. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Remove Appointment UI. The start date and time of the appointment instance to remove. This parameter must be the original start date of the instance. When this method completes, it returns a **Boolean** value that indicates whether the Appointment provider app removed the appointment.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The LocalId of the appointment to be replaced. The object representing the appointment to replace the existing appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. When this method completes, it returns a **String** object that represents the RoamingId of the appointment that replaced the existing appointment.

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

The LocalId of the appointment to be replaced. The object representing the appointment to replace the existing appointment. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it. The Placement that describes the preferred placement of the Replace Appointment UI. The start date and time of the appointment instance to replace. When this method completes, it returns a **String** object that represents the RoamingId of the appointment that replaced the existing appointment.

Specifies the level of access granted to an AppointmentStore.

The appointment store has read-only access to all calendars on the device.

The appointment store has read and write access to all calendars created by the calling app.

The appointment store has read and write access to appointment calendars created by the calling app.

Represents a change that has occurred in an appointment store.

Gets the Appointment associated with the change.

The Appointment associated with the change.

Gets the AppointmentCalendar in which the change occurred.

The AppointmentCalendar in which the change occurred.

Gets an AppointmentStoreChangeType value indicating the type of change represented by the object.

An AppointmentStoreChangeType value indicating the type of change represented by the object.

Represents a background task deferral returned by the AppointmentStoreChangedEventArgs.GetDeferral method.

Informs the system that an asynchronous operation associated with an AppointmentStore has finished.

Provides data for a StoreChanged event.

Gets the deferral object for the StoreChanged event.

The deferral object for the StoreChanged event.

Enables the calling app to read through the changes to appointments in its appointment store.

Tells the system that all of the changes to appointments returned by the call to ReadBatchAsync have been addressed by the app.

Tells the system that all of the changes to appointments returned by the call to ReadBatchAsync, up to the specified AppointmentStoreChange, have been addressed by the app.

The AppointmentStoreChange object indicating the latest change that has been addressed by the app.

Returns a list of the changes that have occurred in the appointment store that have not yet been accepted by the calling app.

An asynchronous operation that returns an IVectorView upon successful completion.

Provides APIs for managing change tracking for appointments.

Gets a Boolean value indicating whether change tracking is active.

A Boolean value indicating whether change tracking is active.

Enables change tracking for the appointment store.

Retrieves an AppointmentStoreChangeReader that enables the app to iterate through the list of changes and mark changes as accepted.

The returned change reader.

Resets change tracking for the appointment store, deleting existing change tracking data.

Specifies the type of change represented by an AppointmentStoreChange object.

An appointment was created.

An appointment was deleted.

An appointment was modified.

A calendar was created.

A calendar was deleted.

A calendar was modified.

The change tracking information associated with the appointment was lost.

Passed to a background task to indicate that the task was invoked by an AppointmentStore.

Specifies how the summary card for an appointment is displayed.

The appointment summary card is displayed by the app that owns the appointment calendar.

The appointment summary card is displayed by the system.

Specifies the week of the month for which the appointment occurs.

The appointment occurs on the first week of the month.

The appointment occurs on the fourth week of the month.

The appointment occurs on the last week of the month.

The appointment occurs on the second week of the month.

The appointment occurs on the third week of the month.

Specifies additional options when querying for appointment calendars.

Include appointment calendars that are hidden.

No additional options.

Represents a set of options that modifies a query for appointments.

Creates a new instance of the FindAppointmentsOptions class.

Gets the list of calendar IDs that will be included in the find appointments query. If this list is empty, then appointments will be returned from all calendars.

A list of calendar IDs.

Gets the list of appointment property names that will be populated with data in the find appointment query results.

A list of appointment property names.

Gets or sets a value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result.

A value indicating whether appointments belonging to hidden calendars will be included in the find appointments query result.

Gets or sets the maximum number of appointments that should be included in the find appointments query result.

The maximum number of appointments that should be included in the find appointments query result.

Provides info about a participant of an appointment in a calendar.

Gets or sets a string that communicates the address of a participant of an appointment. The address is required and is a Simple Mail Transfer Protocol (SMTP) e-mail address. It is also of type String and between 1 and 321 characters in length (non-empty).

The address of a participant of an appointment.

Gets or sets a string that communicates the display name of a participant of an appointment. The display name is optional, of type String, and a maximum of 256 characters in length.

The display name of a participant of an appointment.

Specifies the recurrence type of an appointment.

The appointment is an exceptional instance of a recurring appointment.

The appointment is an instance of a recurring appointment.

The appointment is the master appointment for a recurring appointment.

Represents the operation object associated with adding a new appointment. Appointments provider apps use this info to perform the operation.

Gets the Appointment info from the activation request.

An instance of the Appointment class that represents the specific info for the appointment to add.

Gets the package family name of the app that is requesting the operation.

The package family name.

Dismisses the UI for the operation that adds a new appointment.

Call this method to inform the activating app that the operation was canceled by the user.

Call this method to inform the activating app that the operation was completed successfully. Provide a unique appointment ID as the *itemID* parameter.

A unique appointment ID that the activating app can later use to remove this appointment if necessary.

Informs the activating app that the operation couldn't be completed because of a provider error.

A string that contains info about the error.

Represents the object associated with retrieving the operation of the appointments provider.

Gets the add-appointment action that the appointments provider performs.

The add-appointment action

Gets the remove-appointment action that the appointments provider performs.

The remove-appointment action

Gets the replace-appointment action that the appointments provider performs.

The replace-appointment action

Gets the show-appointment-details action that the appointments provider performs.

The show-appointment-details action

Gets the show-time-frame action of an appointment that the appointments provider performs.

The show-time-frame action of an appointment

Represents the operation object associated with removing an appointment. Appointments provider apps use this info to perform the operation.

Gets the unique identifier of the appointment to remove.

The unique identifier of the appointment to remove.

Gets the start date and time of the appointment instance to remove.

The start date and time of the appointment instance to remove.

Gets the package family name of the app that is requesting the operation.

The package family name.

Dismisses the UI for the operation that removes an appointment.

Call this method to inform the activating app that the operation was canceled by the user.

Informs the activating app that the operation was completed successfully.

Informs the activating app that the operation couldn't be completed because of a provider error.

A string that contains info about the error.

Represents the operation object associated with replacing an appointment. Appointments provider apps use this info to perform the operation.

Gets the unique identifier of the appointment to replace.

The unique identifier of the appointment to replace.

Gets the Appointment info from the activation request.

An instance of the Appointment class that represents the specific info for the appointment to replace the current appointment.

Gets the start date and time of the appointment instance to replace.

The start date and time of the appointment instance to replace.

Gets the package family name of the app that is requesting the operation.

The package family name.

Dismisses the UI for the operation that replaces an appointment.

Informs the activating app that the operation was canceled by the user.

Informs the activating app that the operation was completed successfully.

A unique appointment ID that the activating app can later use to remove this appointment if necessary or to replace it again.

Informs the activating app that the operation couldn't be completed because of a provider error.

A string that contains info about the error.

Represents the user's request to cancel a calendar meeting.

Uniquely identifies the calendar on the local device.

A string that uniquely identifies the calendar on the local device.

Gets a string that uniquely identifies the appointment on the local device.

A string that uniquely identifies the appointment on the local device.

Gets the original starting time for a recurring appointment.

The original starting time for a recurring appointment.

Gets a text comment the user may write regarding the cancellation of the meeting.

A text comment by the user regarding the meeting cancellation.

Gets a Boolean value indicating if invitees should be notified.

A Boolean value indicating if invitees should be notified.

Gets the subject of the response.

The subject of the response.

Notifies the system that the task of cancelling a meeting has completed.

An asynchronous operation.

Notifies the system that the task of cancelling a meeting has failed.

An asynchronous operation.

Provides data for a CancelMeetingRequested event.

Gets the AppointmentCalendarCancelMeetingRequest object for the corresponding CancelMeetingRequested event.

The AppointmentCalendarCancelMeetingRequest object for the event.

Gets the deferral object for the CancelMeetingRequested event.

The deferral object for the CancelMeetingRequested event.

Represents the user's request to change the response to a calendar meeting.

Gets the appointment to create or update.

The appointment to create or update.

Gets a string that uniquely identifies the calendar associated with the appointment on the local device.

A string that uniquely identifies the calendar on the local device.

Gets a list of properties that the user wished to change or set in an appointment.

A list of appointment properties.

Gets a Boolean value indicating if invitees should be notified.

A Boolean value indicating if invitees should be notified.

Notifies the system that the task of creating or updating an appointment has completed.

The calendar appointment that has been created or updated. An asynchronous operation.

Notifies the system that the task of creating or updating an appointment has failed.

An asynchronous operation.

Provides data for a CreateOrUpdateAppointmentRequested event.

Gets the AppointmentCalendarCreateOrUpdateAppointmentRequest object for the corresponding CreateOrUpdateAppointmentRequested event.

The AppointmentCalendarCreateOrUpdateAppointmentRequest object for the event.

Gets the deferral object for the CreateOrUpdateAppointmentRequested event.

The deferral object for the CreateOrUpdateAppointmentRequested event.

Represents the user's request to forward a calendar meeting.

Gets a string that uniquely identifies the calendar associated with the appointment on the local device.

A string that uniquely identifies the calendar on the local device.

Gets a string that uniquely identifies the appointment on the local device.

A string that uniquely identifies the appointment on the local device.

Gets the original starting time for a recurring appointment.

The original starting time for a recurring appointment.

Gets a text comment the user may write regarding the forwarding of the meeting.

A text comment by the user regarding the forwarding of the meeting.

Gets the new meeting header that includes the new invitees.

The new meeting header for the new invitees.

Gets a list of the new invitees to receive the forwarded meeting.

A list of new invitees.

Gets the subject of the forwarded meeting invitation.

The subject of the forwarded meeting invitation.

Notifies the system that the task of forwarding a meeting has completed.

An asynchronous operation.

Notifies the system that the task of forwarding a meeting has failed.

An asynchronous operation.

Provides data for a ForwardMeetingRequested event.

Gets the AppointmentCalendarForwardMeetingRequest object for the corresponding ForwardMeetingRequested event.

The ForwardMeetingRequest object for the event.

Gets the deferral object for the ForwardMeetingRequested event.

The deferral object for the ForwardMeetingRequested event.

Represents the user's request to change the time of a calendar meeting.

Gets a string that uniquely identifies the calendar associated with the appointment on the local device.

A string that uniquely identifies the calendar on the local device.

Gets a string that uniquely identifies the appointment on the local device.

A string that uniquely identifies the appointment on the local device.

Gets the original starting time for a recurring appointment.

The original starting time for a recurring appointment.

Gets a text comment the user may write regarding the change in meeting time.

A text comment by the user regarding the change in meeting time

Gets the proposed new duration of the meeting.

The proposed new duration of the meeting.

Gets the proposed new start time of the meeting.

The proposed new start time.

Gets the subject of the new meeting invitation.

The subject of the meeting.

Notifies the system that the task of updating a meeting's time has completed.

An asynchronous operation.

Notifies the system that the task of updating a meeting's time has failed.

An asynchronous operation.

Provides data for an ProposeNewTimeForMeetingRequested event.

Gets the AppointmentCalendarProposeNewTimeForMeetingRequest object for the corresponding ProposeNewTimeForMeetingRequested event.

The AppointmentCalendarProposeNewTimeForMeetingRequest object for the event.

Gets the deferral object for the ProposeNewTimeForMeetingRequested event.

The deferral object for the ProposeNewTimeForMeetingRequested event.

Represents the user's request to sync the calendar.

Gets a string that uniquely identifies the calendar associated with the appointment on the local device.

A string that uniquely identifies the calendar on the local device.

Notifies the system that the task of syncing the calendar has completed.

An asynchronous operation.

Notifies the system that the task of syncing the calendar has failed.

An asynchronous operation.

Provides data for a SyncRequested event.

Gets the AppointmentCalendarSyncManagerSyncRequest object for the corresponding SyncRequested event.

The AppointmentCalendarSyncManagerSyncRequest object for the event.

Gets the deferral object for the SyncRequested event.

The deferral object for the SyncRequested event.

Represents the user's request to change the response to a calendar meeting.

Gets a string that uniquely identifies the calendar associated with the appointment on the local device.

A string that uniquely identifies the calendar on the local device.

Gets a string that uniquely identifies the appointment on the local device.

A string that uniquely identifies the appointment on the local device.

Gets the original starting time for a recurring appointment.

The original starting time for a recurring appointment.

Gets a text comment the user may write regarding the change in meeting response.

A text comment by the user regarding the change in meeting response.

Gets the new response the user wishes to give concerning an appointment invitation.

The new response the user wishes to give.

Indicates whether the user wishes to send an update to the meeting's organizer.

The Boolean value indicating whether or not to send the response to the meeting organizer.

Gets the subject of the response.

The subject of the response.

Notifies the system that the task of updating a meeting response has completed.

An asynchronous operation.

Notifies the system that the task of updating a meeting response has failed.

An asynchronous operation.

Provides data for an UpdateMeetingResponseRequested event.

Gets the AppointmentCalendarUpdateMeetingResponseRequest object for the corresponding UpdateMeetingResponseRequested event.

The AppointmentCalendarUpdateMeetingResponseRequest object for the event.

Gets the deferral object for the UpdateMeetingResponseRequested event.

The deferral object for the UpdateMeetingResponseRequested event.

Describes a connection between app and system for relaying calendar appointment information.

Raised when the user elects to cancel a meeting.

Raised when the user elects to create or update a meeting.

Raised when the user elects to forward a meeting.

Raised when the user elects to change the time of a meeting.

Raised when the user elects to sync all calendar appointments with the server.

Raised when the user elects to change their response to a proposed meeting.

Starts the connection for transfer of data.

Represents trigger information about the background task in which data will be transferred between the app and its caller.

Gets the data connection over which appointment data can be transferred.

The data connection over which appointment data can be transferred.

Enumerate the available app service providers on the device. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume.

Returns the list of app service providers that match a specific app service name on the device.

The name of the app service to find. A list of AppInfo s for the app service provider(s) that are available for the specified app service name.

Provides data for the AppServiceConnection.ServiceClosed event that occurs when the other endpoint closes connection to the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Gets the status that was set when the endpoint for the app service was closed.

The status that was set when the endpoint for the app service was closed.

Describes the status that was set when the endpoint for the app service was closed. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume.

The endpoint for the app service was closed by the client or the system

The endpoint for the app service closed gracefully.

The endpoint for the app service was closed because the endpoint ran out of resources.

An unknown error occurred.

Represents a connection to the endpoint for an app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Creates and initializes a new instance of the AppServiceConnection class.

Gets or sets the name of the app service to which you want to connect.

The name of the app service to which you want to connect.

Gets or sets the package family name for the package that contains the endpoint for the app service.

The package family name for the package that contains the endpoint for the app service.

Gets/sets the user context. This property returns **null** if the caller did not specify a user.

The user of the app service.

Occurs when a message arrives from the other endpoint of the app service connection.

Occurs when the other endpoint closes the connection to the app service.

Closes the connection to the app service.

Opens a connection to the endpoint for the app service.

An asynchronous operation to open a connection to the endpoint for the app service.

Opens a connection to the endpoint on another device for the app service.

Specifies the connection preferences for the AppServiceConnection, such as transport preferences (cloud/proximal/any) as well as the target System.RemoteSystems object. An asynchronous operation to open a connection to the endpoint for the app service on another device.

Sends a message to the other endpoint of the app service connection.

The message that you want to send. An asynchronous operation to send the message that optionally returns a response message when complete.

Opens an app service connection, sends a single message, waits for a single response, and then closes the connection.

The app service to connect to. Specifies the connection preferences for the AppServiceConnection, such as transport preferences (cloud/proximal/any) as well as the target System.RemoteSystems object. The message that you want to send. An asynchronous operation to send the message that optionally returns a response message when complete.

Describes the status for the attempt that an app makes to open a connection to an app service by calling the AppServiceConnection.OpenAsync method. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume.

The package for the app service to which a connection was attempted is not installed on the device. Check that the package is installed before trying to open a connection to the app service.

The app with the specified package family name is installed and available, but the app does not declare support for the specified app service. Check that the name of the app service and the version of the app are correct.

The package for the app service to which a connection was attempted is temporarily unavailable. Try to connect again later.

The operation failed due to unsuccessful account authentication. The user must re-validate the account to continue.

The operation failed, as the app service needed service or capabilities disabled by some policies on the local or remote device.

The operation failed due to lack of an internet connection.

The user for your app is not authorized to connect to the service.

The app on the remote device does not support remote connections. It needs to specify SupportsRemoteSystems="true" on the appService extension in its AppXManifest to accept remote connections.

The device to which a connection was attempted is not available.

The connection to the app service was opened successfully.

An unknown error occurred.

The operation failed because one or more necessary cloud services were temporarily unavailable.

Enables the background task for an app service to get a deferral so that the app service can respond to subsequent requests. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume.

Indicates that the content for an asynchronous handler for the AppServiceConnection.RequestReceived event is ready, or that an error occurred.

Represents a message that the endpoint for one app service sends to another app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Gets the message that request from the app service contains.

The message that request from the app service contains.

Sends a response to a received request.

The message that you want to include in the response. An asynchronous operation to send the response.

Provides data for the AppServiceConnection.RequestReceived event that occurs when a message arrives from the other endpoint of the app service connection. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Gets the request that was received from the app service.

The request that was received from the app service.

Informs the system that the event handler might continue to perform work after the event handler returns.

The deferral.

Represents the message that the app service sent in response to a request. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Gets the message that the response from the app service contains.

The message that the response from the app service contains.

Gets the status for the response from the app service.

The status for the response from the app service.

Describes the status when an app tries to send a message to an app service by calling the AppServiceConnection.SendMessageAsync method. App service providers enable app-to-app communication by providing services that other Universal Windows app can consume.

The operation failed due to the app failing to start.

The operation failed due to unsuccessful account authentication. The user must re-validate the account to continue.

The operation failed, as the app service needed service or capabilities disabled by some policies on the local or remote device.

The app service failed to receive and process the message.

The app service failed to process the message because it is too large.

The operation failed due to lack of an internet connection.

The device to which the message was sent is not available.

The app service exited because not enough resources were available.

The app service successfully received and processed the message.

An unknown error occurred.

The operation failed because one or more necessary cloud services were temporarily unavailable.

Represents details associated with the background task for the app service. App services enable app-to-app communication by allowing you to provide services from your Universal Windows app to other Universal Windows app.

Gets the connection to the endpoint of the other app service.

The connection to the endpoint of the other app service.

Gets the name of the package family for the client app that called the background task for the app service.

The name of the package family for the client app that called the background task for the app service.

A string token which can be used to connect back to caller of a remote app service via RemoteSystemConnectionRequest.CreateFromConnectionToken.

The string token.

Gets whether the client app that called the background task for the app service is on another device.

Returns **true** if the client app is calling from another device; **false** otherwise.

Gets the name of the app service.

The name of the app service.

Determines whether the caller of the app service has the specified capability.

The name of the capability. **True** if it was possible to get the capabilities of the caller and the caller has the specified capability; **false** otherwise.

The response to an SendStatelessMessageAsync call, containing the response message and connection status.

The response to the the SendStatelessMessageAsync operation.

The response to the the SendStatelessMessageAsync operation.

The response status.

The response status.

Indicates success or failure of a SendStatelessMessageAsync operation.

The operation failed due to the app not being presented on the remote system.

The operation failed due to the app not supporting the requested app service.

The operation failed due to the app failing to start.

The operation failed due to unsuccessful account authentication. The user must re-validate the account to continue.

The operation failed, as the app service needed service or capabilities disabled by some policies on the local or remote device.

The operation failed.

The operation failed due to the message size being too large.

The operation failed due to lack of an internet connection.

The operation failed due to authorization.

The operation failed due to the app service on the remote system missing the SupportsRemoteSystems flag.

The operation failed due to the remote system being unavailable.

The operation failed due to resource limits being exceeded.

The operation completed succesfully.

An unknown error occurred.

The operation failed because one or more necessary cloud services were temporarily unavailable.

Represents a trigger that is activated when the ActivitySensor receives input. This is used when your application needs to respond to the activity sensor.

Creates an instance of the ActivitySensorTrigger class with an initial MinimumReportInterval.

The initial report interval to use for MinimumReportInterval.

Gets the minimum supported report interval for the sensor trigger.

The minimum supported interval in milliseconds.

Gets the report interval for the trigger.

The current report interval for the trigger in milliseconds.

Gets or sets the list of activities your trigger is subscribed to.

The list of subscribed activities.

Gets the list of supported activities you can subscribe to.

The list of supported activities for subscription.

This allows you to programmatically trigger a background task from within your application.

Creates a new ApplicationTrigger class

This method attempts to set the trigger and start the registered background task.

Returns an ApplicationTriggerResult enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task.

This method attempts to set the trigger and start the registered background task with specified arguments.

The serialized arguments that are passed to the background task. Returns an ApplicationTriggerResult enumeration that indicates whether the user provided the necessary consent for the operation or the system policies didn't reject the request to trigger a background task.

The details of an ApplicationTrigger.

The arguments that were passed to the background task using the ApplicationTrigger.RequestAsync(ValueSet) method.

The serialized arguments.

The result of the request to trigger a background task. The RequestAsync method returns a value of this enumeration type.

The trigger has been set. The task will run, unless an exception is thrown in the background infrastructure.

The system denied triggering the background task because it is currently running.

A system policy doesn't allow this background task to be triggered.

The background task cannot be triggered because of an unknown issue.

Represents a trigger that launches a background task for processing changes to the appointment store.

Initializes a new instance of the AppointmentStoreNotificationTrigger class.

Specifies the level of background activity that an app can request.

Allow the app to run in the background, unless background activity has been limited by the user or by the system to improve battery life.

Allow the app run background activities, including during Battery Saver.

This enumeration specifies an app's ability to perform background activity.

The app can set up background tasks, but it cannot use the real-time connectivity (RTC) broker. This means that the app might not function while the device is in connected standby. Note that apps that do not specify RTC in their manifest will always demonstrate this behavior.

Use AlwaysAllowed or AllowedSubjectToSystemPolicy instead of AllowedMayUseActiveRealTimeConnectivity. For more info, see MSDN.

The user has selected Balanced or System Managed in the battery use settings. Introduced in Windows 10, version 1607.

The app can set up background tasks, and, if it has the capability, can use the real-time connectivity (RTC) broker. This means that the app can function while the device is in the connected standby state.

Use AlwaysAllowed or AllowedSubjectToSystemPolicy instead of AllowedWithAlwaysOnRealTimeConnectivity. For more info, see MSDN.

On devices that have a battery, the user has given the app permission in the battery use settings to always allow background access. Introduced in Windows 10, version 1607.

This value is deprecated in Windows 10, version 1607.

Use DeniedByUser or DeniedBySystemPolicy instead of Denied. For more info, see MSDN.

On devices that have a battery, the user has selected Battery Optimized in the battery use settings and the system has chosen not to allow this application to run in the background based on system resources. Introduced in Windows 10, version 1607.

On devices that have a battery, the user has disabled the app from running in the background in the battery use settings. Introduced in Windows 10, version 1607.

The app cannot perform background activity in this state.

Manage permission to run background tasks.

Gets the app's background task execution capability.

An enumeration value that specifies the app's background capabilities.

Gets the specified app's background task execution capability.

The package-relative application identifier (PRAID) of the app whose capabilities are being retrieved. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. An enumeration value that specifies the app's background capabilities.

Removes the calling app from the list of apps that may run background tasks.

Removes a specific app from the list of apps that may run background tasks.

The package-relative application identifier (PRAID) of the app to be removed from the list of apps that may run background tasks. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element.

Requests that the app be permitted to run background tasks.

When the operation completes, it returns a member of the BackgroundAccessStatus enumeration that specifies the outcome.

Asynchronously requests that the app be permitted to run background tasks.

The package-relative application identifier (PRAID) of the app to be permitted to run background tasks. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. An asynchronous request operation. On successful completion, contains a member of the BackgroundAccessStatus enumeration that specifies the outcome.

Prompts the user whether they consent to allow the app to perform the specified level of background activity in the background. On the Desktop OS Edition this may present a prompt to the user for their consent.

The type of background activity the app wishes to perform. The string to display in the prompt that the system will raise to the user to describe why the app is requesting to run in the background. For example, the string that appears after "The app says:" **True** indicates that the user or the system approved the requested background activity; **false**, otherwise.

Represents a background task to register with the system.

Creates an instance of the BackgroundTaskBuilder class.

Indicates whether the background task will be canceled if at least one of its required conditions is no longer met.

Whether or not the background task will be canceled if at least one of its required conditions is no longer met.

Indicates whether to keep the network up while running the background task.

`True`: ensure that the network is up while running the background task. `False`, otherwise.

Gets or sets the name of a background task.

A description of the background task.

Gets or sets the class that performs the work of a background task.

The name of an application-defined class that performs the work of a background task.

Gets and sets the group identifier.

The group identifier.

Adds a condition to a background task.

An instance of a SystemCondition object.

Registers a background task with the system.

An instance of a BackgroundTaskRegistration object.

Sets the event trigger for a background task.

An instance of an event trigger object such as a SystemTrigger, TimeTrigger, or NetworkOperatorNotificationTrigger.

Represents a method that handles the cancellation of a background task.

The background task instance that was cancelled. The reason the background task instance was cancelled.

Specifies the reasons for cancelling a background task.

The background task was canceled by the application. This can happen for one of the following four reasons:

The background task was canceled because one or more of its required conditions is no longer met.

The background task was cancelled because of the current Energy Saver policy.

The background task was cancelled because it exceeded its allotted time to run.

The background task was canceled because it was active, but not doing any work.

The background task was canceled because the user has logged off the system.

The background task was cancelled because the device entered the quiet hours period.

QuietHoursEntered is deprecated after Windows 8.1

The background task was cancelled because the system needed additional resources. The background task was cancelled to free up those resources.

The background task was canceled because the application was updated.

The background task was cancelled because of system policy.

The background task was canceled because the application is about to be terminated due to system policy. The application should save any state that will be needed when the application restarts.

The background task was canceled because the application was uninstalled.

Represents completion information for a task at the time a completion notification is sent.

Gets the identifier of the background task instance for this completion status notification.

A unique identifier generated by the system when it creates the background task instance.

Throws an exception if the background task completed event has reported an error.

Represents a method that handles completion events for a background task.

The background task. Completion information for the task at the time the notification is sent.

Represents a background task deferral returned by the IBackgroundTaskInstance.GetDeferral method.

Informs the system that an asynchronous operation associated with a background task has finished.

Represents progress information for a task at the time a progress update notification is sent.

Gets the identifier of the background task instance for this progress status notification.

A unique identifier generated by the system when it creates the background task instance.

Gets progress status for a background task instance.

A value defined by the application to indicate the task's progress.

Represents a method that handles progress update events for a background task.

The background task. Progress information for the task at the time the notification is sent.

Represents a background task that has been registered with the system.

Gets the background task groups.

A dictionary of background task groups.

Enumerates an application's registered background tasks, except for the background tasks registered in a group with Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskGroup.

A view into a map of registered background tasks consisting of the task ID and an IBackgroundTaskRegistration interface.

Gets the name of a registered background task.

The description specified with BackgroundTaskBuilder.Name when the task was created.

Gets the **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of.

The **BackgroundTaskRegistrationGroup** that this **BackgroundTaskRegistration** is a part of.

Gets the identifier of a registered background task.

The unique identifier for the task. This identifier is generated by the system when the task is registered.

This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null.

This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null.

Attaches a completed event handler to the registered background task.

Attaches a progress event handler to the registered background task.

Gets the task group object that is associated with the group identifier.

The group identifier. The task group object that is associated with the group identifier.

Cancels the registration of a registered background task.

True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances are allowed to finish. Canceled instances receive a Canceled event with a cancellation reason of **Abort**.

Provides grouping semantics so that background task registration can be maintained separately.

Creates a **BackgroundTaskRegistrationGroup** with the specified group ID.

The group ID.

Creates a **BackgroundTaskRegistrationGroup** with the specified group ID and

The group ID. The friendly name for this group.

Gets all of the background tasks that belong to the group.

The background tasks that belong to the group.

Gets the group ID.

The group ID.

Gets the friendly name of the group.

The friendly name.

This event is fired when a background task that belongs to a group starts.

Indicates the type of throttle count to check for in a GetThrottleCount request.

Indicates a request for all throttle counts (CPU and network).

Indicates a request for CPU throttle count.

Indicates a request for network throttle count.

Retrieves a hint about resource availability for background tasks. Background tasks can use this hint to decide how much work to do when they are activated.

Retrieves a hint about resource availability for background tasks.

A hint about background resource availability. A background task can use this hint to decide how much work to do when it is activated.

Indicates the current cost of doing background work. Used as a hint to background tasks about how much work they can do.

Background resources are under heavy use and the background task should not do any work.

Background resource usage is low. The background task can do work.

Background resources are in use, but the background task can do some work.

Represents a trigger that is registered to advertise a Bluetooth LE advertisement in the background.

Creates a new instance of the BluetoothLEAdvertisementPublisherTrigger class.

Gets the Bluetooth LE advertisement to configure and publish in the background.

The Bluetooth LE advertisement to configure and publish in the background.

Specifies whether the transmit power level is included in the advertisement header. Defaults to False.

Indicates whether the transmit power level is included. The default value is False.

Specifies whether or not the device address is included in the advertisement header. By default, the address is included.

Indicates whether the device address is hidden. The default value is False, indicating that the address is included.

If specified, requests that the radio use the indicated transmit power level for the advertisement. Defaults to Null.

The requested power level for the radio transmission. The default is Null.

Specifies that the advertisement publisher should use the Extended Advertising format.

Indicates whether or not the Extended Advertising format should be used. The default value is False.

Represents a trigger that is registered to scan for Bluetooth LE advertisement in the background.

Creates a new instance of the BluetoothLEAdvertisementWatcherTrigger class.

Gets or sets the configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering.

The configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering.

Enables reception of advertisements using the Extended Advertising format. Defaults to False.

Indicates whether advertisements of the Extended Advertising format can be received. The default value is False.

Gets the maximum out of range timeout supported for the SignalStrengthFilter property of this trigger.

The maximum out of range timeout supported for the SignalStrengthFilter property of this trigger.

Gets the maximum sampling interval supported for the SignalStrengthFilter property of this trigger. The maximum sampling interval is used to deactivate the sampling filter and only trigger received events based on the device coming in and out of range.

The maximum sampling interval supported for the SignalStrengthFilter property of this trigger.

Gets the minimum out of range timeout supported for the SignalStrengthFilter property of this trigger.

The minimum out of range timeout supported for the SignalStrengthFilter property of this trigger.

Gets the minimum sampling interval supported for the SignalStrengthFilter property of this trigger. The minimum sampling interval for the background watcher cannot be zero unlike its foreground counterpart.

Gets the minimum sampling interval supported for the SignalStrengthFilter property of this trigger.

Gets or sets the configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

The configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

Represents a trigger that launches a background task to enable the Cached File Updater contract.

Initializes a new instance of the CachedFileUpdaterTrigger class.

Provides details about the cached file operation that invoked the trigger.

Gets whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger.

Whether the system can display UI allowing the user to launch provider app in response to the cached file updater trigger.

Gets the FileUpdateRequest object associated with the cached file update.

The FileUpdateRequest object associated with the cached file update.

Gets the CachedFileTarget object associated with cached file update that indicates whether the local or remote file should be updated.

The CachedFileTarget object associated with cached file update that indicates whether the local or remote file should be updated.

Represents a trigger that is activated when there is a notification for a text message.

Represents a trigger that is activated when there is a notification for a text message.

Represents a trigger that launches a background task that handles any incoming message that might need to be filtered according to its content. For more information about filtering messages, see Windows.ApplicationModel.CommunicationBlocking.

Initializes a new instance of the ChatMessageReceivedNotificationTrigger class.

Represents a trigger that launches a background task for processing changes to the contacts store.

Initializes a new instance of the ContactStoreNotificationTrigger class.

Provides the ability to run custom handlers when prefetching web resources.

Initializes a new instance of the ContentPrefetchTrigger class.

Initializes a new instance of the ContentPrefetchTrigger class using a specified time interval.

Interval before next allowed content prefetch.

Retrieves the time interval for prefetching web content.

The time interval set for refreshing web content.

Represents a trigger that launches a background task for processing digital assistant communication through the Windows platform Agent Activation Runtime (AAR).

Creates an instance of a ConversationalAgentTrigger.

This class allows you to specify a custom system trigger so that you can register it and respond when it is triggered by the system.

Creates an instance of a **CustomSystemEventTrigger**, with the specified identifier and recurrence.

The identifier for the created **CustomSystemEventTrigger**. When the trigger may be activated.

Gets when this custom system event trigger may be activated.

An enum that specifies when this custom system event trigger may be activated.

The trigger identifier that uniquely identifies the background task that needs to be started by this trigger.

The trigger identifier string.

Specifies when a CustomSystemEventTrigger may be activated.

The trigger can always be activated.

The trigger can only be activated once per session.

Represents a trigger that launches a background task when the connection status of a device changes.

Gets whether the system can maintain a connection to the specified device.

True if the system can maintain a connection to the specified device; Otherwise, false. If false, an attempt to register a trigger with MaintainConnection = true will throw an exception. The default value of this property is true for Bluetooth LE devices and false for all other device types.

Gets the device Id associated with the device.

The device Id associated with the device.

Gets or sets whether the system should automatically attempt to keep the referenced device connected.

True of the system should try to keep the device connected; Otherwise, false. Default is false.

Begins an asynchronous operation to get the DeviceConnectionChangeTrigger associated with the specified Id.

The device Id with which to find the associated trigger. The DeviceConnectionChangeTrigger object associated with the specified device Id.

Represents a trigger that launches a background task to enable device manufacturer operations.

DeviceManufacturerNotificationTrigger is deprecated and might not work on all platforms

Initializes a new instance of the DeviceManufacturerNotificationTrigger class.

DeviceManufacturerNotificationTrigger is deprecated and might not work on all platforms An app-defined string that qualifies the trigger. Whether the trigger is used only once.

Gets whether the trigger is used only once.

True if the trigger is used only once.

Gets an app-defined string that qualifies the trigger.

An app-defined string that qualifies the trigger.

Represents an event that an application can trigger to initiate a long-running update (firmware or settings) of a device.

Constructor for DeviceServicingTrigger. Takes no parameters.

Triggers the background task (settings or firmware update) and returns a DeviceTriggerResult indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string and an optional estimated time the background task will run. If your app cannot determine an appropriate time estimate, provide zero as the estimated time.

The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. This method returns a DeviceTriggerResult when it completes asynchronously.

Triggers the background task (settings or firmware update) and returns a DeviceTriggerResult indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* string, an optional estimated time the background task will run, and an optional app-specific string passed to the background task identifying which device operation to perform. If your app cannot determine an appropriate time estimate, provide zero as the estimated time.

The *DeviceInformation.ID* of the device the background task will access. The device path must match the device that will perform the background operation and is used by Windows to ensure that policy requirements are met. Optional value. The expected duration of the background settings update or background firmware update. If provided, it will be displayed to the user in the system consent dialog when the task is triggered by your app. Set this value to zero if an appropriate time estimate cannot be determined. Optional value. An app-specific string passed to the background task identifying which device operation to perform. This method returns a DeviceTriggerResult when it completes asynchronously.

Indicates whether the device background task operation was allowed or denied, and if it was denied specifies the reason.

The device background task was triggered.

The device background task was denied due to system policy.

The device background task was denied by the user.

The device background task cannot run because the battery is low.

Represents an event that a Windows Runtime app can trigger to initiate a long-running operation with a device or sensor.

Constructor for DeviceUseTrigger. Takes no parameters.

Triggers the background task and returns a DeviceTriggerResult indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access.

The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. This method returns a DeviceTriggerResult when it completes asynchronously.

Triggers the background task and returns a DeviceTriggerResult indicating success or failure of the trigger request. Takes the *DeviceInformation.ID* of the device or sensor that the background task will access, and an optional app-specific string passed to the background task identifying which operation to perform.

The *DeviceInformation.ID* of the device or sensor that the background task will access. It must match the device or sensor that will perform the background operation. It is used by Windows to ensure that policy requirements are met. Optional value. A string specified by your app and passed to the background task, identifying which operation to perform. This method returns a DeviceTriggerResult when it completes asynchronously.

Represents an event that causes a background task to run when changes occur to the list of devices. Returned by GetBackgroundTrigger.

Represents a trigger that enables notification of changes to the email store.

Initializes a new instance of the EmailStoreNotificationTrigger class.

Represents a trigger that launches a background task when an incoming change notification is received for a Bluetooth LE GATT characteristic.

Initializes a new instance of the GattCharacteristicNotificationTrigger class.

The GATT characteristic for which value change notifications are desired.

Initializes a new instance of the **GattCharacteristicNotificationTrigger** class with the specified characteristic and triggering mode.

The GATT characteristic that you want value change notifications for. Specifies when the trigger is activated.

Gets the GATT characteristic for which value change notifications are desired.

The GATT characteristic for which value change notifications are desired.

Gets the mode for the trigger. The mode specifies when the trigger is activated.

The trigger mode.

Constructs a Generic Attributes (GATT) service that can be persisted in the background.

Gets the advertising parameters which control whether the radio is connected/discoverable.

Gets the service associated with this trigger.

The service.

Gets the trigger identifier.

The trigger ID.

Creates a GATT provider service.

The identifier for the trigger. The universally unique identifier for the trigger. Await the asynchronous operation to get the **GattServiceProviderTriggerResult**.

This class contains the trigger created by GattServiceProviderTrigger.CreateAsync().

Get the status of creating the trigger.

The error code.

Gets the Trigger created by GattServiceProviderTrigger.CreateAsync

The trigger.

Represents an event that triggers a Visits-related background task.

Initializes a new GeovisitTrigger instance.

Gets and sets the scope of Visits to monitor.

A VisitMonitoringScope value representing the scope of location monitoring.

Used to enforce the system condition object type.

Provides a method to perform the work of a background task.

Performs the work of a background task. The system calls this method when the associated background task has been triggered.

An interface to an instance of the background task. The system creates this instance when the task has been triggered to run.

Provides access to a background task instance.

Gets the instance ID of the background task instance.

A unique identifier for the background task instance. This identifier is generated by the system when the instance is created.

Gets or sets progress status for a background task instance.

A value defined by the application to indicate the task's progress.

Gets the number of times resource management policy caused the background task to be suspended.

The number of times the background task has been suspended.

Gets access to the registered background task for this background task instance.

An interface that provides access to the registered background task.

Gets additional information associated with a background task instance.

Represents additional information for the background task. If the background task is triggered by a mobile network operator notification, this property is an instance of a NetworkOperatorNotificationEventDetails class. If the background task is triggered by a system event or time event, this property is not used.

Attaches a cancellation event handler to the background task instance.

Informs the system that the background task might continue to perform work after the IBackgroundTask.Run method returns.

A background task deferral.

Provides access to a background task instance. Inherits from the IBackgroundTaskInstance interface and adds the GetThrottleCount method.

Retrieves the number of times the background task has been suspended for using too many resources.

Indicates the type of resource to include in the throttle count: network, CPU, or both. This method returns the number of times the background task has been suspended for exceeding its quota of the indicated resource type.

Provides access to a background task instance including information about the user.

Gets the user context for the background task. AppServiceConnection.User is used by the calling app to pass the user context. The app service can retrieve that user context with this property.

The user context.

Provides access to a registered background task.

Gets the name of a registered background task.

The description specified with BackgroundTaskBuilder.Name when the task was created.

Gets the identifier of a registered background task.

The unique identifier for the task. This identifier is generated by the system when the task is registered.

Attaches a completed event handler to the registered background task.

Attaches a progress event handler to the registered background task.

Unregisters a registered background task.

True if currently running instances of this background task should be canceled. If this parameter is false, currently running instances of this background task should be allowed to finish. Canceled instances receive a Canceled event with a BackgroundTaskCancellationReason of **Abort**.

Provides access to a registered background task. Inherits from the IBackgroundTaskRegistration interface and adds the Trigger property.

Gets the trigger associated with the background task.

The trigger associated with the background task.

Represents a background task that has been registered as part of a group of related background tasks.

Gets the BackgroundTaskRegistrationGroup that this **BackgroundTaskRegistration** is a part of.

The **BackgroundTaskRegistrationGroup** that this BackgroundTaskRegistration is a part of.

Represents the base interface for trigger events.

Represents a location event that triggers a background task. This is used for Geofencing.

Initializes a new instance of a location event trigger.

The type of location event for this trigger.

The type of location event for this trigger.

The type of location event for this trigger.

Indicates a type of location event for a location background task trigger.

Indicates a geofence location trigger.

Represents a maintenance trigger.

Initializes a new instance of a maintenance trigger.

The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. True if the maintenance trigger is used once; false if it is used each time the *freshnessTime* interval elapses.

Gets the interval of a maintenance trigger.

The number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after FreshnessTime elapses.

Gets whether the maintenance trigger is used only once or each time the FreshnessTime interval elapses.

True if the maintenance trigger is used once; false if it is used each time the FreshnessTime interval elapses.

Represents a trigger that launches a background task for performing media processing.

Initializes a new instance of the MediaProcessingTrigger class.

Triggers the background task and returns a MediaProcessingTriggerResult indicating success or failure of the trigger request.

An asynchronous operation that returns a MediaProcessingTriggerResult upon completion.

Triggers the background task with the provided collection of arguments and returns a MediaProcessingTriggerResult indicating success or failure of the trigger request.

A collection of arguments that will be passed to the media processing background task. An asynchronous operation that returns a MediaProcessingTriggerResult upon completion.

Specifies the result of a call to MediaProcessingTrigger.RequestAsync.

The media processing trigger request was successful.

The media processing background task is currently running.

The media processing trigger is disabled by policy on the device.

An unknown error occurred.

Represents a trigger that activates when the network sends SIM tool commands. Apps receiving this notification then process the SIM tool commands.

Constructs a MobileBroadbandDeviceServiceNotificationTrigger object.

Represents a cellular protocol configuration option change event that triggers a background task to run.

Creates an instance of a **MobileBroadbandPcoDataChangeTrigger**.

Represents a trigger that indicates when the SIM PIN lock state has changed.

Constructs a MobileBroadbandPinLockStateChangeTrigger object.

Represents a trigger that indicates when mobile broadband radio state has changed. For example, this trigger activates when a mobile device transitions to or from airplane mode.

Constructs a MobileBroadbandRadioStateChangeTrigger object.

Represents a trigger that indicates when mobile broadband registration state has changed. For example, this trigger activates when a mobile device transitions to or from Roaming.

Creates a MobileBroadbandRegistrationStateChangeTrigger object.

Represents a trigger that launches a background task when the local data counters estimate that usage (bytes sent and received) on the mobile broadband interface has changed by an actionable threshold.

Initializes a new instance of a mobile network operator data usage trigger.

Represents a mobile network operator hotspot authentication trigger.

Initializes a new instance of a mobile network operator hotspot authentication trigger.

Represents a mobile network operator notification trigger.

Initializes a new instance of a mobile network operator notification.

Specifies the unique identifier of the mobile broadband account.

Gets the account identifier for the mobile network operator notification trigger.

A unique identifier for the mobile broadband account.

This class represents a PaymentAppCanMakePayment trigger.

Creates a PaymentAppCanMakePaymentTrigger object.

Represents an object that invokes a background work item on the app in response to the receipt of a raw notification.

Invokes a background work item on the app in response to the receipt of a raw notification.

Invokes a background work item on a specified app in response to the receipt of a raw notification.

The package-relative application identifier (PRAID) of the app. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element.

Represents a trigger that launches a background task when a new Rich Communication Services (RCS) message is available.

Initializes a new instance of the RcsEndUserMessageAvailableTrigger class.

Represents a trigger that launches a background task when an RFCOMM inbound or outbound connections are established.

Initializes a new instance of the RfcommConnectionTrigger class.

Gets or sets whether the app wants to handle multiple connections at a time.

True if the app wants to handle multiple connections at a time; Otherwise False. The default is False.

Gets or sets the RfcommInboundConnectionInformation object that describes how the system will advertise and listen for inbound connections on behalf of the app.

The RfcommInboundConnectionInformation object that describes how the system will advertise and listen for inbound connections on behalf of the app. The default is null.

Gets or sets the RfcommOutboundConnectionInformation object that describes how the system will create outgoing connections on behalf of the app.

The RfcommOutboundConnectionInformation object that describes how the system will create outgoing connections on behalf of the app. The default is null.

Gets or sets the minimum protection level required for connections that are created or accepted on behalf of the app.

The minimum protection level required for connections that are created or accepted on behalf of the app. The default is BluetoothEncryptionWithAuthentication.

Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app.

Gets or sets specific remote Bluetooth device the system will connect to, or accept connections from, on behalf of the app. If this property is not set, the system will connect to and/or accept connections from any paired Bluetooth device that supports the relevant service.

Represents a trigger that launches a background task on behalf of a companion device.

SecondaryAuthenticationFactorAuthenticationTrigger is deprecated and might not work on all platforms. For more info, see MSDN.

Initializes a new instance of the SecondaryAuthenticationFactorAuthenticationTrigger class.

Represents a trigger that responds when a threshold limit for a sensor is crossed.

Initializes a new instance of the SensorDataThresholdTrigger class.

The threshold for a sensor that indicates when it should be triggered.

Represents a trigger that is raised when an SMS message has arrived.

Initializes a new instance of an SMS message received trigger.

Filter rules to be applied to incoming SMS messages. Only messages that pass through the filter rules raise the trigger.

Represents a trigger that launches a background task for handling socket activity.

Initializes a new instance of a socket activity trigger.

Gets whether a SocketActivityTrigger can wake the machine from a low power state.

**True** indicates that this trigger can wake the machine from a low power state; **false** otherwise.

Represents a file change within a StorageFolder that triggers a background task to run.

Initializes a new **StorageLibraryChangeTrackerTrigger** instance.

The change tracker for the **StorageLibrary** that you want to monitor for changes.

Creates a trigger that will fire when a file is changed in a specified library.

Creates a trigger that will fire when a file is changed in the specified library.

The location that the trigger monitors such as the music library or documents library. A trigger that monitors the specified location.

Creates a trigger that will fire when a file is changed in any of the specified libraries.

The list of libraries that the trigger will monitor. A trigger that monitors the specified location(s).

Represents a system condition that must be in effect for a background task to run.

Initializes a new instance of a system condition.

Specifies the condition type.

Gets the condition type of a system condition.

The condition that must be in effect for the background task to run.

Specifies a system condition that must be in effect for a background task to run. If a background task with a system condition is triggered, the task will not run until the condition is met.

Specifies that the background task can only run when the cost to do background work is low.

Specifies that the background task can only run when a free (non-metered) network connection is available.

Specifies that the background task can only run when the Internet is available. If a background task with the **InternetAvailable** condition is triggered, and the Internet is not available, the task will not run until the Internet is available again. This condition saves power because the background task won't execute until the network is available. This condition does not provide real-time activation.

Specifies that the background task can only run when the Internet is not available. If a background task with the **InternetNotAvailable** condition is triggered, and the Internet is available, the task will not run until the Internet is unavailable.

Not a valid condition type.

Specifies that the background task can only run when the user's session is connected. If a background task with the **SessionConnected** condition is triggered, and the user session is not logged in, the task will run when the user logs in.

Specifies that the background task can only run when the user's session is disconnected. If a background task with the **SessionDisconnected** condition is triggered, and the user is logged in, the task will run when the user disconnects the remote desktop session or does fast user switching> [!NOTE]

Specifies that background task can only run when the user is not present. If a background task with the **UserNotPresent** condition is triggered, and the user is present, the task will not run until the user becomes inactive.

Specifies that the background task can only run when the user is present. If a background task with the **UserPresent** condition is triggered, and the user is away, the task will not run until the user is present.

Represents a system event that triggers a background task to run.

Initializes a new instance of a system event trigger.

Specifies the system event type. True if the system event trigger will be used once; false if it will be used every time the event occurs.

Gets whether a system event trigger will be used only once.

True if the system event trigger will be used only once; false if it will be used every time the event occurs.

Gets the system event type of a system event trigger.

A system event type.

Specifies the system events that can be used to trigger a background task.

The background task is triggered when the cost of background work changes.

The background task is triggered when a control channel is reset.

The background task is triggered when the default sign-in account changes.

The background task is triggered when the Internet becomes available.

Not a valid trigger type.

The background task is triggered when a tile is added to the lock screen.

The background task is triggered when a tile is removed from the lock screen.

The background task is triggered when a network change occurs, such as a change in cost or connectivity.

The background task is triggered when the Microsoft account connected to the account changes.

The background task is triggered when the status of the battery, BatteryStatus, changes.

The background task is triggered when the system has finished updating an app.

The background task is triggered when the session is connected.

The background task is triggered when a new SMS message is received by an installed mobile broadband device.

The background task is triggered when the time zone changes on the device (for example, when the system adjusts the clock for daylight saving time).

The background task is triggered when the user becomes absent.

The background task is triggered when the user becomes present.

Represents a tethering event that triggers a background task to run.

Creates and initializes a new instance of a tethering event trigger.

Represents a time event that triggers a background task to run.

Initializes a new instance of a time event trigger.

Specifies the number of minutes to wait before scheduling the background task. The system schedules the task within 15 minutes after *freshnessTime* elapses. If the OneShot property is false, *freshnessTime* specifies the interval between recurring tasks. True if the time event trigger will be used once; false if it will be used each time *freshnessTime* elapses.

Gets the interval of a time event trigger.

Specifies the number of minutes to wait before scheduling the background task. The minimum value for **FreshnessTime** is 15 minutes. The system schedules the task within 15 minutes after **FreshnessTime** elapses.

Gets whether the time event trigger will be used only once or each time the FreshnessTime interval elapses.

True if the time event trigger will be used once; false if it will be used each time the FreshnessTime interval elapses.

Represents an event that causes a background task to run when the user performs an action on an interactive toast notification.

Creates and initializes a new instance of the ToastNotificationActionTrigger class.

Creates and initializes a new instance of the ToastNotificationActionTrigger class for the app with the specified identifier.

The identifier of the app for which you want to create an instance of the ToastNotificationActionTrigger class.

Represents an event that causes a background task to run when the history of toast notifications for the app is cleared, when one or more toast notifications are added to or removed from the notification history for the app, or when one or more toast notifications for the app expire and are removed from the notification history.

Creates and initializes a new instance of the ToastNotificationHistoryChangedTrigger class.

Creates and initializes a new instance of the ToastNotificationHistoryChangedTrigger class for the app with the specified identifier.

The identifier of the app for which you want to create an instance of the ToastNotificationHistoryChangedTrigger class.

Represents a trigger that fires when a UserNotification is added or removed.

Initializes a new instance of the **UserNotificationChangedTrigger** class.

The kind of notification trigger.

A collection of information about a phone call for the call history.

Creates a new PhoneCallHistoryEntry object.

Gets or sets the address book information for this phone call.

The address book information for the phone call.

Gets or sets the duration of the call.

The duration of the phone call.

Gets the unique identifier for this log entry.

The unique identifier for the PhoneCallHistoryEntry object.

Gets or sets a value determining whether the caller ID is blocked for this phone call.

Indicates whether the caller ID is blocked.

Gets or sets a value that determines whether the call is classified as an emergency.

Indicates whether the call is an emergency phone call.

Gets or sets whether a call is an incoming call.

**True** if the call was an incoming call, otherwise **false**.

Gets or sets whether a phone call was missed.

**True** if the phone call was missed, otherwise **false**.

Gets or sets whether a call is currently ringing.

**True** if the call is currently ringing, otherwise **false**.

Gets or sets a whether a phone call is seen.

**True** if the call is seen, otherwise **false**.

Gets or sets whether this entry is suppressed.

**True** if the entry is suppressed, otherwise **false**.

Gets or sets whether the phone call entry is a voicemail message.

**True** if the entry is a voicemail message, otherwise **false**.

Gets or sets the type of media associated with a call.

The media associated with a call.

Gets or sets the level of access provided to other applications.

The level of access that other applications have with respect to this PhoneCallHistoryEntry object.

Gets or sets the remote id for the entry.

The remote id for the PhoneCallHistoryEntry.

Gets the display name for the source of the phone call.

The display string for the source of the phone call.

Gets or sets the identifier for the source of the phone call.

The identifier for the source of the phone call.

Gets or sets a value that indicates what type of identifier the SourceId is.

The type of identifier that the PhoneCallHistoryEntry.SourceId is.

Gets or sets the start time for this history entry.

The time that this entry started.

Address book information for a contact used by PhoneCallHistoryEntry objects.

Creates a new empty PhoneCallHistoryEntryAddress object.

Creates a new PhoneCallHistoryEntryAddress object with an initial address.

The address to initiailize to the RawAddress property. The type of address represented by *rawAddress*.

Gets or sets the unique identifier for this contact.

The unique identifier for this address book entry.

Get or sets the display name for this entry.

The display name for this contact.

Gets or sets the address information for this contact.

The address information for this contact.

Gets or sets the type of address indicated by RawAddress.

The type of address.

The type of media associated with a call.

The call contains audio media.

The call contains video media.

The level of read access provided to other applications.

Other applications have full read access to this PhoneCallHistoryEntry object.

Other applications can only read system-level information.

A filter used to retrieve call entries based on the contained media.

All media types.

Audio media.

No associated media.

Video media.

Options for querying the phone call entries.

Creates a new PhoneCallHistoryEntryQueryOptions object.

Gets or sets the query filter based on the type of media.

The type of media that is included in the filter.

Get the query filter based on the source ID of the phone call entry.

The list of PhoneCallHistoryEntry.SourceId that are part of the filter.

The type of address used by the PhoneCallHistoryEntryAddress.

The raw address is a custom string.

The raw address is a phone number.

Enables the calling app to read through the phone call history entries.

Returns a list of the PhoneCallHistoryEntry objects.

An asynchronous operation that returns an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) upon successful completion.

Provides APIs for the application to get access to the PhoneCallHistoryStore.

Gets the PhoneCallHistoryManagerForUser object for a specific user which provides access to the PhoneCallHistoryStore for a specific user.

The user that you are interested in. The PhoneCallHistoryManagerForUser object that enables you to gain access to the PhoneCallHistoryStore object.

Requests the PhoneCallHistoryStore associated with the calling application.

The type of access requested for the PhoneCallHistoryStore object. An asynchronous operation that returns a PhoneCallHistoryStore object on successful completion.

Provides APIs for the application to get access to the PhoneCallHistoryStore for a specific user.

Gets the user of an app.

The user object that enables you to retrieve a PhoneCallHistoryStore for a specific user of an app.

Requests the PhoneCallHistoryStore associated with the associated user and the calling application.

The type of access requested for the PhoneCallHistoryStore object. An asynchronous operation that returns a PhoneCallHistoryStore object on successful completion.

The type of identifier that the PhoneCallHistoryEntry.SourceId refers to.

The identifier is for a cellular phone line.

The identifier is for a family package.

A collection of phone call history entries.

Deletes entries in the store.

The entries to delete.

Delete an entry from the store.

The entry to delete.

Gets an entry from the store based on the entry id.

The PhoneCallHistoryEntryt.Id of the relevant entry.

Retrieves a default phone call history entry that reads all entries.

A reader that can be used to go through the phone call log entries.

Retrieves an entry reader based on provided filters.

The options used to create a filtered entry reader. A reader that can be used to go through the phone call log entries.

Gets the number of unseen log entries for the provided sources.

The identifiers that need to match PhoneCallHistoryEntry.SourceId in order for that entry to be considered. The total number of unseen entries matching all of the identifiers provided by *sourceIds*.

Gets the number of unseen entries.

The number of unseen entries.

Update all the entries to indicate they have all been seen by the user.

Updates entries to indicate they have been seen by the user.

The entries to mark as seen. This updates the PhoneCallHistoryEntry.IsSeen property.

Updates an entry to indicate it has been seen.

The entry to update.

Marks all entries from the specified sources as seen.

The list of source identifiers to mark as seen. Only entries that match PhoneCallHistoryEntry.SourceId will be updated.

Saves an entry to the store.

The entry to save.

The type of store you want to retrieve.

All of the entries should have limited read and write permissions.

All the entries should have full read and write permissions.

Only entries created by this application should have read and write permissions.

Represents the Rich Communication Services (RCS) chat capabilities of a phone number.

Gets a Boolean value indicating whether a phone number supports Rich Communication Services (RCS) chat.

A Boolean value indicating whether the app supports chat.

Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer.

A Boolean value indicating if a phone number supports Rich Communication Services (RCS) file transfer.

Gets a Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation.

A Boolean value indicating if a phone number is capable of pushing Rich Communication Services (RCS) geolocation.

Gets a Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging.

A Boolean value indicating if a phone number supports Rich Communication Services (RCS) integrated messaging.

Gets a Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online.

A Boolean value indicating if an Rich Communication Services (RCS) capable phone number is online.

Provides functionality for getting chat capabilities.

Asynchronously gets the locally cached Rich Communication Services (RCS) chat capabilities for the specified phone number.

The phone number for which to get the Rich Communication Services (RCS) chat capabilities The locally cached Rich Communication Services (RCS) chat capabilities.

Asynchronously gets the locally cached Rich Communication Services (RCS) chat capabilities for the specified phone number through the specified RcsTransport TransportId.

The phone number for which to get the Rich Communication Services (RCS) chat capabilities The specific transport ID to use to get the Rich Communication Services (RCS) chat capabilities The locally cached Rich Communication Services (RCS) chat capabilities.

Asynchronously gets the Rich Communication Services (RCS) chat capabilities for the specified phone number from the service provider.

The phone number for which to get the Rich Communication Services (RCS) chat capabilities. The Rich Communication Services (RCS) chat capabilities from the service provider.

Asynchronously gets the Rich Communication Services (RCS) chat capabilities for the specified phone number through the specified RcsTransport TransportId from the service provider.

The phone number for which to get the Rich Communication Services (RCS) chat capabilities. The specific transport ID to use to get the Rich Communication Services (RCS) chat capabilities. The Rich Communication Services (RCS) chat capabilities from the service provider.

Represents a conversation in a chat client.

Gets or sets a boolean that indicates whether participants can be modified or not.

A boolean that indicates whether participants can be modified or not.

Gets a Boolean value indicating if there are unread messages in the ChatConversation.

A Boolean value indicating if there are unread messages in the ChatConversation.

Gets the unique identifier for the ChatConversation.

The unique identifier for the ChatConversation.

Gets or sets a Boolean value indicating if the ChatConversation is muted.

A Boolean value indicating if the ChatConversation is muted.

Gets the item kind.

The item kind.

Gets the ID of the most recent message in the conversation.

The ID of the most recent message in the conversation.

Gets a list of all the participants in the conversation.

A list of all the participants in the conversation.

Gets or sets the subject of a group conversation.

The subject of a group conversation.

Gets the threading info for the ChatConversation.

The threading info for the ChatConversation.

Occurs when the remote user has started or finished typing.

Asynchronously deletes all of the messages in the ChatConversation and the conversation itself.

An async action that indicates when the delete has completed.

Gets the ChatMessageReader for this ChatConversation.

The ChatMessageReader for this ChatConversation.

Asynchronously marks all the messages in the conversation as read.

An async action indicating that the operation has completed.

Asynchronously marks all the messages in the conversation before the specified DateTime as read.

Mark all messages before this DateTime as read. An async action indicating that the operation has completed.

Call this to indicate that the local participant has started or has completed typing.

Specifies the ChatMessageTransport to use. The address of the remote participant. TRUE if the local participant is typing, otherwise FALSE.

Locally triggers the event that indicates that a remote participant is typing.

Specifies the ChatMessageTransport to use. The address of the remote participant. TRUE if the remote participant is typing, otherwise FALSE.

Asynchronously saves the ChatConversation.

An async action indicating that the operation has completed.

Provides functionality for reading batches of conversations from the ChatMessageStore.

Asynchronously reads batches of conversations from the ChatMessageStore.

The list of conversations.

Asynchronously reads batches of conversations from the ChatMessageStore.

Specifies the size of the batch to read. The list of conversations.

Provides threading info for a ChatConversation.

Initializes a new instance of the ChatConversationThreadingInfo class.

Gets or sets the Contact.Id for the remote participant.

The Contact.Id for the remote participant.

Gets or sets the ID of the ChatConversation.

The ID of the ChatConversation.

Gets or sets a string where you can store your own custom threading info.

A string where you can store your own custom threading info.

Gets or sets a value that indicates the type of threading info, such as participant, contact ID, conversation ID, and so on.

A value that indicates the type of threading info.

Gets the list of participants in the ChatConversation.

The list of participants in the ChatConversation.

Specifies how a conversation is threaded.

By contact ID

By conversation ID

Custom threading defined by the app

By participants

Specifies the type of a chat item.

A conversation

A message

Represents a chat message.

Creates a new instance of the ChatMessage class.

Gets a list of chat message attachments.

A list of chat message attachments.

Gets or sets the body of the chat message.

The body of the chat message.

Gets or sets the estimated size of a file to be sent or received.

The estimated size of a file to be sent or received.

Gets the identifier or address of the sender of the message.

The sender of the message.

Gets the identifier of the message.

The ID of the chat message.

Gets or sets a Boolean value indicating if the message is an auto-reply.

A Boolean value indicating if the message is an auto-reply.

Gets a Boolean value indicating if forwarding is disabled.

A Boolean value indicating if forwarding is disabled.

Gets Boolean a value indicating if the message is incoming or outgoing.

A Boolean value indicating if the message is incoming or outgoing. TRUE indicates incoming, FALSE indicates outgoing.

Gets a Boolean value indicating if the message has been read.

A Boolean value indicating if the message has been read.

Gets or sets a Boolean value indicating if the message was received during user specified quiet hours.

A Boolean value indicating if the message was received during user specified quiet hours.

Gets a Boolean value indicating if reply is disabled on the ChatMessage.

A Boolean value indicating if reply is disabled on the ChatMessage.

Gets or sets a Boolean value indicating if the message has been seen.

A Boolean value indicating if the message has been seen.

Gets a Boolean value indicating if the message is stored on a SIM card.

A Boolean value indicating if the message is stored on a SIM card.

Gets the item kind.

The item kind.

Gets the local timestamp of the message.

The local timestamp of the message.

Gets or sets the type of the ChatMessage.

The type of message.

Gets or sets a value indicating the type of message operator, such as SMS, MMS, or RCS.

The type of message operator.

Gets the network timestamp of the message.

The network timestamp of the message.

Gets the list of recipients of the message.

The list of recipients of the message.

Gets the delivery info for each of the recipients of the ChatMessage.

The delivery info for the recipients of the ChatMessage.

Gets the list of send statuses for the message.

The recipient send statuses.

Gets or sets the remote ID for the ChatMessage.

The remote ID for the ChatMessage.

Gets or sets a Boolean value indicating if notification of receiving the ChatMessage should be suppressed.

A Boolean value indicating if notification of receiving the ChatMessage should be suppressed.

Gets the status of the message. Typical states include draft, sent, received, deleted, etc.

The status of the message.

Gets the subject of the message.

The subject of the message.

The ID used to identify a message across devices. This ID is generated on creation for all messages. Clients that copy messages between devices also need to copy this ID in order to uniquely identify the same message on different devices

Gets and sets the sync ID.

Gets or sets the conversation threading info for the ChatMessage.

The conversation threading info for the ChatMessage.

Gets the transport friendly name of the message.

The transport friendly name of the message.

Gets or sets the transport ID of the message.

The transport ID of the message.

Represents an attachment to a chat message.

Initializes a new instance of the ChatMessageAttachment class.

The MIME type of the attachment. A stream containing the attachment data.

Gets or sets a stream reference for a message attachment.

The data stream for the attachment.

Gets or sets the identifier for the attachment group to which this attachment belongs.

The group ID of the attachment.

Gets or sets the MIME type of the attachment.

The MIME type of the attachment.

Gets or sets the original file name of the attachment.

The original file name of the attachment.

Gets or sets the text encoded representation of the attachment object.

The text of the attachment.

Gets or sets the thumbnail image for the attachment.

The thumbnail image for the attachment.

Gets or sets the progress of transferring the attachment.

The progress of transferring the attachment.

Provides functionality for blocking messages.

Asynchronously marks a message as blocked or unblocked.

The ID of the message to block. TRUE if the message should be blocked, FALSE if it should be unblocked. An async action indicating that the operation has completed.

Represents a revision to a chat message.

Gets the type of change made to a chat message, such as created, modified, etc.

The type of change represented by the object.

Gets the updated message text.

The chat message associated with the change.

Represents a deferred asynchronous change request.

Fires to indicate that the deferred change request has completed.

Represents event parameters used by the event handler that processes message change events.

The message changed event handler that an application registers with the message store receives a deferral object in the event parameters. The GetDeferral method registers a change deferral and allows an application to take action related to the change before the message store completes the change.

Gets a deferral for the MessageChanged event.

Provides methods for reading and accepting message change revisions.

Accepts all the changes up to and including the latest change to the message.

Accepts all the changes up to and including a specified change.

The last change to acknowledge.

Returns a batch list of chat message change objects from the message store’s change tracker.

An asynchronous operation that returns a list of changes.

Provides methods to enable and retrieve message change revisions.

Enables change tracking for the messages in the message store.

Returns a ChatMessageChangeReader class object which provides a collection of message revisions from the message store.

The change reader associated with the change tracker.

Resets change tracking for the messages in the message store. The first revision begins with the next message change.

Specifies the type of change made to a chat message.

Change tracking lost.

Message created.

Message deleted.

Message modified.

Specifies the type of chat message.

A file transfer request

A conversation the user joined

A conversation the user left

A conversation that another user joined

A conversation that another user left

A standard chat message

A non-SMS/MMS message written to the device by the app

Provides access to message transports and the message store. Also provides a method to display the UI to compose messages.

Asynchronously gets theChatMessageTransport.

The locally unique identifier for the message transport. The message transport.

Asynchronously gets the chat message transports available on the device.

An asynchronous operation that returns a list of transports on successful completion.

Asynchronously registers the app as a ChatMessageTransport in order to post messages to the ChatMessageStore.

The transport ID for the newly registered ChatMessageTransport.

Returns the SMS messaging store for the phone.

An asynchronous operation that returns a ChatMessageStore on successful completion.

Gets the ChatSyncManager instance.

When the asynchronous operation completes, a ChatSyncManager object is returned.

Shows the compose SMS dialog, pre-populated with data from the supplied ChatMessage object, allowing the user to send an SMS message.

The chat message. An asynchronous action.

Launches the device's SMS settings app.

Represents the message notification triggered from a registered background task. A chat app can receive notifications of incoming messages or send events by setting a task trigger and task entry point.

Gets the message associated with the notification. This is either an incoming message or an outgoing message with a send status event.

The chat message associated with the trigger.

Gets a Boolean value indicating if the background task should issue a toast notification for the message.

A Boolean value indicating if the background task should issue a toast notification for the message.

Gets a Boolean value indicating if the Windows Action Center should be updated with the message.

A Boolean value indicating if the Windows Action Center should be updated.

Gets a Boolean value indicating if the background task should update the app’s lock screen count.

A Boolean value indicating if the background task should update the app’s lock screen count.

Gets a Boolean value indicating that the background task should update the app's tile count for the message.

A Boolean value indicating that the background task should update the app's tile count for the message.

Specifies the message operator type.

MMS message

Rich Communication Services (RCS) message

SMS message

The value hasn't been set.

Provides methods for reading messages from the message store.

Returns a batch list of chat messages from the message store.

An asynchronous operation that returns a list of chat messages upon successful completion.

Returns a batch list of chat messages from the message store limited to the specified size.

The size of the batch to read. An asynchronous operation that returns a list of chat messages upon successful completion.

Specifies the current status of a chat message such as draft, sent, or received.

Cancelled

Declined

Deleted

Draft

Recalled

Received

Receive download failed

Receive downloading

Received download needed

Receive retry needed

Send failed

Sending

Send retry needed

Sent

Provides the methods and properties to read, manage and send messages. An application gets access to the message store using the static ChatMessageManager class.

Gets a ChatMessageChangeTracker class object for the message store. A message change tracker allows an application to monitor changes to messages in the message store.

The chat message change tracker for the store.

An event that occurs when a message in the message store is changed.

Occurs when something in the ChatMessageStore has changed.

Deletes a message from the chat message store.

The local ID of the message to be deleted. An asynchronous action.

Downloads a message specified by the identifier to the message store.

The local ID of the message to be downloaded. An asynchronous action.

Asynchronously forwards the specified message to new recipients.

The ID of the message to forward. The addresses of the new recipients of the forwarded message. A copy of the forwarded message.

Asynchronously gets a ChatConversation by ID.

The ID of the conversation to retrieve. The ChatConversation specified by the *conversationId* parameter.

Asynchronously gets a ChatConversation by ID using the specified transports.

The ID of the conversation to retrieve. The IDs of the transports to use to retrieve the ChatConversation. The ChatConversation specified by the *conversationId* parameter.

Asynchronously gets a conversation based on a threading info object.

The threading info that identifies the conversation. The conversation identified by the *threadingInfo* parameter.

Gets a new or existing ChatConversationReader for the message store.

The new or existing ChatConversationReader.

Gets a new or existing ChatConversationReader for the message store using the specified transports.

The IDs for the transports to use to retrieve the ChatConversationReader. The new or existing ChatConversationReader.

Retrieves a message specified by an identifier from the message store.

The local ID of the chat message to be retrieved. An asynchronous operation that returns a chat message upon successful completion.

Gets a message by its remote ID.

The TransportId to use to get the ChatMessage. The RemoteId of the ChatMessage to retrieve. The message.

Gets a message by the sync ID.

The sync ID of the message. When the asynchronous operation completes, a ChatMessage object is returned.

Gets a ChatMessageReader class object which provides a message collection from the message store.

The chat message reader.

Gets a ChatMessageReader class object which provides a message collection from the message store. The collection of messages is limited to the time span provided.

The time window for the retrieved reader. The chat message reader.

Gets a new or existing ChatSearchReader to be used to search for messages.

The query options that the search reader will use when looking for matching messages. The new or existing search reader.

Asynchronously gets the number of unread chat messages.

The number of unread chat messages.

Asynchronously gets the number of unread chat messages using the specified transports.

The IDs of the chat transports to use to get the unseen messages count. The number of unread chat messages.

Asynchronously marks all transport messages as seen.

An async action indicating that the operation has finished.

Asynchronously marks all transport messages as seen.

The IDs of the transports for which to mark all messages as seen. An async action indicating that the operation has finished.

Marks a specified message in the store as already read.

The local ID of the message to be marked as read. An asynchronous action.

Attempts a retry of sending a specified message from the message store.

The local ID of the message to be retried. An asynchronous action.

Asynchronously saves a message to the ChatMessageStore.

The message to save. An async action indicating that the operation has finished.

Attempts to send a chat message. The message is saved to the message store as part of the send operation.

The chat message to be sent. An asynchronous action.

Asynchronously attempts to cancel downloading the specified message.

The ID of the message to stop downloading. An async action indicating that the operation has completed.

Asynchronously attempts to cancel sending the specified message.

The ID of the message to stop sending. An async action indicating that the operation has completed.

Checks if a chat message is valid and returns the validation result.

The chat message to validate. The validation result.

Provides the data for the ChatMessageStoreChanged event.

Gets the ID of the object that changed.

The ID of the object that changed.

Gets the type of change that happened.

The type of change that happened.

Represents the identity of a transport for sending and receiving messages. Physically, a chat message transport is a SIM slot on the phone.

Gets the configuration of the message transport.

The configuration of the message transport.

Gets a Boolean value that indicates whether the messaging transport is active.

A value indicating if the transport is active.

Gets a Boolean value that indicates whether the current application is set as the messaging notification provider.

A value indicating if the app is set as a notification provider.

Gets a descriptive name identifying the messaging transport.

The friendly name for the transport.

Gets the messaging transport’s identifier.

The ID of the transport.

Gets the type of the message transport.

The type of the message transport.

Sets the current application to handle messaging notifications.

An asynchronous action.

Represents data about the chat message transport.

Gets the extended properties of the transport.

The extended properties of the transport.

Gets the maximum attachment limit for a message on the transport.

The maximum attachment limit for a message.

Gets the maximum size of an attachment for the transport.

The maximum size of an attachment.

Gets the maximum number of recipients for the transport.

The maximum number of recipients.

Gets the supported video encoding format for the transport.

The supported video encoding format for the transport.

Specifies the type of the message transport.

Intercepted by the filtering app and marked as blocked

Custom message

Text message

Untriaged message

Provides results for validation of chat messages.

Gets the maximum number of text fragments allowed for a message. This value has meaning when the SMS text portion of a message is validated.

The maximum number of parts.

Gets the total number of text fragments needed for this message. This value has meaning when the SMS text portion of a message is validated.

The number of parts.

Gets the number of characters not used in the final message fragments. This value has meaning when the SMS text portion of a message is validated.

The remaining characters in the part.

Gets the message validation status code.

The status of the validation.

Specifies the validation state of a chat message such as valid, no recipients, or too many attachments.

Data roaming restriction

Invalid body

Invalid data

Invalid other

Invalid recipients

Message too large

No recipients

Too many attachments

Too many recipients

Transport inactive

Transport not found

Valid

Valid with large message

Voice roaming restriction

Represents the criteria for finding chat messages.

Initializes a new instance of the ChatQueryOptions class.

Gets or sets the string to search for the in ChatMessageStore.

The string to search for the in ChatMessageStore.

Represent the delivery info about a chat recipient.

Initializes a new instance of the ChatRecipientDeliveryInfo class.

Gets or sets the time the message was sent to the recipient.

The time the message was sent to the recipient.

Gets a Boolean value indicating whether the error for the message that was sent to the recipient is permanent.

A Boolean value indicating whether the error for the message that was sent to the recipient is permanent.

Gets or sets the time the recipient read the message.

The time the recipient read the message.

Gets the status of the message.

The status of the message.

Gets or sets the transport address of the recipient.

The transport address of the recipient.

Get the transport error code.

The transport error code.

Gets the category for the TransportErrorCode.

The category for the TransportErrorCode.

Gets the interpreted error code for the transport.

The interpreted error code for the transport.

Indicates the chat restore history span.

All messages will be restored.

Only messages from last month will be restored.

Only messages from last year will be restored.

Provides functionality to search for chat messages in the ChatMessageStore.

Returns a batch of found items matching the search criteria.

A list of items matching the search criteria.

Returns a batch of found items matching the search criteria.

The maximum number of items to return. A list of items matching the search criteria.

Specifies the type of change that occurred for a ChatMessageStoreChanged event.

A chat conversation has been deleted

A chat conversation has been modified

A chat conversation has been deleted of all messages from a transport.

A chat message has been created

A chat message has been deleted

A chat message has been changed

Notifications have been missed

The chat store has been modified

The chat messages sync configurations.

Gets or sets a boolean that indicates whether sync is enabled.

The boolean that indicates whether sync is enabled.

Gets or sets the time span for which messages will be restored.

The time span for which messages will be restored.

Manages the syncing of chat messages.

The configuration properties of the sync manager.

Gets the configuration properties of the sync manager.

Sets the WebAccount, which will be used by the sync manager to sync messages.

The web account. An asynchronous action that doesn't return anything.

Checks if a specific WebAccount is the account used by the sync manager to sync messages.

The web account. True if the WebAccount is the account used by the sync manager to sync message, false otherwise.

Sets the configuration properties of the sync manager.

The configuration. An asynchronous action that doesn't return anything.

Starts a new sync operation without waiting for the sync to finish.

Clears the account information and stops the sync manager from syncing messages. This will trigger a message deletion operation.

An asynchronous action that doesn't return anything.

Specifies the category of a transport error.

An HTTP error

An MMS server error

Can't connect to the network

No specific category for the error code

Specifies an interpretation for the error code.

An invalid recipient address

A network connectivity error

There was no error.

A service denied error

A timeout error

There is no interpretation for the error code.

Represents a chat item.

Gets the type of the chat item, such as message or conversation.

The type of the chat item.

Represents a Rich Communication Services (RCS) end user message.

Gets the actions to which the user can respond.

The actions to which the user can respond.

Gets a Boolean value that specifies whether a PIN is required to be sent back with the response.

A Boolean value that specifies whether a PIN is required to be sent back with the response.

Gets the contents of the message.

The contents of the message.

Gets the title of the message.

The title of the message.

Gets the ID of the transport where this message originated.

The ID of the transport where this message originated.

Asynchronously sends the user's selection back.

Specifies the label of the action. An async action indicating that the operation has completed.

Asynchronously sends the user's selection back with the specified PIN.

Specifies the label of the action. The PIN to send. An async action indicating that the operation has completed.

Represents the actions to which the user can respond.

Gets the label of the action.

The label of the action.

Provides the data for a MessageAvailableChanged event.

Gets a Boolean value indicating if a new message is available.

A Boolean value indicating if a new message is available.

Gets the actual message to display, or empty if IsMessageAvailable is FALSE.

The actual message to display.

Provides data to the background task about a new message.

Gets the text of the new message.

The text of the new message.

Gets the title of the new message.

The title of the new message.

Provides functionality for handling message events.

Occurs when a new message is available.

Provides access to APIs for handling Rich Communication Services (RCS) messages.

Occurs when one or more RcsTransport instances are added or removed from the list of RcsTransport instances that would be returned from RcsManager.GetTransportsAsync.

Gets the RcsEndUserMessageManager.

The end user message manager.

Gets an instance of RcsTransport for the specified transport ID.

The ID of the transport to retrieve. An instance of the transport specified by the *transportId* parameter.

Gets all instances of RcsTransport.

A list of RcsTransport instances.

Asynchronously allows a user to leave a particular conversation.

The conversation to leave. An async action indicating that the operation has completed.

Specifies the type of the Rich Communication Services (RCS) service.

Capability service

Chat service

File transfer service

Group chat service

Provides data for the ServiceKindSupportedChanged event.

Gets the type of the Rich Communication Services (RCS) service.

The type of the Rich Communication Services (RCS) service.

Provides functionality for accessing the Rich Communication Services (RCS) transport.

Gets a configuration object that describes the transport settings.

A configuration object that describes the transport settings.

Gets a name-value pair for extensibility of service provider configuration values.

A name-value pair for extensibility of service provider configuration values.

Gets a Boolean value indicating if the transport is active.

A Boolean value indicating if the transport is active.

Gets the friendly name of the transport.

The friendly name of the transport.

Gets the ID for the transport that is unique on the device.

The ID for the transport that is unique on the device.

Occurs when the service capabilities change.

Gets a Boolean value indicating if the specified service kind is supported, such as chat, group chat, file transfer, and so on.

The service kind to verify. TRUE if the RcsServiceKind specified in the *serviceKind* parameter is supported.

Gets a Boolean value indicating if the specified service kind supports store and forward functionality.

The service kind to check for store and forward functionality. A Boolean value indicating if the *serviceKind * supports store and forward.

Provides data about the configuration of a Rich Communication Services (RCS) transport.

Gets the maximum number of attachments supported by the transport.

The maximum number of attachments supported by the transport.

Gets the maximum size of a file that can be sent using the transport.

The maximum size of a file that can be sent using the transport.

Gets the maximum size of a group chat message supported by the transport.

The maximum size of a group chat message supported by the transport.

Gets the maximum size of a chat message supported by the transport.

The maximum size of a chat message supported by the transport.

Gets the maximum number of recipients supported for a group chat.

The maximum number of recipients supported for a group chat.

Gets the size at which the user should be warned that they are attaching a large file for the transport.

The size at which the user should be warned that they are attaching a large file for the transport.

Provides data to the RemoteParticipantComposingChanged event.

Gets a Boolean value indicating if the remote participant is currently composing a message.

A Boolean value indicating if the remote participant is currently composing a message.

Gets the address of the remote chat participant.

The address of the remote chat participant.

Gets the ID for the message transport.

The ID for the transport.

Provides functionality for linking individual (raw) contacts across services together into a single aggregate contact.

Returns the list of individual (raw) contacts from the specified aggregate contact.

The aggregate contact from which to extract the list of raw contacts. The list of individual (raw) contacts from the specified aggregate contact.

Sets the identifier that specifies the remote contacts to link together with the contact data on your device.

The remote contact list identifier. The identifier for the remote service, for example, “EXCH” for exchange accounts. The unique roaming identifier of the account for the network. The IAsyncAction to await.

Asynchronously attempts to link contacts together to make an aggregate contact.

The first contact to link. The second contact to link to the *primaryContact*. The newly created aggregate contact.

Chooses which of the raw contacts provides the main display picture for the aggregate.

The aggregate contact on which to set the picture. The raw contact that provides the picture for the aggregate. True if successful, otherwise false.

Asynchronously unlinks a raw contact from the parent aggregate contact.

The raw contact to remove from the aggregate. An async action that indicates the operation is complete.

Represents a contact.

Creates a new instance of the Contact class.

Gets the contact addresses for a contact.

An array of contact addresses for a contact.

If this is a raw contact that is part of an aggregate contact, then this property identifies the parent aggregate.

String value that identifies the parent aggregate contact.

Gets the connected service accounts for a contact.

An array of connected service accounts for a contact.

Gets a string that identifies the ContactList to which this contact is a member.

A string that identifies the ContactList to which this contact is a member.

Gets the data suppliers for a contact. The maximum string length for each data supplier is 50 characters.

An array of data suppliers for a contact.

Gets the display name for a contact.

The display name for a contact.

Gets or sets the display that was manually entered by the user.

The display that was manually entered by the user.

Gets or sets the last time the user updated their display picture.

The last time the user updated their display picture.

Gets the email addresses for a contact.

An array of email addresses for a contact.

Sets the fields that contain information about a contact.

An array of fields containing information about a contact.

Gets and sets the first name for a contact. The maximum string length for the first name is 64 characters.

The first name for a contact.

Gets the full name of the Contact.

The full name of the Contact.

Gets and sets the honorific prefix for the name for a contact. The maximum string length for the honorific prefix is 32 characters.

The honorific prefix for the name for a contact.

Gets and sets the honorific suffix for the name for a contact. The maximum string length for the honorific suffix is 32 characters.

The honorific suffix for the name for a contact.

Gets and sets the identifier for a contact. The maximum string length for the identifier is 256 characters.

The identifier for a contact.

Gets the important dates for a contact.

An array of important dates for a contact.

Gets a Boolean value indicating of this is an aggregate Contact.

Boolean value indicating of this is an aggregate Contact.

Gets a Boolean value indicating if the user manually set the picture for the Contact.

True if the user manually set the picture, false if this is an aggregate contact and the picture was chosen from one of the raw child contacts.

Gets a Boolean value indicating if this Contact represents the user logged into the device.

Boolean value indicating if this Contact represents the user logged into the device.

Gets the job info items for a contact.

An array of job info items for a contact.

Gets a large version of the display picture for the Contact.

A large version of the display picture for the Contact.

Gets and sets the last name for a contact. The maximum string length for the last name is 64 characters.

The last name for a contact.

Gets and sets the middle name for a contact. The maximum string length for the middle name is 64 characters.

The middle name for a contact.

Sets and gets the name of the contact.

The name of the contact.

Gets or sets the nickname for the Contact.

The nickname for the Contact.

Gets and sets notes for a contact. The maximum string length for notes is 4096 characters.

A string that contains notes for a contact.

Gets info about the phones for a contact.

An array of items that describe the phones for a contact.

Gets the property set object for the contact.

The IPropertySet interface for the property set object for the contact.

Gets or sets an ID that can be used by a service provider to access the Contact in their remote system.

An ID that can be used by a service provider to access the Contact in their remote system.

Gets or puts the path to the ringtone file for the Contact.

The path to the ringtone file for the Contact.

Gets the significant others for a contact.

An array of significant others for a contact.

Gets a small version of the display picture for the Contact.

A small version of the display picture for the Contact.

Gets the name used to sort the contact.

The name used to sort the contact.

Gets or sets the display picture for the Contact in its original size.

The display picture for the Contact in its original size.

Gets or puts the path to the audio file to play when an SMS/MMS message is received from the Contact.

The path to the audio file to play when an SMS/MMS message is received from the Contact.

Gets or sets a thumbnail image that represents this contact.

The thumbnail image for the contact.

Gets the Web sites for a contact.

An array of Web sites for a contact.

Gets the Yomi (phonetic Japanese equivalent) display name for a contact.

The Yomi display name for a contact.

Gets the Yomi (phonetic Japanese equivalent) family name for a contact. The maximum string length for the Yomi family name is 120 characters.

The Yomi family name for a contact.

Gets the Yomi (phonetic Japanese equivalent) given name for a contact. The maximum string length for the Yomi given name is 120 characters.

The Yomi given name for a contact.

Represents the address of a contact.

Initializes a new instance of a ContactAddress class.

Gets and sets the country of a contact address. The maximum string length for the country is 1024 characters.

The country of a contact address.

Gets and sets the description of a contact address. The maximum string length for the description is 512 characters.

The description of a contact address.

Gets and sets the kind of contact address.

A ContactAddressKind -typed value that indicates the type of contact address.

Gets and sets the locality of a contact address. The maximum string length for the locality is 1024 characters.

The locality of a contact address.

Gets and sets the postal code of a contact address. The maximum string length for the postal code is 1024 characters.

The postal code of a contact address.

Gets and sets the region of a contact address. The maximum string length for the region is 1024 characters.

The region of a contact address.

Gets and sets the street address of a contact address. The maximum string length for the street address is 1024 characters.

The street address of a contact address.

Specifies the kinds of contact addresses.

The home address of the contact.

An address of the contact other than home or work.

The work address of the contact.

Provides a way to tag existing user contacts with additional information, specifying that your app can perform some SupportedOperations for this particular contact.

Initializes a new instance of the ContactAnnotation class.

Gets the ID for the parent ContactAnnotationList that this ContactAnnotation is contained within.

The ID for the parent ContactAnnotationList that this ContactAnnotation is contained within.

Gets or set the ID for the Contact to which this ContactAnnotation applies.

The ID for the Contact to which this ContactAnnotation applies.

Gets or sets the ContactList to which this ContactAnnotation applies.

The ID for the ContactList to which this ContactAnnotation applies.

Gets the ID for this ContactAnnotation.

The ID for this ContactAnnotation.

Gets a Boolean value indicating if this ContactAnnotation has been disabled by the user.

Boolean value indicating if this ContactAnnotation has been disabled by the user.

Provides a place to store data to be used by the app when interacting with a service provider.

Data to be used by the app when interacting with a service provider.

Gets or sets an ID that can be used by a service provider to access the corresponding entity in their remote system.

An ID that can be used by a service provider to access the corresponding entity in their remote system.

Gets or sets the group of ContactAnnotationOperations supported by this ContactAnnotation.

The group of ContactAnnotationOperations supported by this ContactAnnotation.

Represents a list of ContactAnnotation objects.

Gets the ID for this ContactAnnotationList.

The ID for this ContactAnnotationList.

Gets the unique identifier for the app package that created the ContactAnnotationList.

The unique identifier for the app package that created the ContactAnnotationList.

Gets the ID for the UserDataAccount used by the app.

The ID for the UserDataAccount used by the app.

Asynchronously deletes the specified ContactAnnotation from the list.

The annotation to delete from the list. An async action indicating that the operation has completed.

Asynchronously deletes this ContactAnnotationList from the ContactAnnotationStore.

An async action indicating that the operation has completed.

Asynchronously gets the list of ContactAnnotation objects.

The list of ContactAnnotation objects.

Gets the list of ContactAnnotation objects containing the specified remote ID property.

The remote ID used to find the ContactAnnotation objects. The list of ContactAnnotation objects containing the specified remote ID property.

Gets the ContactAnnotation with the specified Id.

The ContactAnnotation.Id used to identify the ContactAnnotation. The ContactAnnotation with the specified ID.

Asynchronously attempts to save the ContactAnnotation to the ContactAnnotationList.

The annotation to save to the list. True if the save was successful, otherwise false.

Specifies the types of operations you can perform with a Contact.

Make and audio call.

Get the contact profile.

Send an SMS/MMS message.

None

Share the contact.

Access social media feeds.

Make a video call.

Represents a data store that contains contact annotations.

Asynchronously creates a ContactAnnotationList.

The newly created ContactAnnotationList.

Asynchronously creates a ContactAnnotationList and associates it with the specified user data account ID.

The ID for the user data account with which to associate the new ContactAnnotationList. The user data account must be owned by this app. The newly created ContactAnnotationList.

Asynchronously disables the specified ContactAnnotation, usually as a result of user input.

The annotation to disable. An async action indicating that the operation has completed.

Asynchronously gets the list of ContactAnnotationList objects for the app.

The list of ContactAnnotationList objects.

Get the annotations for the specified Contact.

The Contact for which to retrieve annotations. The list of ContactAnnotation objects.

Gets the annotations for the specified ContactList.

The ID of the ContactList for which to retrieve annotations. The list of ContactAnnotation objects.

Gets a list of Id values based on Contact objects with a specified email address.

The email address used to find the contact Id values. The list of Contact objects containing the specified *emailAddress*.

Gets a list of Id values based on Contact objects with a specified phone number.

The phone number used to find the contact Id values. The list of Contact objects containing the specified *phoneNumber*.

Asynchronously gets the ContactAnnotationList with the specified ID.

The ID of the ContactAnnotationList to get. The ContactAnnotationList with the ID specified in *annotationListId*.

Specifies if the app can read and write all annotations or only those belonging to the app itself.

All contact annotations.

Only local app contact annotations.

Represents a group of Contact objects and server search status.

Gets the list of Contact objects returned by a search operation.

The list of contacts returned by a search operation.

Gets a ContactBatchStatus value that indicates if a search was successful or if there was a server error.

A ContactBatchStatus value that indicates if a search was successful or if there was a server error.

Specifies if the last batch access operation was successful or if there was a server error.

There was a server error.

There was an unknown error.

Success

Represents a delayed data loader for a contact card.

Closes the delayed data loader. This informs the contact card to complete the UI (for example, remove any progress indications, like the progress bar) because no more updates to the contact card UI will be requested. The user then can determine that the contact data shown in the UI is complete.

Updates the contact card with the Contact object and completes the contact card UI.

The contact to update the contact card with.

Specifies the type of header information to show on a contact card.

Display a basic header.

Display the default header.

Display an enterprise header.

Represents data about how to display a mini contact card.

Initializes a new instance of the ContactCardOptions class.

Gets or sets a value that specifies the type of header to display on the contact card.

The type of header to display on the contact card.

Gets or sets a value that indicates which tab to display first on a mini contact card.

A value that indicates which tab to display first on a mini contact card.

Gets a list to which you can add ContactList.Id values to search for on the server.

A list to which you can add ContactList.Id values to search for on the server.

Specifies which tab to display on a mini contact card.

The default tab.

The email tab.

The messaging tab.

The organizational hierarchy tab.

The phone tab.

The video tab.

Represents a change to a Contact.

Gets a value that indicates the type of change that occurred.

The type of change that occurred.

Gets the Contact object that changed.

The Contact object that changed.

The deferral object to use while asynchronously processing ContactChanged events.

Call this method in order to release the deferral object when all asynchronous processing has finished.

Provides data for the ContactChanged event.

Gets the ContactChangedDeferral object to use for asynchronous operations.

The deferral object to use for asynchronous operations.

Provides a way to monitor and react to changes to contacts.

Call this method to indicate that you have processed and accepted all changes and you don't want the system to show them to you again.

Call this method to indicate that you have processed and accepted up through the specified change.

The last change that you want to system to track as accepted by your app.

Asynchronously gets a list of ContactChange objects.

A list of ContactChange objects.

Provides functionality for monitoring changes to Contact objects in the ContactStore.

Gets a Boolean value indicating whether change tracking is active.

A Boolean value indicating whether change tracking is active.

Call this method to enable change tracking.

Gets a ContactChangeReader that can be used to process changes.

A ContactChangeReader that can be used to process changes.

Call this method to reset the change tracker if your app receives ContactChangeType.ChangeTrackingLost.

Specifies the type of change that occurred for a ContactChanged event.

Change tracking was lost. Call Reset to reestablish continuity with the ContactStore.

A contact was created.

A contact was deleted.

A contact was modified.

Represents a connected service account for a contact.

Initializes a new instance of a ContactConnectedServiceAccount class.

Gets and sets the identifier of a connected service account for a contact. The maximum string length for the identifier is 321 characters.

The identifier of a connected service account for a contact.

Gets and sets the service name of a connected service account for a contact. The maximum string length for the service name is 256 characters.

The service name of a connected service account for a contact.

Represents an important date for a contact.

Initializes a new instance of a ContactDate class.

Gets and sets the day for an important date for a contact.

The day for an important date for a contact.

Gets and sets the description for an important date for a contact. The maximum string length for the description is 512 characters.

The description for an important date for a contact.

Gets and sets the kind of important date for a contact.

A ContactDateKind -typed value that indicates the type of important date for a contact.

Gets and sets the month for an important date for a contact.

The month for an important date for a contact.

Gets and sets the year for an important date for a contact. This value must be convertible to a FILETIME structure.

The year for an important date for a contact.

Specifies the kinds of important dates for a contact.

The anniversary of the contact.

The birthday of the contact.

An important date of the contact other than birthday or anniversary.

Represents an email address of a contact.

Initializes a new instance of a ContactEmail class.

Gets and sets the email address of a contact. The maximum string length for the description is 321 characters.

The email address of a contact.

Gets and sets the description of an email address of a contact. The maximum string length for the description is 512 characters.

The description of an email address of a contact.

Gets and sets the kind of email address of a contact.

A ContactEmailKind -typed value that indicates the type of email address.

Specifies the kinds of email addresses for a contact.

An email address of the contact other than personal or work.

The personal email address of the contact.

The work email address of the contact.

Describes a piece of contact data.

Creates a new ContactField object.

The name of the field. The value the field contains. The type of field. The category the field belongs to.

Creates a new ContactField object.

The value that the field contains. The type of contact data.

Creates a new ContactField object.

The value for the contact field. The type of contact data. The category that the contact belongs to.

Gets the category for the contact data.

The category for the contact data.

Gets the name of the field.

The name of the field.

Gets the contact field type for the data.

The type of data.

Gets the value of the contact data.

The value of the contact data.

Defines the categories that contact data can belong to.

The Home category.

The Mobile category.

The data doesn't belong to a category

The Other category.

The Work category.

<!--Rearranged the description to streamline it and make it more similar to other class and interface descriptions.-->

Creates an instance of the ContactFieldFactory class.

Creates a field to contain information about a contact.

The name of the field. The value of the field. The type of field. The category the field belongs to. Contains a field that you can add to a Contact object.

Creates a field to contain information about a contact.

The value for the field. The type of field. Contains a field that you can add to a Contact object.

Creates a field to contain information about a contact.

The value for the field. The type of field. The category the field belongs to. Contains a field that you can add to a Contact object.

Creates a field to contain information about a contact's instant messaging account.

The user name for the instant messaging account. Contains an instant messaging field that you can add to a Contact object.

Creates a field to contain information about a contact's instant messaging account.

The user name for the instant messaging account. The category the field belongs to. Contains an instant messaging field that you can add to a Contact object.

Creates a field to contain information about a contact's instant messaging account.

The user name of the instant messaging account. The category the field belongs to. The name of the instant messaging service. The text to display to prompt an instant messaging conversation. The Uniform Resource Identifier (URI) that starts an instant messaging conversation. Contains an instant messaging field that you can add to a Contact object.

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. Contains a location field that you can add to a Contact object.

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. The category the field belongs to. Contains a location field that you can add to a Contact object.

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. The category the field belongs to. The street address for the address. The name of the city for the address. The name of the region for the address. The name of the country for the address. The postal code for the address. Contains a location field that you can add to a Contact object.

Defines the type of contact data.

The contact's address. Supported on Windows Phone.

The contact's connected service account.

A custom value.

Custom may be altered or unavailable for releases after Windows 8.1. Instead, use one of the specific types.

The contact's email address. Supported on Windows Phone.

The contact's important dates.

The contact's instant message user name.

InstantMessage may be altered or unavailable for releases after Windows 8.1. Instead, use ConnectedServiceAccount.

The contact's job info.

The contact's location.

Location may be altered or unavailable for releases after Windows 8.1. Instead, use Address.

The contact's notes.

The contact's phone number. Supported on Windows Phone.

The contact's significant other.

The contact's Web site.

This API supports the product infrastructure and is not intended to be used directly from your code.

Contains the information about a contact.

A read-only list of the custom fields stored with the contact.

A read-only list of custom fields.

A read-only list of email addresses stored with the contact.

A read-only list of email addresses.

A read-only list of instant messaging accounts stored with the contact.

A read-only list of instant messaging accounts.

A read-only list of locations stored with the contact.

A read-only list of locations.

The name of the contact.

The name.

A read-only list of phone numbers stored with the contact.

A read-only list of phone numbers.

Gets the thumbnail image for the contact.

An object that provides access to the thumbnail image.

Enables you to get the value for a custom field that is stored with a contact.

The name of the field. The value of the field.

Defines a field that is an instant messaging (IM) address.

Creates a new ContactInstantMessageField object.

The user's name.

Creates a new ContactInstantMessageField object.

The user's name. The category of contact data.

Creates a new ContactInstantMessageField object.

The user's name. The category of the contact data. The name of the instant messaging service. The display text used with the instant messaging Uniform Resource Identifier (URI). The Uniform Resource Identifier (URI) that starts an instant message.

Gets the category for the contact data.

The category for the contact data.

Gets the display text for the Uniform Resource Identifier (URI)that starts an instant message.

The display text.

Gets the Uniform Resource Identifier (URI)that can start an instant message.

The Uniform Resource Identifier (URI).

Gets the name of the field.

The name of the field.

Gets the name of the service used for sending instant messages.

The service name.

Gets the contact field type for the data.

The type of data.

Gets the user's name.

The user's name.

Gets the value of the contact data.

The value of the contact data.

Represents job info for a contact.

Initializes a new instance of a ContactJobInfo class.

Gets and sets the company address of the job info for a contact. The maximum string length for the company address is 1024 characters.

The company address of the job info for a contact.

Gets and sets the company name of the job info for a contact. The maximum string length for the company name is 64 characters.

The company name of the job info for a contact.

Gets and sets the company Yomi (phonetic Japanese equivalent) name of the job info for a contact. The maximum string length for the company Yomi name is 200 characters.

The company Yomi (phonetic Japanese equivalent) name of the job info for a contact.

Gets and sets the department of the job info for a contact. The maximum string length for the department is 100 characters.

The department of the job info for a contact.

Gets and sets the description of the job info for a contact. The maximum string length for the description is 512 characters.

The description of the job info for a contact.

Gets and sets the manager of the job info for a contact. The maximum string length for the manager is 1024 characters.

The manager of the job info for a contact.

Gets and sets the office of the job info for a contact. The maximum string length for the office is 40 characters.

The office of the job info for a contact.

Gets and sets the title of the job info for a contact. The maximum string length for the title is 1024 characters.

The title of the job info for a contact.

Provides data when an app is launched to perform an action to a contact.

Gets the call contact action.

The call contact action.

Gets the map contact action.

The map contact action.

Gets the send message to a contact action.

The send message to a contact action.

Gets the post to a contact action.

The post to a contact action.

Gets the video call contact action.

The video call contact action.

Represents a list of Contact objects.

Gets the app's ContactChangeTracker for this ContactList.

The app's ContactChangeTracker for this ContactList.

Gets or puts the name of the ContactList, suitable for display in the user interface.

The name of the ContactList, suitable for display in the user interface.

Gets the locally unique identifier for this ContactList.

The locally unique identifier for this ContactList.

Gets or puts a Boolean value indicating of the ContactList is hidden in the user interface.

A Boolean value indicating of the ContactList is hidden in the user interface.

Gets an object that provides operations that an app can perform on a contact list that it has not created.

An object that provides operations that an app can perform on a contact list that it has not created.

Gets or puts a value indicating the read access level to this ContactList for other apps on the system.

A value indicating the read access level to this ContactList for other apps on the system.

Gets or puts a value indicating the write access level to this ContactList for other apps on the system.

A value indicating the write access level to this ContactList for other apps on the system.

Gets the name of the source of the ContactList, suitable for display in the user interface.

The name of the source of the ContactList, suitable for display in the user interface.

Gets or sets a Boolean value indicating if you can search the remote server with this ContactList.

A Boolean value indicating if you can search the remote server with this ContactList.

Gets the ContactListSyncConstraints which indicates the maximum amount of contact list data that can be synchronized.

The ContactListSyncConstraints for this contact list.

Gets the ContactListSyncManager used to communicate with the server.

The ContactListSyncManager used to communicate with the server.

Gets a string that represents the ID of the user data account for this ContactList.

A string that represents the ID of the user data account for this ContactList.

Occurs when a Contact in this ContactList has been changed.

Asynchronously deletes this ContactList, including all Contact objects in the ContactStore.

An async action indicating that the method is complete.

Asynchronously deletes and individual Contact from this ContactList and the ContactStore.

The Contact to delete. An async action indicating that the method is complete.

Gets a ContactChangeTracker that provides functionality for monitoring changes to Contact objects in the ContactList.

A string that identifies the ContactChangeTracker instance in the ContactList. A ContactChangeTracker that provides functionality for monitoring changes to Contact objects in the ContactList.

Asynchronously retrieves the specified Contact object from the ContactList.

The string that identifies the Contact to return. The Contact identified by the *contactId* parameter.

Asynchronously gets the Contact identified by the specified RemoteId.

An ID that can be used by a service provider to access the Contact in their remote system. The Contact identified by the *remoteId* parameter.

Gets a ContactReader object associated with this ContactList.

A ContactReader object associated with this ContactList.

Gets a ContactReader object associated with this ContactList and using the specified ContactQueryOptions.

The ContactQueryOptions to use when creating the ContactReader. A ContactReader object associated with this ContactList.

Asynchronously gets the Contact object for the current user.

The Contact object for the current user.

Adds a SyncManager to the ContactList.

An asynchronous registration operation that you can await.

Asynchronously saves this ContactList.

An async action indicating that the method has completed.

Asynchronously saves the specified Contact to the ContactStore.

The contact to save. An async action indicating that the method has completed.

Provides operations that an app can perform on a contact list that it has not created.

Asynchronously attempts to create or update a contact.

The contact to create or update. A Boolean value indicating if the operation was successful.

Asynchronously attempts to delete a contact.

The ID of the contact to delete. A Boolean value indicating if the operation was successful.

Specifies the level of contact read access granted to other apps.

All apps can read all properties.

All apps can read the DisplayName and Picture properties, other properites are only available to specially provisioned apps.

No other apps can read any of the contact information.

Only apps specially provisioned by Microsoft can read these contacts.

Specifies the level of contact write access granted to other apps.

Other apps can only write contacts for this app.

No write access is granted.

Other apps can only write system contacts.

Specifies limits on how much contact list data can be synchronized.

Gets or sets a Boolean value that indicates whether to synchronize contact descriptions.

**True** indicates that contact descriptions will be synchronized; **false**, otherwise.

Gets or sets the maximum number of anniversary dates that can be synchronized.

The maximum number of anniversary dates that can be synchronized.

Gets or sets the maximum number of assistant phone numbers that can be synchronized.

The maximum number of assistant phone numbers that can be synchronized.

Gets or sets the maximum number of birthday dates that can be synchronized.

The maximum number of birthday dates that can be synchronized.

Gets or sets the maximum number of business fax numbers that can be synchronized.

The maximum number of business fax numbers that can be synchronized.

Gets or sets the maximum number of child relationships that can be synchronized.

The maximum number of child relationships that can be synchronized.

Gets or sets the maximum number of company phone numbers that can be synchronized.

The maximum number of company phone numbers that can be synchronized.

Gets or sets the maximum number of home addresses that can be synchronized.

The maximum number of home addresses that can be synchronized.

Gets or sets the maximum number of home fax phone numbers that can be synchronized.

The maximum number of home fax phone numbers that can be synchronized.

Gets or sets the maximum number of home phone numbers that can be synchronized.

The maximum number of home phone numbers that can be synchronized.

Gets or sets the maximum number of job info entries that can be synchronized.

The maximum number of job info entries that can be synchronized.

Gets or sets the maximum number of mobile phone numbers that can be synchronized.

The maximum number of mobile phone numbers that can be synchronized.

Gets or sets the maximum number of 'other address' entries that can be synchronized.

The maximum number of 'other address' entries that can be synchronized.

Gets or sets the maximum number of 'other dates' that can be synchronized.

The maximum number of 'other dates' that can be synchronized.

Gets or sets the maximum number of 'other email' addresses that can be synchronized.

The maximum number of 'other email' addresses that can be synchronized.

Gets or sets the maximum number of 'other phone' numbers that can be synchronized.

The maximum number of 'other phone' numbers that can be synchronized.

Gets or sets the maximum number of 'other relationship' entries that can be synchronized.

The maximum number of 'other relationship' entries that can be synchronized.

Gets or sets the maximum number of page phone numbers that can be synchronized.

The maximum number of page phone numbers that can be synchronized.

Gets or sets the maximum number of parent relationships that can be synchronized.

The maximum number of parent relationships that can be synchronized.

Gets or sets the maximum number of partner relationships that can be synchronized.

The maximum number of partner relationships that can be synchronized.

Gets or sets the maximum number of personal email addresses that can be synchronized.

The maximum number of personal email addresses that can be synchronized.

Gets or sets the maximum number of radio phone numbers that can be synchronized.

The maximum number of radio phone numbers that can be synchronized.

Gets or sets the maximum number of sibling relationships that can be synchronized.

The maximum number of sibling relationships that can be synchronized.

Gets or sets the maximum number of spouse relationships that can be synchronized.

The maximum number of spouse relationships that can be synchronized.

Gets or sets the maximum number of website entries that can be synchronized.

The maximum number of website entries that can be synchronized.

Gets or sets the maximum number of work addresses that can be synchronized.

The maximum number of work addresses that can be synchronized.

Gets or sets the maximum number of work email addresses that can be synchronized.

The maximum number of work email addresses that can be synchronized.

Gets or sets the maximum number of work phone numbers that can be synchronized.

The maximum number of work phone numbers that can be synchronized.

Provides functionality for syncing contact information with the server.

Gets or sets the last time a sync was attempted with the server.

The last time a sync was attempted with the server.

Gets or sets the last time the ContactList was successfully synced with the server.

The last time the ContactList was successfully synced with the server.

Gets or sets the ContactListSyncStatus.

The ContactListSyncStatus.

Occurs when the sync status with the server has changed.

Asynchronously attempts to sync with the contacts server.

A Boolean value indicating if the sync was successful.

Defines the ContactList sync status.

There was an authentication error.

Idle.

The account must be manually removed.

There was a policy error.

Currently syncing.

An unknown error occurred.

The contact list is up-to-date.

Contains information about a user's location and address.

Creates a new ContactLocationField object.

The address of the contact in an unstructured format.

Creates a new ContactLocationField object.

The address of the contact in an unstructured format. The category the field belongs to.

Creates a new ContactLocationField object.

The address of the contact in an unstructured format. The category for the contact data. The street address of the contact. The name of the city for this contact's address. The name of the region for this contact's address. The name of the country for this contact's address. The postal code for this contact's address.

Gets the category for the contact data.

The category for the contact data.

Gets the contact's city.

The contact's city.

Gets the contact's country.

The contact's country.

Gets the name of the field.

The name of the field.

Gets the contact's postal code.

The contact's postal code.

Gets the contact's region.

The contact's region.

Gets the contact's street.

The contact's street.

Gets the contact field type for the data.

The type of data.

Gets a string that represents an unstructured address.

The address of the contact in an unstructured format.

Gets the value of the contact data.

The value of the contact data.

Represents a service that source apps can call to access contact data.

Gets or sets a Boolean that indicates whether the middle name of a contact is included in the DisplayName and SortName of a contact.

A Boolean that indicates whether the middle name of a contact is included in the DisplayName and SortName of a contact.

Gets or puts the display name order.

Specifies the display name order.

Gets or puts the sort order.

Specifies the sort order.

Asynchronously converts a Contact to a vCard.

The Contact to convert. A stream containing the vCard data.

Asynchronously converts a Contact to a vCard.

The Contact to convert. The maximum size for the vCard in bytes. A stream containing the vCard data.

Asynchronously converts a vCard to a Contact.

A stream containing the vCard data. The converted Contact.

Gets the ContactManagerForUser object for the specified user.

The user account to use to get the ContactManagerForUser object. Returns the contact manager for the account specified by the *user* parameter.

Gets a Boolean value indicating if the ShowContactCard method is supported on the current platform.

A Boolean value indicating if the ShowContactCard method is supported on the current platform.

Gets a Boolean value indicating if the ShowDelayLoadedContactCard method is supported on the current platform.

A Boolean value indicating if the ShowDelayLoadedContactCard method is supported on the current platform.

Gets a Boolean value indicating if the ShowFullContactCard method is supported on the current platform.

An asynchronous operation that returns **true** if the ShowFullContactCard method is supported on the current platform.

Asynchronously requests access to the ContactAnnotationStore.

Specifies the type of access request, app contact annotations or all annotations. The requested ContactAnnotationStore.

Retrieves a ContactStore object that enables searching or retrieving contacts on the device.

An asynchronous operation that returns a ContactStore object on successful completion.

Retrieves a ContactStore object that enables searching or retrieving contacts on the device.

Specifies the type of read/write access requested. An asynchronous operation that returns a ContactStore object on successful completion.

Queries the operating system for a user’s contact and shows the contact data in a contact card.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the Rect of the button so the contact card displays around the button, not overlapping it.

Queries the operating system for a user’s contact and shows the contact data in a contact card.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the Rect of the button so the contact card displays around the button, not overlapping it. The Placement that describes the preferred placement of the contact card.

Shows a contact card with the specified parameters.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the Rect of the button so the contact card displays around the button, not overlapping it. The Placement that describes the preferred placement of the contact card. Specifies how to display the contact card, such as which tab to start on when displaying a mini contact card.

Shows a contact card that can be updated later if the contact does not exist in the user’s contact database.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the Rect of the button so the contact card displays around the button, not overlapping it. The Placement that describes the preferred placement of the contact card. Returns the ContactCardDelayedDataLoader object that can be used to update the contact card.

Shows a contact card that can be updated later if the contact does not exist in the user’s contact database.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the contact card, not within that rectangular area. For example, if an app uses a button to show the contact card, pass the Rect of the button so the contact card displays around the button, not overlapping it. The Placement that describes the preferred placement of the contact card. Specifies how to display the contact card, such as which tab to start on if you are displaying a mini contact card, or what header type to use if you are showing a full contact card. Returns the ContactCardDelayedDataLoader object that can be used to update the contact card.

Queries the operating system for a user’s contact and shows the contact data in a full contact card.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. Specifies how to display the full contact card.

Represents a service that source apps can call to access contact data for a specific user.

Gets or sets the display name order for contacts.

The display name order for contacts.

Gets or sets the sort order for contacts. For example, sort by last name or first name.

The sort order.

Gets the User represented by this contact manager.

The User represented by this contact manager.

Asynchronously converts a Contact to a vCard.

The Contact to convert. A stream containing the vCard data.

Asynchronously converts a Contact to a vCard.

The Contact to convert. The maximum size for the vCard in bytes. A stream containing the vCard data.

Asynchronously converts a vCard to a Contact.

A stream containing the vCard data. The converted Contact.

Asynchronously returns the ContactAnnotationStore from the system.

Specifies the access type, such as **AllAnnotationsReadWrite** for all annotations or **AppAnnotationsReadWrite** for the calling app's annotations. Returns the ContactAnnotationStore.

Asynchronously returns the ContactStore from the system.

Specifies the access type, such as **AllContactsReadOnly** for all accounts or **AppContactsReadWrite** for the calling app's accounts. Returns the ContactStore.

Queries the operating system for a user’s contact and shows the contact data in a full contact card.

The object that represents the contact that the app wants to display the contact card for.*contact* must contain at least an Id, Emails, or a phone number from a Phones list to query the user’s contact database to retrieve a matching contact to display. Id has higher priority for querying. If an Id matches, the rest of query parameters will be ignored for matching purposes. If an Id does not find a match, the query uses the rest of query parameters. Specifies how to display the full contact card.

Provides details about why search results matched the query parameters.

Gets the contact field type that matched the search, such as name, phone number, email address and so on.

The contact field type that matched the search, such as name, phone number, email address and so on.

Gets a list of matching TextSegment objects which tells you what to highlight in your view as the result of a contact search.

The list of matching TextSegment objects.

Gets the matching text result from a contact search.

The matching text result from a contact search.

Defines the reasons that a Contact matched a search.

The contact email address field matched.

The contact job info field matched.

The contact name field matched.

The contact matched on a field that is not one of the others list in this enum.

The contact phone number field matched.

The contact phonetic name field matched.

Specifies the name order for a contact.

Show name by first name, then last name.

Show name by last name, then first.

Represents a Contact Panel that appears when users click a contact that is pinned to the taskbar.

Specifies the color of the Contact Panel header.

A Color that represents the desired color.

Occurs when the Contact Panel is closing.

Occurs when the user clicks the **Launch Full App** button in the Contact Panel.

Closes the Contact Panel.

Provides event information for the Closing event.

Gets the deferral object for the Closing event.

The deferral object for the Closing event.

Provides event information for the LaunchFullAppRequested event.

Gets or sets a value that indicates the LaunchFullAppRequested event has been handled.

**true** if the LaunchFullAppRequested event is handled; **false** if the LaunchFullAppRequested event is not yet handled.

Represents information about the phone for a contact.

Initializes a new instance of a ContactPhone class.

Gets and sets the description of the phone for a contact. The maximum string length for the description is 512 characters.

The description of the phone for a contact.

Gets and sets the kind of phone for a contact.

A ContactPhoneKind -typed value that indicates the kind of phone.

Gets and sets the phone number of a phone for a contact. The maximum string length for the phone number is 50 characters.

The phone number of a phone for a contact.

Specifies the kinds of phones for a contact.

The phone number of the contact's assistant.

The business fax of the contact.

The company phone of the contact.

The home phone of the contact.

The home fax of the contact.

The mobile phone of the contact.

A phone of the contact other than home, mobile, or work.

The pager number of the contact.

The radio address of the contact.

The work phone of the contact.

Controls how the Contact Picker user interface opens and what information it shows.

Creates a new instance of the ContactPicker class.

Sets the text for the confirmation button in the Contact Picker user interface.

The text of the button.

Sets the contact fields your app is interested in.

An array of strings that represent the field names your app is interested in.

Gets the ways to connect with a contact.

An array of ContactFieldType -typed values for a contact.

Controls whether the Contact Picker shows contacts as a complete entity or as a collection of fields.

The mode for the Contact Picker user interface. You can set this to **Contacts** or **Fields**.

Gets the User associated with the ContactPicker.

The User associated with the ContactPicker.

Creates a new ContactPicker for a specific User.

The User for which you want to create the ContactPicker. Returns a ContactPicker for the account specified by the *user* parameter.

Gets a Boolean value indicating if the contact picker is supported on the current platform.

A Boolean value indicating if the contact picker is supported on the current platform.

Launches the Contact Picker to select a single contact.

The operation that launches the Contact Picker.

Launches the Contact Picker for selecting multiple contacts.

The operation that launches the contact picker.

Launches the Contact Picker for selecting multiple contacts.

The operation that launches the contact picker.

Launches the Contact Picker for selecting a single contact.

The operation that launches the Contact Picker.

Defines which fields must exist on a contact in order to match a search operation.

The contact must have an email address.

No required fields

The contact must have a phone number.

The contact must have a postal address.

Used to specify the query options when searching for contacts.

Initializes a new instance of the ContactQueryOptions class.

Initializes a new instance of the ContactQueryOptions class.

The text to match in the search operation.

Initializes a new instance of the ContactQueryOptions class.

The text to match in the search operation. Specifies which contact fields to search for a match.

Gets a list to which you can add ContactAnnotationList.Id values for which to search.

A list to which you can add ContactAnnotationList.Id values for which to search.

Gets a list to which you can add ContactList.Id values for which to search.

A list to which you can add ContactList.Id values for which to search.

Gets or sets the desired fields a contact must have to match the query.

The desired fields a contact must have to match the query.

Gets or sets the desired annotation operations a contact must have to match the query.

The desired annotation operations a contact must have to match the query.

Gets or sets a Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface.

A Boolean value indicating if the query results should include contacts from lists that are not shown in the user interface.

Gets a ContactQueryTextSearch object that can be used for text searches.

A ContactQueryTextSearch object that can be used for text searches.

Defines which contact fields to search for a text match.

All

Email address

Name

None

Phone number

Defines whether to search the local ContactStore or a server.

Local

Server

Specifies parameters to use in a text search of Contact objects.

Gets or sets which contact fields to search for a text match.

Specifies which contact fields to search for a text match.

Gets or sets a value that specifies either a local or server search.

A value that specifies either a local or server search.

Gets or sets the text for which to search.

The text for which to search.

Used to read Contact objects in batches from the ContactStore which may be local or remotely located.

Gets the reason a Contact matched the search query. Returns the properties and substrings that match.

The Contact for which to get the matching properties. The list of matching properties and match reasons.

Asynchronously reads a batch of Contact objects from the ContactStore.

The batch of contacts read from the ContactStore.

Defines a value that indicates the nature of a contact relationship, such as spouse, partner, sibling, parent and so on.

Child

Other

Parent

Partner

Sibling

Spouse

Specifies whether you want to request an entire contact, or only specific fields.

Specifies that you want to select the entire contact.

Specifies that you want to select only certain fields.

Represents the info about a significant other for a contact.

Initializes a new instance of a ContactSignificantOther class.

Gets and sets the description of a significant other for a contact. The maximum string length for the description is 512 characters.

The description of a significant other for a contact.

Gets and sets the name of a significant other for a contact. The maximum string length for the name is 256 characters.

The name of a significant other for a contact.

Gets or puts a value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on.

A value that indicates the nature of the relationship, such as spouse, partner, sibling, parent and so on.

Represents a database that contains contacts.

Gets a contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact.

A contact manager that provides functionality for linking individual (raw) contacts across services together into a single aggregate contact.

Gets the ContactChangeTracker which provides functionality for monitoring changes to Contact objects in the ContactStore.

The ContactChangeTracker which provides functionality for monitoring changes to Contact objects in the ContactStore.

Occurs when a Contact in the ContactStore has been changed.

Asynchronously creates a ContactList with the specified display name.

A name for the new ContactList, suitable for displaying in the user interface. The newly created ContactList.

Asynchronously creates a ContactList with the specified display name and user account.

A name for the new ContactList, suitable for displaying in the user interface. The ID for the UserDataAccount to use when creating the ContactList. The newly created ContactList.

Asynchronously returns the list of ContactList objects.

The list of ContactList objects.

Retrieves the list of all contacts in the contact store.

An asynchronous operation that returns a list of all Contact objects in the contact store. If you use Asynchronous programming, the result type is a read-only list/vector of Contact items. (You can use APIs of IVectorView<Contact> for C++ or JavaScript, APIs of IReadOnlyList<Contact> for .NET.)

Retrieves a list of Contact objects based on the supplied search text.

The search string for the operation. The query will attempt to match the name (Name ), email address (Emails values), or phone number (Phones values) of a contact. An asynchronous operation that returns a search-filtered list of contacts on successful completion. If you use Asynchronous programming, the result type is a read-only list/vector of Contact items. (You can use APIs of IVectorView<Contact> for C++ or JavaScript, APIs of IReadOnlyList<Contact> for .NET.)

Gets a ContactChangeTracker that provides functionality for monitoring changes to Contact objects in the ContactStore.

A string that identifies the ContactChangeTracker instance in the store. A ContactChangeTracker that provides functionality for monitoring changes to Contact objects in the ContactStore.

Retrieves a Contact object representing the contact with the specified Id value.

The Id of the contact to be retrieved. An asynchronous operation that returns a Contact object on successful completion. If you use Asynchronous programming, the result type is a single Contact object.

Asynchronously gets the ContactList with the specified ID.

The ID of the ContactList to retrieve. The ContactList with the specified ID or null if the list is not found.

Creates and returns a ContactReader for the ContactStore.

The newly created ContactReader for the ContactStore.

Creates and returns a ContactReader for the ContactStore with the specified ContactQueryOptions.

The query options to use when creating the new ContactReader. The newly created ContactReader for the ContactStore.

Get the Contact object for the current user.

The Contact object for the current user.

Defines the type of access the app has to the ContactStore.

Read access to all contacts, those provided by the calling app and from other sources. This value requires the contacts capability. See App capability declarations for more information.

Read and write access to all contacts. This value is not available to all apps. Your developer account must be specially provisioned by Microsoft in order to request this level of access.

Read and write contacts that belong to the app only.

Reserved for future use.

Represents the info about a Web site for a contact.

Initializes a new instance of a ContactWebsite class.

Gets and sets the description of a Web site for a contact. The maximum string length for the description is 512 characters.

The description of a Web site for a contact.

Gets or sets the raw website address for the contact. This address is not checked for valid URI formatting.

The raw website address for the contact.

Gets and sets the Uniform Resource Identifier (URI) of a Web site for a contact.

The Uniform Resource Identifier (URI) of a Web site for a contact.

Specifies the options for displaying the full contact card.

Initializes a new instance of the FullContactCardOptions class.

Gets or sets a value that describes the desired view size for the full contact card.

A value that describes the desired view size for the full contact card.

Specifies an object that describes a piece of contact data.

Gets the category for the contact data.

The category for the contact data.

Gets the name of the field.

The name of the field.

Gets the contact field type for the data.

The type of data.

Gets the value of the contact data.

The value of the contact data.

<!--Changed beginning of sentence to make description more streamlined.-->

Creates a field to contain information about a contact.

The name of the field. The value the field contains. The type of field. The category the field belongs to. A field that you can add to a Contact object.

Creates a field to contain information about a contact.

The value for the field. The type of field. A field that you can add to a Contact object.

Creates a field to contain information about a contact.

The value of the field. The type of field. The category the field belongs to. A field that you can add to a Contact object.

Creates fields with information about a contact's instant messaging accounts.

Creates a field containing information about a contact's instant messaging account.

The user name of the instant messaging account. An instant messaging field that you can add to a Contact object.

Creates a field containing information about a contact's instant messaging account.

The user name for the instant messaging account. The category the field belongs to. An instant messaging field that you can add to a Contact object.

Creates a field containing information about a contact's instant messaging account.

The user name for the instant messaging account. The category the field belongs to. The name of the instant messaging service. The text to display to prompt an instant messaging conversation. The Uniform Resource Identifier (URI) that starts an instant messaging conversation. An instant messaging field that you can add to a Contact object.

<!--Changed beginning of sentence to make description more streamlined.-->

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. A location field that you can add to a Contact object.

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. The category the field belongs to. A location field that you can add to a Contact object.

Creates a field to contain information about a contact's location.

The address of the contact in an unstructured format. The category the field belongs to. The street address. The name of the city for the address. The name of the region for the address. The name of the country for the address. The postal code for the address. A location field that you can add to a Contact object.

A static class that contains the names of contact fields for storing commonly requested information like email address and phone numbers.

KnownContactField may be altered or unavailable for releases after Windows 8.1. Instead, use ContactAddress, ContactPhone, ContactConnectedServiceAccount or ContactEmail.

Contains the name of the field used for email addresses.

The name of the field.

Contains the name of the field used for instant messaging accounts.

The name of the field.

Contains the name of the field used for the contact's location.

The name of the field.

Contains the name of the field used for phone numbers.

The name of the field.

Converts a string representing the name of a field to its corresponding type.

IKnownContactFieldStatics may be altered or unavailable for releases after Windows 8.1. Instead, use ContactAddress, ContactPhone, ContactConnectedServiceAccount or ContactEmail. The name of the field. The type of field.

Converts the type of a field to its corresponding string name.

IKnownContactFieldStatics may be altered or unavailable for releases after Windows 8.1. Instead, use ContactAddress, ContactPhone, ContactConnectedServiceAccount or ContactEmail. The type of field. The name of the field.

Provides access to the results of a query that lists the IDs all contacts pinned to the taskbar or Start menu.

Gets the list of contact IDs that are pinned to the taskbar or **Start** menu.

The list of contact IDs that are pinned to the taskbar or **Start** menu.

Represents a service that source apps can call to pin and unpin contacts to and from the taskbar or **Start** menu.

Gets the User associated with the PinnedContactManager.

The User associated with the PinnedContactManager.

Gets the default an instance of a PinnedContactManager.

the default PinnedContactManager.

Gets a PinnedContactManager for the specified user.

The user account to use to get the PinnedContactManager. Returns the PinnedContactManager for the account specified by the *user* parameter.

Gets the ID's of all contacts that are pinned to the taskbar or **Start** menu.

An asynchronous operation that returns a PinnedContactIdsQueryResult that you can use to get the ID's of all pinned contacts.

Indicates whether the specified contact is pinned to the specified location in the Windows user interface.

A contact of interest. This property indicates whether that contact is pinned or not pinned. A pinnedContactSurface value that specifies the location in the UI that you'd like to check for pinned contacts. A Boolean value that specifies whether the specified contact is pinned to the specified location in the Windows user interface.

Indicates whether the specified location in the Windows UI supports contact pinning.

A pinnedContactSurface value that specifies a pinning location in the Windows UI. This property determines whether pinning is supported in that location. A Boolean value that indicates whether the location in the Windows UI supports contact pinning.

Indicates whether the Windows UI supports contact pinning.

A Boolean value that indicates whether the Windows UI supports contact pinning.

Pins a contact to the taskbar or **Start** menu.

The contact to pin to the taskbar or **Start** menu. A pinnedContactSurface value that specifies where in the Windows UI you would like to pin the contact. An asynchronous operation that returns a Boolean value that indicates whether the contact was successfully pinned to the specified location.

Pins a collection of contacts to the taskbar or **Start** menu.

The collection of contacts to pin to the taskbar or **Start** menu. A pinnedContactSurface value that specifies where in the Windows UI you would like to pin the contacts. An asynchronous operation that returns a Boolean value that indicates whether the contacts were successfully pinned to the specified location.

Unpins a contact from the taskbar or **Start** menu.

The contact to unpin from the taskbar or **Start** menu. A pinnedContactSurface value that specifies from which area in the Windows UI you would like to unpin the contact. An asynchronous operation that returns a Boolean value that indicates whether the contact was successfully unpinned from the specified location.

Indicates to Windows when activity that is related to a pinned contact occurs.

The contact that is exhibits activity.

Specifies the location in the Windows user interface to which a contact can be pinned.

The Windows **Start** menu as a pinning location.

The taskbar as a pinning location.

Represents a connection to a data provider client.

Raised when the client app attempts to create or update a contact.

Raised when the client app attempts to delete a contact.

Occurs when the contact data client has requested a batch of server-side search results.

Occurs when the contact data client has requested to sync a contact list with the server..

Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests.

Contains details about the event that triggered your contact data provider background task.

Gets the ContactDataProviderConnection object instance used to provide contact data to a client app.

The ContactDataProviderConnection object your contact data provider uses to communicate with a client app.

Details of a request to create or update a contact.

Gets the Contact of the task to be created or updated.

The Contact of the task to be created or updated.

Gets the ID of the contact list that contains the task that is to created or updated.

The ID of the contact list that contains the task that is to created or updated.

Informs the client app that the request was processed successfully.

The Contact of the contact that was created or updated. An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to create or update.

Gets the ContactListCreateOrUpdateTaskRequest object associated with this request.

A ContactListCreateOrUpdateTaskRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to delete a contact.

Gets the contact ID of the contact to be deleted.

The contact ID of the contact to be deleted.

Gets the ID of the contact list that contains the contact that is to be deleted.

The contact list that contains the contact that is to be deleted.

Informs the client app that the request was processed successfully.

An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to delete a contact.

Gets the ContactListDeleteTaskRequest object associated with this request.

A ContactListDeleteTaskRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to read a batch of server-side search results.

Gets the contact list ID of the contact list to be searched.

A contact list ID.

Gets the search options to be applied in this search.

A ContactQueryOptions object specifying search options.

Gets the search session ID of this batch read request.

A search session ID.

Gets the suggested batch size for the server-side search batch read.

The suggested number of contacts in a batch.

Informs the client app that the request was processed successfully.

An asynchronous batch read request operation.

Informs the client that the request was not processed successfully.

A ContactBatchStatus value describing the reason for the failure. An asynchronous batch read request operation.

Asynchronously saves a contact that meets server-side search criteria.

A Contact that meets the search criteria. An asynchronous contact save operation.

Encapsulates information about a request to read a batch of results from a server-side search.

Gets the ContactListServerSearchReadBatchRequest object associated with this request.

A ContactListServerSearchReadBatchRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request from a client to sync a contact list.

Gets the contact list ID of the contact list to be synched.

A contact list ID.

Informs the client app that the request was processed successfully.

An asynchronous sync operation.

Informs the client that the request was not processed successfully.

An asynchronous sync operation.

Encapsulates information about a request to sync a contact list.

Gets the ContactListSyncManagerSyncRequest object associated with this request.

A ContactListSyncManagerSyncRequest object describing the sync request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Indicates whether a contact was added successfully.

The contact was added.

The contact was already selected by the user.

The contact was unavailable and was not added.

Allows you to call the contact picker UI so you can select one or more contacts.

Specifies the fields that you want returned after the user selects one or more contacts.

A collection of fields that you want returned. You can specify which fields you want through the KnownContactField class.

Gets the fields with contact field type that you want returned after the user selects one or more contacts.

A collection of fields of contact field type that you want returned. The ContactFieldType values specify which fields you want.

Determines the selection mode for the contact picker. The most common options are PickSingleContactAsync or PickMultipleContactsAsync.

Specifies the selection mode that you want to use.

Occurs when the user deselects or removes the contact.

Adds a Contact.

AddContact may be altered or unavailable for releases after Windows 8.1. Instead, use AddContact without the ID. The ID for the contact. An object that contains the contact's information. An AddContactResult -typed value that indicates whether the contact was added successfully.

Adds a Contact.

An object that contains the contact's information. An AddContactResult -typed value that indicates whether the contact was added successfully.

Checks to see whether the contact was already selected by the user.

The ID of the contact. True if the contact has already been selected; otherwise, false.

Removes a contact.

The ID of the contact to remove.

Contains info about a removed contact. Returned when a ContactRemoved event occurs.

Contains a unique identifier for the contact.

A unique identifier for the contact.

Provides the configuration details for a single signal supported by an activation signal detector. For example, the keyword "Hey Cortana" in US English.

Gets the current usage restrictions unique to this configuration.

The availability state of the ActivationSignalDetector.

Gets the name of the signal in a localizable, human-readable form.

The name of the signal.

Gets whether an ActivationSignalDetectionConfiguration object is processing configuration settings.

True, if all criteria are met. Otherwise, false.

The unique model identifier.

Gets the locale-independent identifier for this configuration.

The signal identifier.

Gets the supported data format used for signal detection training with this configuration (if available).

The signal detection data format.

Gets the number of steps completed in the training process of this configuration (if available).

THe number of training steps completed.

Gets the number of steps remaining in the training process of this configuration (if available).

THe number of training steps remaining.

Occurs when the availability state of the ActivationSignalDetector changes.

Provides input data in the specified format and attempts to complete a training step (if a training process is available for the signal detector of this configuration).

The voice training data formats supported by the ActivationSignalDetector for the digital assistant. The voice training data. The voice training data states recognized by the ActivationSignalDetector for the digital assistant.

Asynchronously provides input data in the specified format and attempts to complete a training step (if a training process is available for the signal detector of this configuration).

The voice training data formats supported by the ActivationSignalDetector for the digital assistant. The voice training data. The voice training data states recognized by the ActivationSignalDetector for the digital assistant.

Deletes all model data for the digital assistant.

Asynchronously deletes all model data for the digital assistant.

Deletes all voice training data from the ActivationSignalDetector for the digital assistant.

Asynchronously deletes all voice training data from the ActivationSignalDetector for the digital assistant.

Gets the model configuration data (specific to a signal detector).

The configuration data, or null if no data exists.

Asynchronously gets the model configuration data (specific to a signal detector).

The configuration data, or null if no data exists.

Gets the model configuration data type (specific to a signal detector).

The configuration data type, or null if no data exists.

Asynchronously gets the model configuration data type (specific to a signal detector).

The configuration data type, or null if no data exists.

Enables or disables the configuration in an application-level manner, independent of system-level settings. The configuration must be both allowed and enabled for its associatedActivationSignalDetector.

True, if enabled. Otherwise, false.

Asynchronously enables or disables the configuration in an application-level manner, independent of system-level settings. The configuration must be both allowed and enabled for its associatedActivationSignalDetector.

True, if enabled. Otherwise, false.

Sets the model configuration data (specific to a signal detector).

The type of configuration data that ensures compatibility with the detector. The configuration data.

Asynchronously sets the model configuration data (specific to a signal detector).

The type of configuration data that ensures compatibility with the detector. The configuration data.

Specifies the activation signal training data formats supported by the ActivationSignalDetector for the digital assistant.

Training data is generic audio in 16-bit 44kHz mono.

Training data is generic audio in 8-bit 44kHz mono.

Training data is generic audio in 16-bit 48kHz mono.

Training data is generic audio in 8-bit 48kHz mono.

Training data is generic audio in a format specified by a hardware provider.

Training data is in a format specified by a hardware provider.

Training data is voice audio in 16-bit 16kHz mono.

Training data is voice audio in 8-bit 16kHz mono.

Training data is voice audio in 16-bit 8kHz mono.

Training data is voice audio in 8-bit 8kHz mono.

Training data is voice audio is defined by an OEM.

Represents hardware and software components that can generate activation signals based on input from a user's environment, such as spoken keyword(s), sound detection, or button press.

Gets whether the ActivationSignalDetector can add or remove items from its collection of ActivationSignalDetectionConfiguration objects.

True, if an ActivationSignalDetectionConfiguration object can be created. Otherwise, false.

Gets the supported ActivationSignalDetector types.

The supported ActivationSignalDetector types.

Gets an identifier unique to the provider of this detector, such as the manufacturer of a hardware-based keyword spotter.

The unique identifier of the provider.

Gets the model configuration data types supported by the signal detector.

A collection of model configuration data types.

Gets the power modes supported by an ActivationSignalDetector.

A collection of ActivationSignalDetectorPowerState modes supported by an ActivationSignalDetector.

Gets the supported formats for training an ActivationSignalDetector.

An ActivationSignalDetectionConfiguration.TrainingDataFormat collection for training an ActivationSignalDetector.

Creates an ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair and adds it to the collection of supported configurations for the detector.

The locale-independent identifier for this configuration. The unique identifier, typically locale-specific, for the model data associated with this configuration. The name of the signal in a localizable, human-readable form.

Asynchronously creates an ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair and adds it to the collection of supported configurations for the detector.

The locale-independent identifier for this configuration. The unique identifier, typically locale-specific, for the model data associated with this configuration. The name of the signal in a localizable, human-readable form.

Gets the ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

The unique identifier for the ConversationalAgentSignal. The unique model identifier of the Signal that activated the conversational agent. The ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

Asynchronously gets the ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

The unique identifier for the ConversationalAgentSignal. The unique model identifier of the Signal that activated the conversational agent. The ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

Gets the collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector.

The collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector.

Asynchronously gets the collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector.

The collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector.

Asynchronously gets the collection of model identifiers supported by this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword.

The locale-independent identifier for this configuration. The collection of model identifiers supported through the specified signal.

Asynchronously gets the collection of model identifiers supported by this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword.

The locale-independent identifier for this configuration. The collection of model identifiers supported through the specified signal.

Removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

The unique identifier for the ConversationalAgentSignal. The unique model identifier of the Signal that activated the conversational agent.

Asynchronously removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair.

The unique identifier for the ConversationalAgentSignal. The unique model identifier of the Signal that activated the conversational agent.

Specifies the supported ActivationSignalDetector types.

Audio input has hit a signal threshold (for example, voice activity detection).

Audio input has matched a specified pattern (for example, a keyword or "bark detector").

Activation signal detected from a hardware device such as a keyboard or bluetooth headset.

Specifies the power modes, supported by an ActivationSignalDetector, that describe the power-related conditions under which a detector is allowed to operate.

A device in a low-power state but not currently using battery power. For example, a laptop that's charging while in sleep state.

A device in a low-power state and using battery power. For example, a laptop in sleep state that's not connected to an external power source.

A device that is not currently affected by any power restriction conditions. For example, a laptop that's charging and in active use (with the screen on).

Provides access to existing signal detector and configuration definitions of a digital assistant.

Gets the global manager associated with all ActivationSignalDetector objects available on the system.

The global manager associated with all ActivationSignalDetector objects available on the system.

Gets all ActivationSignalDetector objects available on the system that are associated with this manager.

A supported ActivationSignalDetector type. When this method completes successfully, it returns an activation signal detector.

Asynchronously gets all ActivationSignalDetector objects available on the system that are associated with this manager.

A supported ActivationSignalDetector type. When this method completes successfully, it returns an activation signal detector.

Gets all ActivationSignalDetector objects available on the system that are associated with this manager and that correspond to the type of detector specified.

When this method completes successfully, it returns a collection of activation signal detectors.

Asynchronously gets all ActivationSignalDetector objects available on the system that are associated with this manager and that correspond to the type of detector specified.

When this method completes successfully, it returns a collection of activation signal detectors.

The communication channel between the digital assistant and the Windows Conversational Agent platform.

Gets the state of the digital assistant.

The state of the digital assistant.

Gets whether the indicator light is available.

True, if the indicator light is available; otherwise, false.

Gets whether the ConversationalAgentSession is being interrupted.

True, if the ConversationalAgentSession is interrupted; otherwise, false.

Gets whether the ConversationalAgentSession can be interrupted.

True, if the ConversationalAgentSession can be interrupted; otherwise, false.

Gets whether the screen can be turned on.

True, if the screen can be turned on; otherwise, false.

Gets whether the user is authenticated (for example, the device is locked).

True, if user is authenticated; otherwise, false.

Gets whether the digital assistant can be activated by speech input.

True, if speech input can activate the digital assistant; otherwise, false.

The Signal that activated the digital assistant, such as a keyword utterance, Bluetooth transmission, system keyboard accelerator, in-app speech recognition, or other sounds (door slam, smoke detector).

The audible signal detected by the digital signal processor (DSP).

Occurs when another digital assistant activation signal has been detected.

Occurs when a Signal for activating a digital assistant is detected.

Occurs when either the system or the user changes a setting that restricts the ability of the digital assistant to perform one or more actions.

Terminates the ConversationalAgentSession.

Synchronously creates an audio graph input node.

An audio graph that represents the connected input, output, and submix nodes for manipulating and routing audio. The AudioDeviceInputNode.

Asynchronously creates an audio graph input node.

An audio graph that represents the connected input, output, and submix nodes for manipulating and routing audio. The result of the asynchronous operation as an AudioDeviceInputNode.

Synchronously retrieves the device ID for the current speech input device.

The ID as a string.

Asynchronously retrieves the device ID for the current speech input device.

The result of the asynchronous operation as a string.

Synchronously retrieves an IAudioClient object that creates and initializes an audio stream between your application and the audio rendering device.

The IAudioClient object.

Asynchronously retrieves an IAudioClient object that creates and initializes an audio stream between your application and the audio rendering device.

The result of the asynchronous operation as an IAudioClient object.

Synchronously retrieves the device ID for the current speech output device.

The ID as a string.

Asynchronously retrieves the device ID for the current speech output device.

The result of the asynchronous operation as a string.

Asynchronously retrieves a reference to the current ConversationalAgentSession.

The result of the asynchronous operation as a ConversationalAgentSession.

Synchronously retrieves a reference to the current ConversationalAgentSession.

A reference to the current ConversationalAgentSession.

Retrieves the unique model identifier of the Signal that activated the conversational agent.

The unique model identifier.

Asynchronously retrieves the unique model identifier of the Signal that activated the conversational agent.

When this method completes successfully, it returns a unique model identifier.

Retrieves the collection of unique Signal model identifiers supported by the conversational agent.

A collection of unique Signal model identifiers.

Asynchronously retrieves the collection of unique Signal model identifiers supported by the conversational agent.

When this method completes successfully, it returns a collection of unique Signal model identifiers.

Synchronously requests a state change for the current ConversationalAgentSession.

The AgentState requested. A ConversationalAgentSessionUpdateResponse.

Asynchronously requests a state change for the current ConversationalAgentSession.

The AgentState requested. The result of the asynchronous operation as a ConversationalAgentSessionUpdateResponse.

Synchronously requests that the digital assistant be activated to the foreground.

A ConversationalAgentSessionUpdateResponse.

Asynchronously requests that the digital assistant be activated to the foreground.

The result of the asynchronous operation as a ConversationalAgentSessionUpdateResponse.

Synchronously requests that this ConversationalAgentSession be interruptible if the keyword for another digital assistant is detected.

True, if interruptible; otherwise, false. A ConversationalAgentSessionUpdateResponse.

Asynchronously requests that this ConversationalAgentSession be interruptible if the keyword for another digital assistant is detected.

True, if interruptible; otherwise, false. The result of the asynchronous operation as a ConversationalAgentSessionUpdateResponse.

Assigns a unique identifier to the model representing the activation audio signal for the conversational agent.

The unique identifier. True, if set successfully. Otherwise, false.

Asynchronously assigns a unique identifier to the model representing the activation audio signal for the conversational agent.

The unique identifier. An asynchronous operation with a value of **true** if the model identifier was set successfully; otherwise **false**.

Provides event data for the SessionInterrupted event.

Specifies each possible response for a ConversationalAgentSession update.

Indicates a ConversationalAgentSession update failed.

Indicates a ConversationalAgentSession update succeeded.

A signal detected by an agent that corresponds to an ActivationSignalDetectionConfiguration. This signal indicates that the matching agent should be activated to handle an interaction.

Gets or sets whether the ConversationalAgentSignal needs to be verified.

True, if verification is required; otherwise, false.

Gets or sets the context for the ConversationalAgentSignal.

The signal context.

Gets or sets the time span of the ConversationalAgentSignal end.

Gets or sets a unique identifier for the ConversationalAgentSignal.

The signal identifier.

Gets or sets the name of the ConversationalAgentSignal (for example, "Cortana" or "Alexa").

The name of the signal.

Gets or sets the time span of the ConversationalAgentSignal start.

Provides event data for the SignalDetected event.

Specifies each possible AgentState for a digital assistant.

The ConversationalAgent is verifying the activation signal that activated it.

The ConversationalAgent is not actively processing input or speaking to the user.

The ConversationalAgent is actively processing input.

The ConversationalAgent is concurrently processing input and speaking to the user.

The ConversationalAgent is actively speaking to the user.

The ConversationalAgent is acting on the user's input and awaiting an outcome to continue the agent interaction.

Provides event data for the SystemStateChanged event.

Gets the system state that changed.

The system state that changed.

Specifies the possible state changes for the SystemStateChanged event.

When set, indicates that the system's capability to use status indicator lights has changed.

When set, indicates that the system's capability to turn on, or use, a display device has changed (this does not indicate whether or not the display is currently being used). Corresponds to ConversationalAgentSession.IsScreenAvailable.

When set, indicates that the authentication status of the user has changed (such as when a user locks or unlocks a system). Corresponds to ConversationalAgentSession.IsUserAuthenticated.

When set, indicates voice activation availability has been changed through system settings or group policy. Corresponds to ConversationalAgentSession.IsVoiceActivationAvailable.

Provides event data for the ActivationSignalDetectionConfiguration.AvailabilityChanged event.

Gets the permission levels granted by a user to the ActivationSignalDetector.

The permission levels granted by a user to the ActivationSignalDetector.

Specifies the permission levels granted by a user to each ActivationSignalDetectionConfiguration of an ActivationSignalDetector.

Indicates that a configuration permission used above the lock screen has changed.

Indicates that a configuration permission has changed.

Indicates that a configuration permission to access necessary system resources, such as signal model files, has changed.

Provides availability details for the ActivationSignalDetector.

Gets whether the ActivationSignalDetector has user permission to operate above the lock screen.

True, if permission granted. Otherwise, false.

Gets whether the ActivationSignalDetector has user permission to listen for activation keywords.

True, if permission granted. Otherwise, false.

Gets whether the ActivationSignalDetector can access system resources.

True, if enabled. Otherwise, false.

Gets whether the ActivationSignalDetector is enabled.

True, if enabled. Otherwise, false.

Specifies the voice training data states recognized by the ActivationSignalDetector for the digital assistant.

Training data format is not recognized by the signal detector.

Signal detection training was successful.

An internal error, unrelated to the input data format, was encountered during signal detection training.

Training data cannot be processed by the signal detector due to poor quality of speech input.

Training data cannot be processed by the signal detector due to user speaking too fast.

Training data cannot be processed by the signal detector due to user speaking too loudly.

Training data cannot be processed by the signal detector due to user speaking too quietly.

Training data cannot be processed by the signal detector due to user speaking too slowly.

Provides an app's display info such as its display name and description, and a method to launch the app.

Gets the Application User Model ID (AUMID) for this **AppListEntry**.

A string representing the app's identity.

Provides an app's display name, description, and logo.

An object representing the app's display name, description, and logo.

Launch the app associated with this AppListEntry

Returns **true** if the launch succeeds; otherwise, **false**.

Launch the app associated with this AppListEntry within the context of a specified user.

The user context that the app should be launched under. Returns **true** if the launch succeeds; otherwise, **false**.

Describes the reasons why an app could fail a request to restart.

Could not restart for the specified user.

An app must be visible and in the foreground when it calls the restart API.

Unspecified failure.

A restart is already in progress.

Enables apps to handle state changes, manage windows, and integrate with a variety of UI frameworks.

Gets the package-relative app identifier for the process.

The package-relative app identifier for the process.

Gets the main CoreApplicationView instance for all running apps that use this CoreApplication instance.

The main view for this CoreApplication instance.

Gets a property set that the app and UI frameworks can use to store info while the process is running.

The property set.

Gets all views for the app.

All of the app's views.

Fired when your app is activated by a background trigger.

Fired when the app enters the running in the background state.

Occurs when the app is shutting down.

Fired just before application UI becomes visible.

Occurs when an app is resuming.

Occurs when the app is suspending.

Occurs when there is an underlying error that is routed to the CoreApplication instance, as part of global error handling logic.

Creates a new view for the app.

The view.

Creates a new view for the app.

The class ID of the view provider for the new view. If this parameter is null, use the current view provider. Additional info about the view, such as its class name in the app code. The view.

Creates a new view for the app.

The view provider for the new view. The view.

Decrements the total count of running app instances that use this CoreApplication instance.

Enable or disable the operating system's ability to prelaunch your app.

**True** to enable prelaunch for your app; **false**, otherwise.

Shuts down the app.

Gets the active view for the app.

The active view.

Increments the total count of running app instances that use this CoreApplication instance.

Restart the app.

The arguments to pass to the restarted instance. The status of the restart request.

Restart the app in the context of a different user.

The user to restart the app as. The arguments to pass to the restarted instance. The status of the restart request.

Runs an external view provider factory to obtain a view provider.

An implementation of a view provider factory.

Runs an activatable type factory to obtain an external activatable type.

An implementation of an activatable type factory.

Represents an app window and its thread.

Gets the app window associated with the current view.

The app window.

Gets the event message dispatcher associated with the current view.

The event message dispatcher.

Gets the **DispatcherQueue** for the window.

A **DispatcherQueue** instance.

Gets whether the app was launched as a component that is embedded in another app.

**True** if the app was launched as a component that is embedded in another app; **false** otherwise.

Gets the value that indicates whether this app view is hosted or not.

If **true**, this app view is hosted; if **false**, it is not.

Gets a value that indicates whether this app view is the main app view or not.

If **true**, this app view is the main; if **false**, it is not.

Gets properties that the app can associate with the view.

The property bag.

Gets the title bar associated with the current view.

The title bar associated with the current view.

Occurs when the view is activated.

Indicates that the hosted view is closing. Provides an opportunity for hosted window scenarios to defer the tear down of the hosted view.

Enables an app to define a custom title bar that displays in the app's window.

Gets or sets a value that specifies whether this title bar should replace the default window title bar.

Set to **true** to replace the default window title bar; otherwise, **false**.

Gets the height of the title bar.

The height of the custom title bar.

Gets a value that specifies whether this title bar is visible.

**true** if this title bar is visible; otherwise, **false**.

Gets the width of the system-reserved region of the upper-left corner of the app window. This region is reserved when the current language is a right-to-left language.

The width of the system-reserved region of the upper-left corner of the app window

Gets the width of the system-reserved region of the upper-right corner of the app window. This region is reserved when the current language is a left-to-right language.

The width of the system-reserved region of the upper-right corner of the app window.

Occurs when the visibility of the title bar (indicated by the IsVisible property) changes.

Occurs when the title bar needs to respond to size changes. The most common trigger for this event is when the app window moves to a screen that has a different DPI. Use this event to verify and update the positioning of UI elements that depend on the title bar's size.

Provides a Deferral you can call when the HostedViewClosing event fires to defer the tear down of the hosted view.

Provides an opportunity for hosted window scenarios to defer the tear down of the window, dispatcher, and Application Single-Threaded Apartment (ASTA) thread of the hosted view.

The deferral you can call to defer the tear down of the hosted view.

Adds an error handling event for global error handling from the system that app models can use.

Occurs when there is an error in an async completion handler, or an event handler, that wasn't otherwise handled by system or app code.

Represents an app view provider.

Initializes the app view. Called when an app object is launched.

The default view provided by the app object. You can use this instance in your implementation to obtain the CoreWindow created by the app object, and register callbacks for the Activated event.

Loads or activates any external resources used by the app view before Run is called.

The name of the entry point method for the activated type.

Starts the app view.

Sets the current window for the app object's view.

The current window for the app object.

Uninitializes the app view and releases external resources.

Defines a factory for view provider objects.

Returns a view provider object.

An object that implements a view provider.

Represents the error data for a system error as reported by an UnhandledErrorDetected event.

Gets a value that indicates whether the error has been handled.

**true** if the error has been handled. A value of **true** permits the app to continue. **false** if the error has not been handled. A value of **false** can result in the app being terminated once this event propagates to the Windows Runtime system.

Wraps the underlying error info in a language specific exception, and throws the error.

Provides UnhandledError event data for UnhandledErrorDetected events.

Gets the error info object that can be used to handle the event or propagate the error through a language-specific error.

An object that represents the unhandled error.

Gets and sets information from the clipboard object.

Occurs when the data stored in the Clipboard changes.

Occurs when a new item is added to the clipboard history.

Occurs when the OS setting that controls whether clipboard history is enabled for the current user is changed.

Occurs when the OS setting that controls whether clipboard data is set to sync across devices for the current user is changed.

Removes all data from the Clipboard.

Clears the clipboard history.

True if the clear history operation was successful; otherwise, false.

Deletes the specified item from the clipboard history.

The item to remove from the clipboard history. True if the item was successfully removed from the clipboard history; otherwise, false.

Adds the content to the Clipboard and releases the DataPackage object from the source app. This method allows the content to remain available after the application shuts down.

Gets the current content that is stored in the clipboard object.

Contains the content of the Clipboard.

Gets the list of items currently in the clipboard history.

An asynchronous operation that, on successful completion, returns a ClipboardHistoryItemsResult object that contains the items currently in the clipboard history.

Indicates whether clipboard history (that is, the ability to save multiple items to the clipboard) is enabled for the current user.

True if clipboard history is enabled for the current user; otherwise, false.

Indicates whether clipboard data is set to sync across devices for the current user.

True if clipboard data is set to sync across devices for the current user; otherwise, false.

Sets the current content that is stored in the clipboard object.

Contains the content of the clipboard. If **NULL**, the clipboard is emptied.

Sets the content that is stored in the clipboard object with options for the content.

Contains the content to store in the clipboard. If null, the clipboard is emptied. An object that specifies options for the clipboard content, such as whether the content is allowed in the clipboard history and whether it will be synced to other devices.

Sets an item in the clipboard history as the current content for the clipboard.

The item in the clipboard history to set as the current content for the clipboard. The status of the operation.

Specifies options for using the SetContentWithOptions method to set content in the clipboard.

Creates a new instance of the ClipboardContentOptions class.

Gets the list of data formats supported in the clipboard history for the content being added to the clipboard.

The list of data formats supported in the clipboard history for the content being added to the clipboard. We recommend that you add data formats to this list by using the static properties of the StandardDataFormats class.

Gets or sets a value that indicates whether the new content being added to the clipboard is allowed in the clipboard history.

True if the new content being added to the clipboard is allowed in the clipboard history; otherwise, false.

Gets or sets a value that indicates whether the new content being added to the clipboard can be synced to other devices.

True if the new content being added to the clipboard can be synced to other devices; otherwise, false.

Gets the list of data formats that can be synced to other devices for the content being added to the clipboard.

The list of data formats that can be synced to other devices for the content being added to the clipboard. We recommend that you add data formats to this list by using the static properties of the StandardDataFormats class.

Provides data for the HistoryEnabledChanged event.

Represents an item in the clipboard history.

Gets the data for the current item in the clipboard history.

The data for the current item in the clipboard history.

Gets the ID of the current item in the clipboard history.

The ID of the current item in the clipboard history.

Gets the date and time the current item was added to the clipboard history.

The date and time the current item was added to the clipboard history.

Provides response data for using the GetHistoryItemsAsync method to get the list of items currently in the clipboard history.

Gets the list of items in the clipboard history.

The list of ClipboardHistoryItem objects in the clipboard history.

Gets the return status of the call to the GetHistoryItemsAsync method to get the list of items currently in the clipboard history.

The return status of the call to the GetHistoryItemsAsync method.

Represents the return status of a call to the GetHistoryItemsAsync method to get the list of items currently in the clipboard history.

Access to the clipboard history is denied.

Clipboard history is disabled for the current user.

The request was successful.

Contains the data that a user wants to exchange with another app.

Constructor that creates a new DataPackage.

Allows you to get and set properties like the title of the content being shared.

A collection of properties that describe the data contained in a DataPackage.

Specifies the DataPackageOperation (none, move, copy, or link) for the operation.

The operation requested by the source app.

Maps a URI to a file. Used to ensure that referenced content (such as an image) in HTML content is added to the DataPackage.

Specifies a name/value pair that specifies the an HTML path with a corresponding StreamReference object.

Occurs when the DataPackage is destroyed.

Occurs when a paste operation is completed.

Raised when a share is canceled.

An event that is triggered when a share is completed. Shares can be sent to an app, a provider, or a contact.

Returns a DataPackageView object. This object is a read-only copy of the DataPackage object.

The object that is a read-only copy of the DataPackage object.

Sets the application link that a DataPackage contains.

A Uniform Resource Identifier (URI) with a scheme that isn't **http** or **https** that's handled by the source app.

Sets the bitmap image contained in the DataPackage.

A stream that contains the bitmap image.

Sets the data contained in the DataPackage in a RandomAccessStream format.

Specifies the format of the data. We recommend that you set this value by using the StandardDataFormats class. Specifies the content that the DataPackage contains.

Sets a delegate to handle requests from the target app.

Specifies the format of the data. We recommend that you set this value by using the StandardDataFormats class. A delegate that is responsible for processing requests from a target app.

Adds HTML content to the DataPackage.

The HTML content.

Sets the Rich Text Format (RTF) content that is contained in a DataPackage.

Specifies the Rich Text Format (RTF) content for the DataPackage.

Sets the files and folders contained in a DataPackage.

The files and folders to be added to the DataPackage.

Adds files and folders to a DataPackage.

The files and folders to be added to the DataPackage. Specify true if the files are read-only; false otherwise.

Sets the text that a DataPackage contains.

The text.

Sets the Uniform Resource Identifier (URI) that is contained in the DataPackage.

SetUri may be altered or unavailable for releases after Windows Phone 'OSVersion' (TBD).Instead, use SetWebLink or SetApplicationLink. The Uniform Resource Identifier (URI) that is contained in the DataPackage.

Sets the web link that a DataPackage contains.

A Uniform Resource Identifier (URI) with an **http** or **https** scheme that corresponds to the content being displayed to the user.

Specifies the operation to perform on the DataPackage in clipboard and drag and drop scenarios.

Copies the content to the target destination. When implementing clipboard functionality, this corresponds to the "Copy" command.

Creates a link for the data.

Copies the content to the target destination and deletes the original. When implementing clipboard functionality, this corresponds to the "Cut" command.

No action. Typically used when the DataPackage object requires delayed rendering.

Defines a set of properties to use with a DataPackage object.

Gets or sets the Uniform Resource Identifier (URI) of the app's location in the Windows Store.

The Uniform Resource Identifier (URI) of the app in the Windows Store.

Gets or sets the name of the app that created the DataPackage object.

Specifies the name of the app that created the DataPackage object.

Gets or sets the application link to the content from the source app.

The Uniform Resource Identifier (URI) of the application link to shared content.

Gets or sets the UserActivity in serialized JSON format to be shared with another app.

The UserActivity in serialized JSON format to be shared with another app.

Provides a web link to shared content that's currently displayed in the app.

The Uniform Resource Identifier (URI) of the web link to shared content.

Gets or sets text that describes the contents of the DataPackage.

Text that describes the contents of the DataPackage.

Gets or sets the enterprise identity (see Enterprise data protection ).

The enterprise Id.

Specifies a vector object that contains the types of files stored in the DataPackage object.

Contains the types of files stored in the DataPackage object.

Gets or sets a background color for the sharing app's Square30x30Logo.

The color of the logo's background.

Gets or sets the package family name of the source app.

The package family name.

Gets the number of items that are contained in the property set.

The number of elements in the property set.

Gets or sets the source app's logo.

The logo's bitmap.

Gets or sets a thumbnail image for the DataPackage.

The IRandomAccessStreamReference that represents the thumbnail image.

Gets or sets the text that displays as a title for the contents of the DataPackage object.

The text that displays as a title for the contents of the DataPackage object.

Removes all items from the property set.

Returns an iterator to enumerate the items in the property set.

The first item in the DataPackage object.

Gets an immutable view of the property set.

The immutable view.

Indicates whether the DataPackagePropertySet object contains a specific property.

The key. True if the property set has an item with the specified key; otherwise false.

Adds a property to the DataPackagePropertySet object.

The key to insert. The value to insert. True if the method replaced a value that already existed for the key; false if this is a new key.

Retrieves the value of a specific property.

The key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the property set.

The key.

Gets the set of properties of a DataPackageView object.

Gets the Uniform Resource Identifier (URI) of the app's location in the Microsoft Store.

The Uniform Resource Identifier (URI) of the app in the Microsoft Store.

Gets the name of the app that created the DataPackage object.

The name of the app that created the DataPackage object.

Gets the application link to the content from the source app.

The Uniform Resource Identifier (URI) of the application link to shared content.

Gets the UserActivity in serialized JSON format to be shared with another app.

The UserActivity in serialized JSON format to be shared with another app.

Gets a web link to shared content that's currently displayed in the app.

The Uniform Resource Identifier (URI) of the web link to shared content.

Gets the text that describes the contents of the DataPackage.

Text that describes the contents of the DataPackage.

Gets or sets the enterprise Id.

The enterprise Id.

Gets a vector object that contains the types of files stored in the DataPackage object.

Contains the types of files stored in the DataPackage object.

Gets a value that indicates whether the shared content in the DataPackageView comes from clipboard data that was synced from another device for the current user.

True if the shared content in the DataPackageView comes from clipboard data that was synced from another device for the current user; otherwise, false.

Gets a background color for the sharing app's Square30x30Logo.

The background color for the sharing app's Square30x30Logo.

Gets the package family name of the source app.

The package family name.

Gets the number of items that are contained in the property set.

The number of elements in the property set.

Gets the source app's logo.

The logo's bitmap.

Gets the thumbnail image for the DataPackageView.

The IRandomAccessStreamReference that represents the thumbnail image.

Gets the text that displays as a title for the contents of the DataPackagePropertySetView object.

The text that displays as a title for the contents of the DataPackagePropertySetView object.

Returns an iterator to enumerate the items in the property set.

The first item in the DataPackage object.

Indicates whether the DataPackagePropertySetView object contains a specific property.

The key. True if the property set has an item with the specified key; otherwise false.

Retrieves the value of a specific property.

The key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Divides the object into two views

The first half of the object. The second half of the object.

A read-only version of a DataPackage. Apps that receive shared content get this object when acquiring content.

Returns the formats the DataPackageView contains.

The formats the DataPackageView contains.

Gets a DataPackagePropertySetView object, which contains a read-only set of properties for the data in the DataPackageView object.

The object that contains a read-only set of properties for the data.

Gets the requested operation (such as copy or move). Primarily used for Clipboard actions.

An enumeration that states what operation (such as copy or move) was completed.

Checks to see if the DataPackageView contains a specific data format.

The name of the format. True if the DataPackageView contains the format; false otherwise.

Gets the application link in the DataPackageView object.

The application link.

Gets the bitmap image contained in the DataPackageView

A stream containing the bitmap image.

Gets the data contained in the DataPackageView.

Specifies the format of the data. We recommend that you set this value by using the StandardDataFormats class. The data.

Gets the HTML stored in the DataPackageView object.

The HTML.

Gets the data (such as an image) referenced in HTML content.

The data referenced in the HTML content.

Gets the rich text formatted (RTF) content contained in a DataPackageView.

The rich text formatted content for the DataPackage.

Gets the files and folders stored in a DataPackageView object.

An array of files and folders stored in a DataPackageView.

Gets the text in the DataPackageView object.

The text.

Gets the text in the DataPackageView object.

A string that represents the data format. Usually StandardDataFormats.text. The text.

Gets the URI contained in the DataPackageView.

GetUriAsync may be altered or unavailable for releases after Windows 8.1. Instead, use GetWebLinkAsync or GetApplicationLinkAsync. The Uri.

Gets the web link in the DataPackageView object.

The web link.

Informs the system that your app is finished using the DataPackageView object. Primarily used for Clipboard operations.

An enumeration that states what operation (such as copy or move) was completed. At most one operation flag can be set.

Requests permission to unlock and access a data package that is secured with a protection policy.

When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible.

Requests permission to unlock and access a data package that is secured with a protection policy.

The enterprise Id. When this method completes, it returns the results of the protection policy evaluation, which indicates whether or not the data is accessible.

Sets the accepted format Id.

The format Id.

Unlocks a data package and assumes an enterprise identity for it.

When this method completes, it returns the results of the protection policy evaluation.

Used by a source app's deferral delegate to notify a DataPackage object that the source app will produce data from another asynchronous function.

Informs a DataPackage that it is ready for processing.

Provides data when the target app requests it, instead of including the data in the DataPackage ahead of time. [ DataProviderHandler is used when the source app wants to avoid unnecessary work that is resource intensive, such as performing format conversions.

Contains the data that the user wants to share.

An object of this type is passed to the DataProviderHandler delegate.

Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored.

The deadline for the delayed rendering operation.

Specifies the format id.

The format id. See StandardDataFormats for more information.

Returns a DataProviderDeferral object.

An data provider deferral object.

Sets the content of the DataPackage to be shared with a target app.

The object associated with a particular format in the DataPackage.

Lets your app supply the content the user wants to share or specify a message, if an error occurs.

Sets or gets a DataPackage object that contains the content a user wants to share.

Contains the content a user wants to share.

Gets the deadline for finishing a delayed rendering operation. If execution goes beyond that deadline, the results of delayed rendering are ignored.

The deadline for the delayed rendering operation.

Cancels the sharing operation and supplies an error string to display to the user.

The text to display to the user.

Supports asynchronous sharing operations by creating and returning a DataRequestDeferral object.

An object that allows you to share or send content asynchronously.

Enables you to exchange content with a target app asynchronously.

Indicates that the content for an asynchronous share is ready for a target app, or that an error in the sharing operation occurred.

Contains information about the DataRequested event. The system fires this event when the user invokes the Share UI.

Enables you to get the DataRequest object and either give it data or a failure message.

The object used to manage content as part of a share operation.

Programmatically initiates an exchange of content with other apps.

Occurs when a share operation starts.

An event that is triggered when the share providers are requested. This is used as a callback and providers are added by subscribing to this event and calling ShareProvidersRequestedEventArgs.Providers.Add() in the event handler.

Occurs when the user chooses a target app in the Share charm.

Returns the DataTransferManager object associated with the current window.

The DataTransferManager object associated with the current window.

Returns true if the device supports sharing, false otherwise.

True if the device supports sharing, false otherwise.

Programmatically initiates the user interface for sharing content with another app.

Programmatically initiates the user interface for sharing content with another app.

The options.

Responsible for formatting HTML content that you want to share or add to the Clipboard. Also allows you to get HTML fragments from the content.

Takes a string that represents HTML content and adds the necessary headers to ensure it is formatted correctly for share and Clipboard operations.

A string representing the HTML content. A string representing the formatted HTML.

Gets a string that represents an HTML fragment.

The formatted HTML. An HTML fragment based on the formatted HTML.

Contains info about the action that a target app completed during a paste operation.

Gets the accepted format Id.

The accepted format Id.

Specifies the operation that the target app completed.

An enumeration that specifies what operation (such as copy or move) was completed. At most one operation flag can be set.

Represents the return status of a call to the SetHistoryItemAsContent method to set an item in the clipboard history as the current content for the clipboard.

Access to the clipboard history is denied.

The specified item was deleted.

The request was successful.

This class contains the event args for ShareCompleted.

Gets the share target.

The share target.

Enables an app to share a file with another app by passing a token via Uri activation, app service, REST API, etc. The target app redeems the token to get the file shared by the source app.

Gets the sharing token that enables an app to share the specified file with another app.

The file to share with the target app. The sharing token to provide to the target app .

Gets a file shared by another app by providing the sharing token received from the source app.

The sharing token for the shared file. A wrapper object that contains the shared file.

Revokes an existing sharing token.

The sharing token to revoke.

This class represents a custom provider which can be shared.

Creates a new ShareProvider object.

The title of the share provider. The display icon of the share provider. The background color of the share provider. The handler of the share provider.

Gets the background color of the share provider.

The background color of the share provider.

Gets the display icon of the share provider.

The display icon of the share provider.

Gets or sets the tag of the share provider.

The tag of the share provider.

Gets the title of the share provider.

The title of the share provider.

A delegate that handles share providers.

# Windows.ApplicationModel.DataTransfer.ShareProviderHandler

This class represents a share provider operation.

Gets the data of the operation.

The data of the operation.

Gets the share provider.

The share provider.

Completes the report.

The event args of ShareProvidersRequested.

Gets the data.

The data.

Gets the share providers.

Requests a deferral to complete actions on this object in an event handler.

The deferral.

This class contains information about a share target.

Gets the app user model ID.

The app user model ID.

Gets the share provider.

The share provider.

This class represents the options that are available to the user when showing the ShareUI.

Creates a new ShareUIOptions object.

Gets or sets the selection rectangle.

The selection rectangle.

Gets or sets the share UI theme.

The share UI theme.

The theme for the Share UI.

Dark theme.

Default theme.

Light theme.

Contains static properties that return string values. Each string corresponds to a known format ID. Use this class to avoid errors in using string constants to specify data formats.

A read-only property that returns the format ID string value corresponding to the activation link format.

The format ID string value corresponding to the application link format.

A read-only property that returns the format ID string value corresponding to the Bitmap format.

The format ID string value corresponding to the Bitmap format.

A read-only property that returns the format ID string value corresponding to the HTML format.

The format ID string value corresponding to the HTML format.

A read-only property that returns the format ID string value corresponding to the Rich Text Format (RTF).

The format ID string value corresponding to the Rich Text Format (RTF) format.

A read-only property that returns the format ID string value corresponding to the StorageItem format.

The format ID string value corresponding to the StorageItem format.

A read-only property that returns the format ID string value corresponding to the Text format.

The format ID string value corresponding to the Text format.

A read-only property that returns the format ID string value corresponding to the Uniform Resource Identifier (URI) format.

The format ID string value corresponding to the Uniform Resource Identifier (URI) format.

A read-only property that returns the format ID string value corresponding to the UserActivity JSON array format.

The format ID string value corresponding to the UserActivity JSON array format.

A read-only property that returns the format ID string value corresponding to the web link format.

The format ID string value corresponding to the web link format.

Contains information about the target app the user chose to share content with. To get this object, you must handle the TargetApplicationChosen event.

Contains the name of the app that the user chose to share content with.

The name of the app.

Represents the key modifiers applied to a drag and drop operation. Zero or more modifiers can be included.

The alt key.

The control key.

The left mouse button.

The middle mouse button.

No modifiers.

The right mouse button.

The shift key.

Manages access for drag and drop within and between apps.

Gets or sets whether concurrent drag and drop operations are enabled.

True if concurrent drag and drop operations are enabled; otherwise, false.

Occurs when a drag and drop target is requested.

Gets the core drag and drop manager associated with the currently visible application window.

The core drag and drop manager associated with the currently visible application window.

Gets information about an item being dragged.

Gets the allowed DataPackageOperations (none, move, copy, and/or link) for the drag and drop operation.

The allowed operations.

Gets the DataPackageView for the item being dragged.

The DataPackageView for the item being dragged.

Gets the modifiers for the item being dragged.

The modifiers for the item being dragged.

Gets the position of the item being dragged.

The position of the item being dragged.

Handles a drag and drop operation.

Initializes a new instance of the CoreDragOperation class.

Gets or sets the allowed DataPackageOperations (none, move, copy, and/or link) for the drag and drop operation.

The allowed operations. The default is **Copy** | **Move** | **Link**.

Gets the DataPackage for the drag and drop operation.

The DataPackage for the drag and drop operation

Gets or sets the content mode for the drag UI.

The content mode for the drag UI.

Sets custom drag UI content using a software bitmap.

The custom UI drag content.

Sets custom drag UI content using a software bitmap.

The custom UI drag content. The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50).

Sets the pointer Id.

The pointer Id.

Starts the drag and drop operation.

The data package operation.

Represents modes for overriding the drag UI. Use this to specify whether the operation should wait for content load before starting, or run in parallel.

Specifies content will be provided synchronously.

Specifies content will be provided with an asynchronous task.

Contains methods and properties for customizing the drag and drop UI.

Gets or sets the caption for the drag UI.

The caption for the drag UI.

Gets or sets if the caption for the drag UI is visible.

True if the caption is visible; otherwise, false.

Gets or sets whether the drag content is visible.

True if the drag content is visible; otherwise, false.

Gets or sets whether the glyph is visible.

True if the glyph is visible; otherwise, false.

Clears all existing custom UI overrides.

Sets custom drag UI content using a software bitmap.

The custom drag UI content.

Sets custom drag UI content using a software bitmap.

The custom UI drag content. The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50).

Provides the ability to set the target of a drag and drop operation when a target is requested.

Sets the target of the drag and drop operation.

The target of the drag and drop operation.

Contains methods required for supporting drag and drop.

Called when a dragged item is dropped.

The core drag information. The data package operation.

Called when the dragged item enters the drop area.

The core drag information. Overrides to default the drag UI. When this method completes, it returns the data package operation.

Called when a dragged item leaves the target drop area.

The core drag information. This method does not return an object or value.

Called when the dragged item is over the drop area.

The core drag information. Overrides to default the drag UI. When this method completes, it returns the data package operation.

Represents shortcuts that help users share content with the apps they use most.

Creates a new instance of a QuickLink object.

Specifies an ID for the QuickLink. Your app receives this ID when the user selects its QuickLink. You can use this ID to further customize the sharing process for the user.

Specifies the ID for the QuickLink.

An array of strings that specify the data formats supported by the QuickLink app. The system shows the QuickLink only when the data that a user wants to share matches a format in this array.

An array of format ids that specify the data formats supported by the QuickLink app.

An array of strings that specify the file types supported by a QuickLink app. The system shows the QuickLink only when the data that a user wants to share contains file items, and the file extensions for those file items match a file type in this array.

An array of file extensions that specify the file types supported by the QuickLinks app.

Specifies a thumbnail image for the QuickLink. The system displays this image when the user is presented with a list of possible apps to share content with.

Contains the thumbnail image to use with the QuickLink.

Specifies the title of a QuickLink. The system displays this info when the user is presented with a list of possible apps to share content with.

Specifies the title of the QuickLink.

Handles the bulk of the work during a share operation. This includes the data that the user wants to share, setting or removing QuickLinks, and informing the system about the status of the operation.

Gets the contacts for the share operation.

The contacts for the share operation.

Contains a DataPackage object with the data that the user wants to share.

Contains the data that the user wants to share.

A string that contains the ID of a QuickLink.

The ID of the QuickLink.

Closes the share pane.

Removes the QuickLink from the list of QuickLinks that are available to the user.

Specifies that the sharing operation is complete.

Specifies that the sharing operation is complete. A QuickLink that the system can save as a shortcut for future sharing operations is included.

A QuickLink object that the system saves as a shortcut for future sharing operations.

Specifies that the app has acquired the content that the user wants to share.

Specifies that an error occurred during the sharing operation.

Specifies the error message. The system displays this message to the user.

Specifies that the app has started to acquire the content that the user wants to share.

Specifies that the app has requested that the system allow the sharing operation to run as a background task.

Represents an email attachment.

Initializes a new instance of the EmailAttachment class.

Initializes a new instance of the EmailAttachment class with the specified random access stream.

The file name to use for the attachment. A random access stream containing the data for the attachment.

Initializes a new instance of the EmailAttachment class.

The filename of the attachment. The stream to use to download the attachment. The MIME type of the attachment.

Gets or sets a value that identifies the content of the attachment on a remote system.

A value that identifies the content of the attachment.

Gets or sets the location of an email attachment as a Uniform Resource Identifier (URI).

The location of an email attachment as a Uniform Resource Identifier (URI).

Gets or sets the email attachment's data.

The email attachment data.

Gets or sets the download state of the email attachment.

The download state of the email attachment.

Gets or sets the estimated download size of the attachment.

The estimated download size of the attachment.

Gets or sets the displayed file name for the email attachment.

The displayed file name for the email attachment.

Gets the locally unique ID for the email attachment.

The locally unique ID for the email attachment.

Gets a Boolean value indicating if the attachment came from the base message.

A Boolean value indicating if the attachment came from the base message.

Gets or sets a Boolean property indicating if the attachment is included inline, in the body of the message.

A Boolean property indicating if the attachment is included inline.

Gets or sets the MIME type of the attachment.

The MIME type of the attachment.

Defines the states of an email attachment download.

The attachment has been downloaded.

The attachment is currently downloading.

The attachment has failed.

The attachment is not yet downloaded.

Defines the states of an email batch operation.

The batch operation has failed due to a sync manager error.

The batch operation has failed due to an unknown error.

The batch operation has completed successfully.

Describes the result of an attempt to validate a certificate.

Validation failed. One or more certificates in the chain, other than the current certificate, have been revoked.

Validation failed. Certificate expired.

Validation failed. Certificate is not valid.

Validation failed. Invalid usage of certificate.

Validation failed. No matching certificate found.

Validation failed. Revocation server failure.

Validation failed. Certificate revoked.

Validation failed. Server failure.

Success. Certificate validated.

Validation failed. Unknown failure.

Validation failed. Certificate untrusted.

Represents an email conversation.

Gets the EmailFlagState for the conversation.

The EmailFlagState for the conversation.

Gets a Boolean value indicating if the conversation has an attachment.

A Boolean value indicating if the conversation has an attachment.

Gets the unique identifier for the EmailConversation.

The unique identifier for the EmailConversation.

Gets the value that specifies the importance of the conversation; normal, high or low.

The value that specifies the importance of the conversation; normal, high or low.

Gets the last EmailMessageResponseKind for the conversation.

The last EmailMessageResponseKind for the conversation.

Gets the latest sender in the conversation.

The latest sender in the conversation.

Gets the ID for the mailbox.

The ID for the mailbox.

Gets the number of messages in the conversation.

The number of messages in the conversation.

Gets the ID of the most recent message in the conversation.

The ID of the most recent message in the conversation.

Gets the time of the most recent message in the conversation.

The time of the most recent message in the conversation.

Gets a preview of the latest message in the conversation.

A preview of the latest message in the conversation.

Gets the subject of the latest message in the conversation.

The subject of the latest message in the conversation.

Gets the number of unread messages in the conversation.

The number of unread messages in the conversation.

Asynchronously gets a batch of messages in the conversation.

The batch of messages.

Asynchronously gets a batch of messages in the conversation.

The size of the batch of messages to retrieve. The batch of messages.

Represents a group of EmailConversation objects for batch processing.

Gets a list of EmailConversation objects to use for batch processing.

A list of EmailConversation objects to use for batch processing.

Gets the status of the last batch processing operation.

The status of the last batch processing operation.

Reads a batch of email conversations.

Asynchronously reads a batch of email conversations.

Returns a batch of email conversations.

Defines the flag state of an email message.

The email was flagged for follow up and the flag has been cleared.

The email was flagged for follow up and has been marked completed.

The email has been flagged for follow up.

The email has not been flagged for follow up.

Represents an email folder.

Gets or sets the display name for the folder.

The display name for the folder.

Gets the ID of the email folder.

The ID of the email folder.

Gets or sets a Boolean value indicating if the folder is sync enabled.

A Boolean value indicating if the folder is sync enabled.

Gets the type of the folder such as inbox, outbox, drafts, sent, and so on.

The type of the folder such as inbox, outbox, drafts, sent, and so on.

Gets or sets the last time the folder was successfully synced with the server.

The last time the folder was successfully synced with the server.

Gets the ID of the mailbox that contains this folder.

The ID of the mailbox that contains this folder.

Gets the ID of this folder's parent folder.

The ID of this folder's parent folder.

Gets or sets the remote ID of the corresponding folder on the server.

The remote ID of the corresponding folder on the server.

Asynchronously creates a new folder.

The name for the new folder. Returns the newly created folder.

Asynchronously deletes this folder.

An async action indicating that the operation has completed.

Asynchronously finds the child folders of this folder.

The list of child folders.

Gets an instance of the EmailConversationReader class.

The conversation reader.

Gets an instance of the EmailConversationReader class using the specified query options.

The query options to use when finding the conversation reader. The conversation reader that matches the query options.

Asynchronously gets the specified message from the folder.

The ID of the message to retrieve. The message specified in the *id* parameter.

Asynchronously gets the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on.

An EmailItemCounts object containing the counts of email items such as flagged emails, important emails, unread emails, total emails, and so on.

Gets an instance of the EmailMessageReader class.

The message reader.

Gets an instance of the EmailMessageReader class using the specified query options.

The query options to use when finding the message reader. The message reader that matches the query options.

Asynchronously saves the specified email message to the folder.

The email message to save. An async action indicating that the operation has completed.

Asynchronously attempts to move this folder to the specified folder.

The new location for this folder. A Boolean value indicating if the move was successful.

Asynchronously attempts to move this folder to the specified folder and rename it in the process.

The new location for this folder. The name for the folder in the new location. A Boolean value indicating if the move was successful.

Asynchronously attempts to save changes to the folder.

A Boolean value indicating if the save was successful.

Defines the importance of an email message.

The email message is of high importance.

The email message is of low importance.

The email message is of normal importance.

Represents email information rights management (IRM) info.

Initializes a new instance of the EmailIrmInfo class.

Initializes a new instance of the EmailIrmInfo class using the specified IRM expiration time and template.

The time when the information rights management (IRM) permissions expire. The IRM template to apply to the message.

Gets or sets a Boolean value that indicates if an email message is allowed to be edited.

A Boolean value that indicates if an email message is allowed to be edited.

Gets or sets a Boolean value that indicates if the user can copy the contents of an email message to the clipboard.

A Boolean value that indicates if the user can copy the contents of an email message to the clipboard.

Gets or sets a Boolean value that indicates if the email message is allowed to be forwarded.

A Boolean value that indicates if the email message is allowed to be forwarded.

Gets or sets a Boolean value that indicates if the user is allowed to change any of the email recipients when responding.

A Boolean value that indicates if the user is allowed to change any of the email recipients when responding.

Gets or sets a Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments.

A Boolean value that indicates if the user is allowed to print the contents of the email message or any attachments.

Gets or sets a Boolean value that indicates if the recipient is allowed to remove information rights management (IRM) when responding.

A Boolean value that indicates if the recipient is allowed to remove IRM when responding.

Gets or sets a Boolean value that indicates if the recipient is allowed to reply to the email message.

A Boolean value that indicates if the recipient is allowed to reply to the email message.

Gets or sets a Boolean value that indicates if the recipient is allowed to reply all to the email message.

A Boolean value that indicates if the recipient is allowed to reply all to the email message.

Gets or sets the expiration date for the information rights management (IRM) permissions.

The expiration date for the IRM permissions.

Gets or sets a Boolean value that indicates if the sender is the information rights management (IRM) originator.

A Boolean value that indicates if the sender is the information rights management (IRM) originator.

Gets or sets a Boolean value that indicates if programmatic access to the message is allowed.

A Boolean value that indicates if programmatic access to the message is allowed.

Gets or sets the EmailIrmTemplate used to create the information rights management (IRM) info.

The EmailIrmTemplate used to create the information rights management (IRM) info.

Represents a template that can be used to create new EmailIrmInfo objects.

Creates a new instance of the EmailIrmTemplate class.

Creates a new instance of the EmailIrmTemplate class with the specified ID, name and description.

The ID for the new template. The name of the new template. The description of the new template.

Gets or sets the description of the template.

The description of the template.

Gets or sets the ID for the template.

The ID for the template.

Gets or sets the name for the template.

The name for the template.

Represents the counts for various email message attributes such as flagged, important, unread, and so on.

Gets the number of flagged email messages.

The number of flagged email messages.

Gets the number of important email messages.

The number of important email messages.

Gets the total number of email messages

The total number of email messages.

Gets the number of unread email messages.

The number of unread email messages.

Represents an email mailbox located on a remote email server.

Gets the capabilities associated with the mailbox.

The capabilities associated with the mailbox.

Gets the EmailMailboxChangeTracker for this mailbox.

The change tracker for this mailbox.

Gets or sets the name for this mailbox that is suitable for displaying.

The name for this mailbox that is suitable for displaying.

Gets the ID for this mailbox.

The ID for this mailbox.

Gets a Boolean value that indicates if email data is encrypted when the device is locked.

Boolean value that indicates if email data is encrypted when the device is locked.

Gets a Boolean value that indicates if this mailbox is owned by the current app.

Boolean value that indicates if this mailbox is owned by the current app.

Gets the identifier for a mailbox linked to this one.

The identifier for a mailbox linked to this one.

Gets or sets the email address for the mailbox.

The email address for the mailbox.

Gets the list of email aliases associated with this mailbox.

The list of email aliases associated with this mailbox.

Gets the identifier of the email mailbox account within its network.

The identifier of the email mailbox account within its network.

Gets the identifier of the network associated with this email mailbox.

The identifier of the network associated with this email mailbox.

Gets or sets the read access level to this mailbox for other apps.

The read access level to this mailbox for other apps.

Gets or sets the write access level to this mailbox for other apps.

The write access level to this mailbox for other apps.

Gets the security policies for attachments in this mailbox.

The security policies for attachments in this mailbox.

Gets the display name of the source mailbox.

The display name of the source mailbox.

Gets the sync manager for the mailbox.

The sync manager for the mailbox.

Gets the ID of the user data account for the mailbox.

The ID of the user data account for the mailbox.

Occurs when the mailbox has changed.

Asynchronously changes the flag state of an email message.

The ID of the email message to change. The new email flag state. An async action indicating that the operation has completed.

Creates a new response email such as Reply, Reply All, Forward, and so on.

The ID of the message to which to respond. The type of response such as Reply, Reply All, Forward, and so on. The subject for the response message. The format of the email body such as plain text or HTML. The header for the response message. The newly created response email message.

Asynchronously deletes the mailbox.

An async action indicating that the operation has completed.

Asynchronously deletes an email message from the mailbox.

The ID of the email message to delete. An async action indicating that the operation has completed.

Asynchronously downloads an email attachment.

The ID of the attachment to download. An async action indicating that the operation has completed.

Asynchronously downloads the specified email message.

The ID of the message to download. An async action indicating that the operation has completed.

Gets a EmailMailboxChangeTracker that provides functionality for monitoring changes to items in the EmailMailbox.

A string that identifies the EmailMailboxChangeTracker instance in the EmailMailbox. A EmailMailboxChangeTracker that provides functionality for monitoring changes to items in the EmailMailbox.

Asynchronously gets the specified email conversation.

The ID of the email conversation to retrieve. Returns the email conversation specified by the *id* parameter.

Gets or creates an email conversation reader for this mailbox if one does not already exist.

The email conversation reader.

Gets or creates an email conversation reader for this mailbox using the specified query options.

The email query options to use when creating the conversation reader. The new or existing conversation reader.

Asynchronously gets the specified email folder.

The ID of the folder to retrieve. The email folder specified in the *id* parameter.

Asynchronously gets the specified email message.

The ID of the message to retrieve. The email message specified in the *id* parameter.

Gets or creates an email message reader for this mailbox if one does not already exist.

The new or existing email message reader.

Gets or creates an email conversation reader for this mailbox using the specified query options.

The email query options to use when creating the message reader. The new or existing email message reader.

Asynchronously get a special email folder such as Inbox, Outbox, Drafts and so on.

The type of folder to retrieve. The matching special email folder in this mailbox.

Asynchronously marks all the messages in a folder as seen.

The ID of the folder to mark as seen. An async action indicating that the operation has completed.

Asynchronously marks a folder as sync enabled or disabled.

The ID of the folder to mark. True to enable to syncing with the server, false to disable syncing. An async action indicating that the operation has completed.

Asynchronously marks an email message as seen.

The ID of the message to mark as seen. An async action indicating that the operation has completed.

Asynchronously marks an email message as read or unread.

The ID of the message to mark. True to mark the message as read, false to mark it as unread. An async action indicating that the operation has completed.

Asynchronously registers this mailbox as a sync provider.

An asynchronous registration operation.

Resolves a list of one or more email addresses.

The list of email addresses. A list of resolution results. The result list will be in the same order as the input list. See EmailRecipientResolutionResult for more information.

Asynchronously saves the mailbox to the email store.

An async action indicating that the operation has completed.

Asynchronously saves a draft email message.

The draft email message to save. An async action indicating that the operation has completed.

Asynchronously sends the specified email message.

The email message to send. An async action indicating that the operation has completed.

Asynchronously sends the specified email message.

The email message to send. True to send only the updated text, false to include the full message thread. An async action indicating that the operation has completed.

Asynchronously attempts to create a new email folder.

The Id of the parent email folder. The name for the new folder. An async operation with an EmailMailboxCreateFolderResult containing the newly created folder and the status of the create operation.

Asynchronously attempts to delete an email folder.

The Id of the folder to delete. An async operation with an EmailMailboxDeleteFolderStatus value representing the status of the delete operation.

Asynchronously attempt to delete the contents of an email folder.

The Id of the folder to empty. An async operation with an EmailMailboxEmptyFolderStatus value representing the status of the delete operation.

Asynchronously attempts to forward a meeting request.

The meeting to forward. The list of new recipients. The subject of the email. The email message format, HTML or plain text. The email forward header. The body of the message. A Boolean value indicating if the meeting was successfully forwarded.

Asynchronously attempts to get the auto-reply settings for the mailbox.

The requested text format of the auto-reply message, HTML or plain text. The auto-reply settings.

Asynchronously attempts to move the specified email folder.

The folder to move. The new parent for the folder specified in the *folderId* parameter. A Boolean value indicating if the move was successful.

Asynchronously attempts to move the specified email folder and rename it in the process.

The folder to move. The new parent for the folder specified in the *folderId* parameter. The name for the folder in the new location. A Boolean value indicating if the move was successful.

Asynchronously attempts to move the specified email message.

The ID of the email message to move. The ID of the new folder where the email message should reside. A Boolean value indicating if the move was successful.

Asynchronously attempts to send a meeting request proposing a new time.

The meeting for which to propose a new time. The proposed new time for the meeting to start. The proposed duration of the meeting. The subject of the meeting email. The body of the message. A Boolean value indicating if the proposed meeting message was successfully sent.

Asynchronously attempts to set the auto-reply settings for the mailbox.

The new auto-reply settings. A Boolean value indicating if the operation was successful.

Asynchronously attempts to respond to a meeting request.

The meeting request. The response to the meeting request, accept, decline, or tentative. The subject of the response email message. The body of the response email message. A Boolean indicating whether or not to send a response to the meeting originator. A Boolean value indicating if the response was sent successfully.

Validates the certificate against the sync provider service.

The certificate to validate. The confirmation that the certificate is valid.

Provides data about a change that occurred to a mailbox.

Gets the number that identifies the change that happened to the mailbox.

The number that identifies the change that occurred to the mailbox.

Gets the value that represents the kind of change that happened to the mailbox.

The kind of change that happened to the mailbox.

Defines the kind of action to be taken.

Change the flag state on the email message.

Create an email message to be forwarded containing the content of this email message.

Create a reply email message addressed to the sender and all recipients in response to this email message.

Create a reply email message addressed to the sender in response to this email message.

Enable sync for this folder.

Mark the email message as seen.

Mark the email message as having been read.

Move this folder.

Move the email message.

Save a draft of the email message.

Send the email message.

Defines the type of negotiation on encryption algorithms permitted by the server.

Minimal encryption is required.

No negotiation is allowed.

Strong encryption is required.

Represents an auto-reply message set on a mailbox.

Gets or sets a Boolean value that indicates if the auto-reply message is enabled.

A Boolean value that indicates if the auto-reply message is enabled.

Gets or sets the auto-reply response text.

The auto-reply response text.

Defines the encoding schema used for automatic replies.

The autoreply message is encoded as HTML.

The autoreply message is encoded as plain text.

Represents the settings for the automatic reply functionality of an email account.

Initializes a new instance of an object.

Represents the end time for the automated reply period.

The end time for the automated reply period.

Gets the automatic reply message intended for an email message from an internal sender.

The automatic reply message intended for an email message from an internal sender.

Gets a Boolean value indicating whether automatic replies are enabled.

A Boolean value indicating whether automatic replies are enabled.

Gets the automatic reply message intended for an email message from a known external sender.

The automatic reply message intended for an email message from a known external sender.

Gets or sets whether the automated response email message is encoded as HTML or plain text.

The encoding schema for an email message.

Represents the start time for the automated reply period.

The start time for the automated reply period.

Gets the automatic reply message intended for an email message from an unknown external sender.

The automatic reply message intended for an email message from an unknown external sender.

Represents the capabilities associated with an email mailbox.

Gets or sets a Boolean value indicating if folders can be created in the mailbox.

A Boolean value indicating if folders can be created in the mailbox.

Gets or sets a Boolean value indicating if folders can be deleted from the mailbox.

A Boolean value indicating if folders can be deleted from the mailbox.

Gets or sets a Boolean value indicating if folders in the mailbox can be emptied.

A Boolean value indicating if folders in the mailbox can be emptied.

Gets or sets a Boolean value indicating whether an account is allowed to forward meeting requests.

A Boolean value indicating whether an account is allowed to forward meeting requests.

Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences.

A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for external audiences.

Gets or sets a Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences.

A Boolean value indicating whether an account is allowed to get and set automatic reply email messages intended for internal audiences.

Gets or sets a Boolean value indicating if folders in the mailbox can be moved.

A Boolean value indicating if folders in the mailbox can be moved.

Gets or sets a Boolean value indicating whether an account is allowed to propose a new meeting time.

A Boolean value indicating whether an account is allowed to propose a new meeting time.

Gets or sets a Boolean value that indicates whether the email mailbox is capable of resolving recipients.

The Boolean value that indicates whether the email mailbox is capable of resolving recipients.

Gets or sets a Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox.

The Boolean value indicating whether a search of specific folders on the server can be initiated from this email mailbox.

Gets or sets a Boolean value indicating whether a search of the server can be initiated from this email mailbox.

The Boolean value indicating whether a search of the server can be initiated from this email mailbox.

Gets or sets a Boolean value indicating whether the email mailbox is allowed to attempt smart send.

The Boolean value indicating whether the email mailbox is allowed to attempt smart send.

Gets or sets a Boolean value indicating whether the email mailbox is allowed to update meeting responses.

The Boolean value indicating whether the email mailbox is allowed to update meeting responses.

Gets or sets a Boolean value that indicates whether the email mailbox is capable of validating certificates.

The Boolean value that indicates whether the email mailbox is capable of validating certificates.

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Gets the type of change that was made to the mailbox. This includes whether it was a folder or message that was changed and whether the item was created, deleted, or modified, or if change tracking was lost for this change.

The type of change that was made to the mailbox.

Gets the folder to which the change applies.

The folder to which the change applies.

Gets the flags that indicate what actions have been affected on the mailbox.

The flags that indicate what actions have been affected on the mailbox.

Gets the message to which the change applies.

The message to which the change applies.

Represents a deferred process that will halt a thread until the deferral is complete.

Indicates to waiting processes that the deferral is complete.

Represents the deferral process.

Gets the deferral object.

The deferral object.

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Accepts all changes.

Accepts all changes through the current change.

The current change.

Reads a collection of changes.

A batch of changes.

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Gets a Boolean value indicating whether change tracking is active.

The Boolean value indicating whether change tracking is active.

Enables change tracking on a mailbox.

Gets a reader that will read a batch of changes.

A reader that will read a batch of changes.

Moves the change tracking cursor to now.

Defines the type of change made to the mailbox item.

Change unknown because change tracking was lost.

A folder was created.

A folder was deleted.

A folder was modified.

A message was created.

A message was deleted.

A message was modified.

Represents the result of a TryCreateFolderAsync operation.

Get the newly created folder after a TryCreateFolderAsync operation.

The newly created folder after a TryCreateFolderAsync operation.

Gets the status of a TryCreateFolderAsync operation.

The status of a TryCreateFolderAsync operation.

Indicates the result of a call to TryCreateFolderAsync.

The folder already exists.

There was a network error while trying to create the folder.

There was a permissions error while trying to create the folder.

There was a server error while trying to create the folder.

The server rejected the request to create a new folder.

The folder was created successfully.

Folder creation failed for an unknown reason.

Indicates the result of a call to TryDeleteFolderAsync.

An error occurred while deleting parts of the folder.

There was a network error while trying to delete the folder.

There was a permissions error while trying to delete the folder.

There was a server error while trying to delete the folder.

The folder was successfully deleted.

Folder deletion failed for an unknown reason.

Indicates the result of a call to TryEmptyFolderAsync.

An error occurred while deleting parts of the folder.

There was a network error while trying to empty the folder.

There was a permissions error while trying to empty the folder.

There was a server error while trying to empty the folder.

The folder was successfully emptied.

There was an unknown error while trying to empty the folder.

Defines whether an application can read from a mailbox.

All applications can read from this mailbox.

No other apps can read from this mailbox.

Only system level applications can read from this mailbox.

Defines whether an application can write to a mailbox.

Specific applications may write to this mailbox.

No external applications may write to this mailbox.

Represents the encryption and signing policies associates with an email mailbox.

Gets or sets the allowable SMIME encryption algorithms for the purpose of negotiating with an app.

The allowable SMIME encryption algorithms.

Gets or sets a Boolean value that indicates whether software certificates are allowed.

A Boolean value that indicates whether software certificates are allowed.

Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages.

The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts encrypted messages.

Gets or sets a Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages.

The Boolean value that indicates whether the sync provider that represents the email mailbox only accepts signed messages.

Gets or sets the required SMIME encryption algorithm.

The required SMIME encryption algorithm.

Gets or sets the required SMIME signing algorithm.

The required SMIME signing algorithm.

Defines the encryption algorithm used for an email.

The encryption algorithm requirements are not specified.

Use the Data Encryption Standard symmetric key block cipher algorithm.

Use the RC2 128-bit block cipher encryption algorithm.

Use the RC2 40-bit block cipher encryption algorithm.

Use the RC2 64-bit block cipher encryption algorithm.

Use the Triple Data Encryption Algorithm symmetric-key block cipher algorithm.

Defines the algorithm used to sign an email.

No specific algorithm is required.

Use Message Digest algorithm 5 (128-bit).

Use Secure Hash Algorithm 1 (160-bit).

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Gets or sets the last time the mailbox attempted to sync.

The last time the mailbox attempted to sync.

Gets or sets the last time the mailbox was successfully synced.

The last time the mailbox was successfully synced.

Gets or sets the sync state of the mailbox.

The sync state of the mailbox.

Fires whenever a mailbox's sync status changes.

Initiates a sync of this mailbox.

A Boolean value indicating success.

Defines the sync status of the mailbox.

The mailbox has encountered an authentication error and cannot sync.

The mailbox is idle.

The account must be manually removed.

The mailbox has encountered a policy error and cannot sync.

The mailbox is currently syncing.

The mailbox has encountered an unknown error and cannot sync.

The mailbox is up to date.

Allows an application to launch the email application with a new message displayed. Use this to allow users to send email from your application.

Gets the EmailManagerForUser object for the specified user.

The user account to use to get the EmailManagerForUser object. Returns the email manager for the account specified by the *user* parameter.

Gets an email store that is within the specified scope.

The enumerator of scope. The requested email store.

Launches the email application with a new message displayed.

The email message that is displayed when the email application is launched. An asynchronous action used to indicate when the operation has completed.

Represents a service that source apps can call to access email data for a specific user.

Gets the User represented by this email manager.

The User represented by this email manager.

Asynchronously returns the EmailStore from the system.

Specifies the access type, such as **AllMailboxesLimitedReadWrite** for all mailboxes or **AppMailboxesReadWrite** for the calling app's mailboxes. Returns the EmailStore.

Launches the email application with a new message displayed.

The email message that is displayed when the email application is launched. An asynchronous action used to indicate when the operation has completed.

Represents the information associated with a meeting.

Initializes a new instance of the class.

Gets or sets a Boolean value indicating whether the proposal of a new time is allowed.

A Boolean value indicating whether the proposal of a new time is allowed.

Gets or sets the start time for a meeting.

The start time for a meeting.

Gets or sets the server identifier for the appointment associated with an email message.

The server identifier for the appointment associated with an email message.

Gets or sets the duration of the meeting.

The duration of the meeting.

Gets or sets a Boolean value indicating whether the meeting is an all day event.

A Boolean value indicating whether the meeting is an all day event.

Gets a Boolean value indicating if the meeting is reported as out of date by the server.

A Boolean value indicating if the meeting is reported as out of date by the server.

Gets or sets a Boolean value indicating whether a response to the meeting request is required.

A Boolean value indicating whether a response to the meeting request is required.

Gets or sets the meeting location.

The meeting location.

Gets or sets the proposed duration for the proposed meeting change.

The proposed duration for the proposed meeting change.

Gets or sets the proposed start time for the proposed meeting change.

The proposed start time for the proposed meeting change.

Gets or sets the recurrence parameters.

The recurrence parameters.

Gets or sets the first instance of the recurrence pattern.

The first instance of the recurrence pattern.

Gets or sets the change number on the server that identifies the meeting email change number.

The change number on the server that identifies the meeting email change number.

Gets or sets the start time for the meeting.

The start time for the meeting.

Defines the type of response to a meeting request.

The meeting was accepted.

The meeting was declined.

The meeting was tentatively accepted.

Represents an email message.

Creates an instance of the EmailMessage class.

Gets or sets a Boolean value indicating whether images may be embedded in the html encoded email message.

A Boolean value indicating whether images may be embedded in the html encoded email message.

Gets the attachments of the email message.

The attachments to the email message.

Gets the recipients BCC'd to the email message.

The recipients BCC'd to the email message.

Gets or sets the body of the email message.

The body of the email message.

Gets the recipients CC'd to the email message.

The recipients CC'd to the email message.

Gets the current change number which is incremented for each change made to an email message.

The current change number .

Gets the identifier for a conversation.

The identifier for a conversation.

Gets or sets the download status of an email message.

The download status of an email message.

Gets or sets the estimated size, in bytes, of an email message download.

The estimated size, in bytes, of an email message download.

Represents the flag status of an email message.

The flag status of an email message.

Gets the identifier of a folder in the inbox.

The identifier of a folder in the inbox.

Gets a Boolean value indicating whether this email message contains partial bodies.

The Boolean value indicating whether this email message contains partial bodies.

Gets the identifier of an email message.

The identifier of an email message.

Gets the importance of an email message.

The importance of an email message.

Gets the identifier for the email message to which this message is a response.

The identifier for the email message to which this message is a response.

Gets or sets the Information Rights Management (IRM) information for this email message.

The Information Rights Management (IRM) information for this email message.

Gets a Boolean value indicating whether this message is a draft.

A Boolean value indicating whether this message is a draft.

Gets a Boolean value indicating whether the email message has been read.

A Boolean value indicating whether the email message has been read.

Gets a Boolean value indicating whether the email message has been seen.

A Boolean value indicating whether the email message has been seen.

Gets a Boolean value indicating whether the email message is a temporary server search message.

The Boolean value indicating whether the email message is a temporary server search message.

Gets a Boolean value indicating whether the response email message is allowed to attempt a smart send, only sending that portion of the email message that has changed.

A Boolean value indicating whether the response email message is allowed to attempt a smart send.

Gets the last kind of response sent in reference to this email message.

The last kind of response sent in reference to this email message.

Gets the identifier of the mailbox.

The identifier of the mailbox.

Gets the information associated with this meeting.

The information associated with this meeting.

Gets or sets a string that indicates the class of the message.

The string that indicates the class of the message.

Gets the subject line of an email message stripped of additional prefixes such as fwd: and re:

The subject line of an email message stripped of additional prefixes such as fwd: and re:

Gets or sets the integer that identifies the original flavor of the character set used so that when the email message is condensed from wide character format (16-bit) to ASCII or other 8-bit encoding, in cases of later encoding questions, this integer can be used to recreate the original character set.

The integer that identifies the original flavor of the character set used

Gets or sets the short preview string that represents the longer email message in the list view of emails.

The short preview string that represents the longer email message in the list view of emails.

Gets or sets the identifier that can be used by a service provider to access the email message on the client machine.

The identifier that can be used by a service provider to access the email message on the client machine.

Gets the recipients that are configured to receive a reply to the email message.

The recipients that are configured to receive a reply to the email message.

Gets or sets the mailbox from which the email message was sent.

The mailbox from which the email message was sent.

Gets or sets an object that identifies the name and address of the person sending the message.

An object that identifies the name and address of the person sending the message.

Gets or sets the time an email was sent.

The time an email was sent.

Gets or sets the S/MIME data associated with an email message. For more information, see the Certificate class.

The MIME data associated with an email message.

Gets or sets the type of S/MIME encryption/signature for the email message.

The type of S/MIME encryption/signature for the email message.

Gets or sets the subject of the email message.

The subject of the email.

Gets the direct recipients of the email message.

The recipients of the email message.

Gets the requested email stream such as plain text or HTML.

The kind of message body; plain text or HTML. The selected body stream.

Sets the value of the specified body stream in an email message.

Indicates which body stream, plain text or HTML. The message for the specified body stream.

Represents a collection of email messages.

Gets a batch of email messages.

A batch of email messages.

Gets the status of the email batch read.

The status of the email batch read.

Defines the format of an email message.

The email message is formatted as HTML.

The email message is formatted as plain text.

Defines the download status of an email message.

The download of the email message is complete.

The email message is currently downloading.

The download of the email message has failed.

The email message is partially downloaded.

Gets a batch of email messages.

Reads a collection of email messages.

A batch of email messages.

Defines the type of response to an email message.

The email message is a forwarded copy of another email message.

The email message is not a response to another email message.

The email message is a reply to the sender of another email message.

The email message is a reply to the sender and all addressees of another email message.

Defines the S/MIME type of an email message.

Clear signed MIME (two MIME entities).

Encrypted MIME.

No MIME encryption or signature.

Opaque signed MIME (a single MIME entity).

Defines the type of email query.

The query is for all email messages.

The query is for email messages that have been flagged.

The query is for email messages marked Important.

The query is for all email messages that have been read.

The query is for all unread email messages.

The query is for all email messages that have not yet been seen.

Represents the options selected for an email mailbox query.

Instantiates a new instance of the class.

Instantiates a new instance of the class.

The text for which to search.

Instantiates a new instance of the class.

The text for which to search. The fields against which to search.

Gets the identifiers for the folders in which to search.

The identifiers for the folders in which to search.

Gets or sets the kind of emails for which to query.

The kind of emails for which to query.

Gets or sets the direction of the sort for the query results.

The direction of the sort for the query results.

Gets or sets a Boolean value indicating whether the query results should be sorted.

A Boolean value indicating whether the query results should be sorted.

Gets the text to search for.

The text to search for.

Defines the field(s) by which to search a collection of email messages. Use the OR operator to combine these values together into a single bit field.

Search by all searchable fields.

No search field defined.

Search by preview text field.

Search by members of the recipient list.

Search by sender field.

Search by subject field.

Defines the scope of a query.

Query only the local email message collection.

Query the entire email message collection contained on the email server.

Defines the order in which to sort query results.

Sort query results in ascending order.

Sort query results in descending order.

The property by which to sort. Currently limited to date.

Sort by date.

Represents a text search query in an email mailbox.

Gets or sets the fields for an email text search query.

The fields for an email text search query.

Gets or sets the scope for an email text search query.

The scope for an email text search query.

Gets or sets the text string for an email text search query.

The text string for an email text search query.

Represents an email recipient.

Initializes an instance of the EmailRecipient class.

Initializes an instance of the EmailRecipient class.

The address of the recipient.

Initializes an instance of the EmailRecipient class.

The address of the recipient. The name of the recipient.

Gets or sets the address of the email recipient.

The address of the email recipient.

Gets or sets the name of the email recipient.

The name of the email recipient.

Represents the result of an attempt to resolve an email recipient.

Instantiates a new instance of the EmailRecipientResolutionResult class.

Gets the public key for an email recipient.

The public key for an email recipient.

Gets or sets the state of an attempt to resolve an email recipient.

The state of an attempt to resolve an email recipient.

Sets the public keys for an email recipient.

An iterable collection of certificates.

Describes the state of an attempt to resolve an email recipient.

Resolution failed. Multiple results returned. Refinement needed.

Resolution failed. The distribution list cannot be accessed.

Resolution failed. The limit of allowed requests for the current certificate has been reached.

Resolution failed. No valid certificate present.

Resolution failed. Recipient cannot be resolved because no match found in distribution list.

Resolution failed. There has been an error on the server.

Success. Email recipient resolved.

Resolution failed for unknown reason.

Defines the email special folders.

This is the deleted items folder.

This is the drafts folder.

This is the inbox folder.

This is not a special folder.

This is the outbox folder.

This is the root folder.

This is the sent items folder.

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Allows an app to create an email account from an account name and an email address.

The name of the account. The email address associated with the account. An email mailbox.

Allows an app to create an email account from an account name, an email address, and the user data account in which the mailbox will reside.

The name of the account. The email address associated with the account. The user data account identifier associated with this user. An email mailbox.

Gets all mailboxes within the current scope.

A collection of mailboxes.

Gets an email conversation from the provided identifier.

The identifier of the conversation. An email conversation.

Gets a batch of email conversations.

A batch of email conversations.

Gets a batch of email conversations using the specified email query options.

The email query options. A batch of email conversations.

Gets an email folder from an identifier.

The identifier for the email folder. The folder described by the identifier.

Gets a mailbox from an identifier.

The identifier for the mailbox. The mailbox described by the identifier.

Gets the specified email message.

The identifier for the email message. The specified email message.

Gets a message reader.

The email message reader.

Gets a message reader using the specified query options.

Specified query options. An email message reader.

Defines the scope for store access.

Scope limited to read all data but only call write APIs that are on the mailbox and do not save.

Full access to all APIs.

The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.

Represents a connection to a data provider client.

Occurs when the email client has requested that a folder be created on the server.

Occurs when the email client has requested that a folder be deleted on the server.

Occurs when the email client has requested to download an attachment from the server.

Occurs when the email client has requested to download a message from the server.

Occurs when the email client has requested that a folder be emptied the server.

Occurs when the email client has requested to forward a meeting request.

Occurs when the email client has requested the auto reply settings.

Occurs when the email client has requested to sync with the mailbox on the server.

Occurs when the email client has requested that a folder be moved on the server.

Occurs when the email client has requested that a new meeting time be proposed.

Occurs when the email client has requested that the recipients of a message be resolved.

Occurs when the email client has requested a batch of server-side search results.

Occurs when the email client has requested to set auto reply settings.

Occurs when the email client has requested that a meeting response be updated.

Occurs when the email client has requested that certificates be validated with respect to a particular mailbox.

Call this method to indicate that all event handlers have been set, and the data provider is ready to start handling requests.

Contains details about the event that triggered your email data provider background task.

Gets the EmailDataProviderConnection to be used to communicate with an email client app.

The connection your email data provider uses to communicate with an email client app. When you handler is triggered, your code should register event handlers on this connection for the email data provider events included in the EmailDataProviderConnection class.

Details of a request to create a folder.

Gets the mailbox identifier for the mailbox where the new folder should be created.

A mailbox ID.

Gets the name of the folder to be created.

A folder name.

Gets the folder ID of the parent folder for the created folder.

A folder ID. Get the parent folder's ID from its EmailFolder.Id property.

Informs the client that the request was processed successfully.

An EmailFolder representing the created folder. An asynchronous create operation on an EmailMailboxCreateFolderRequest object.

Informs the client that the request was not processed successfully.

An EmailMailboxCreateFolderStatus value indicating why the operation failed. An asynchronous create operation on an EmailMailboxCreateFolderRequest object.

Encapsulates information about a folder creation request event.

Gets the EmailMailboxCreateFolderRequest object that describes the details of this request.

A EmailMailboxCreateFolderRequest object that describes the folder creation operation to be performed.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to delete a folder.

Gets the folder ID of the folder to be deleted.

The folder ID of the folder to be deleted.

Gets the mailbox identifier for the mailbox where the folder will be deleted.

A mailbox ID.

Informs the email client that the request was processed successfully.

An asynchronous delete operation on an EmailMailboxDeleteFolderRequest object.

Informs the client that the request was not processed successfully.

A EmailMailboxDeleteFolderStatus value indicating why the operation failed. An asynchronous delete operation on an EmailMailboxDeleteFolderRequest object.

Encapusulates information about a folder deletion request event.

Gets the EmailMailboxDeleteFolderRequest object that describes the details of this request.

An EmailMailboxDeleteFolderRequest object that describes the folder deletion operation to be performed.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to download an attachment.

Gets the attachment ID of the attachment to be downloaded.

The ID of the attachment. Use the EmailAttachment.Id value for the attachment you want to download.

Gets the email mailbox ID.

The mailbox ID of the mailbox that holds the attachment.

Gets the email message ID of the message associated with the attachment.

The email message ID.

Informs the email client that the request was processed successfully.

An asynchronous download operation on an EmailMailboxDownloadAttachmentRequest object.

Informs the client that the request was not processed successfully.

An asynchronous download operation on an EmailMailboxDownloadAttachmentRequest.

Encapsulates information about a request to download an attachment.

Gets the EmailMailboxDownloadAttachmentRequest object associated with this request.

A EmailMailboxDownloadAttachmentRequest object describing the attachment to be downloaded.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to download an email message.

Gets the mailbox ID for the mailbox that holds the message to be downloaded.

A mailbox ID.

Gets the message ID of the message to be downloaded.

A message ID.

Informs the email client that the request was processed successfully.

An asynchronous download operation on an EmailMailboxDownloadMessageRequest object.

Informs the client that the request was not processed successfully.

An asynchronous download operation on an EmailMailboxDownloadMessageRequest.

Encapsulates information about a request to download an email message.

Gets the EmailMailboxDownloadMessageRequest object associated with this request.

An EmailMailboxDownloadMessageRequest object describing the email message to be downloaded.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to download an email message.

Gets the folder ID of the folder to be emptied.

The folder ID.

Gets the mailbox ID of the mailbox that holds the folder.

The mailbox ID.

Informs the email client that the request was processed successfully.

An asynchronous empty operation on an EmailMailboxEmptyFolderRequest object.

Informs the client that the request was not processed successfully.

The status of the folder, following the failed attempt to empty it. An asynchronous empty operation on an EmailMailboxEmptyFolderRequest.

Encapsulates information about a request to empty a folder.

Gets the EmailMailboxEmptyFolderRequest object associated with this request.

An EmailMailboxEmptyFolderRequest object describing the folder to be emptied.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to forward a meeting invitation.

Gets the comment to be added to the forwarded meeting invitation. When a data provider forwards an invitation as an email message, the comment appears between the forward header and the body of the forwarded invitation.

The comment to be added to the meeting invitation.

Gets the mailbox ID for the meeting invitation to be forwarded.

A mailbox ID.

The message ID of the meeting invitation to be forwarded.

A message ID.

Gets the forward header for the forwarded invitation. The forward header is the set of message headers that appear at the beginning of the email message that holds the invitation. It is only used by data providers that generate emails when forwarding invitations.

The forwarding header.

Gets the forward header type.

An EmailMessageBodyKind value describing the ForwardHeader content.

Gets the list of recipients for the forwarded meeting invitation.

A list of EmailRecipient objects specifying the recipients of the forwarded invitation.

Gets the subject of the forwarded meeting invitation.

The subject line of the forwarded invitation.

Informs the email client that the request was processed successfully.

An asynchronous forward operation on an EmailMailboxForwardMeetingRequest.

Informs the client that the request was not processed successfully.

An asynchronous forward operation on an EmailMailboxForwardMeetingRequest.

Encapsulates information about a request to forward a meeting invitation.

Gets the EmailMailboxForwardMeetingRequest object associated with this request.

An EmailMailboxForwardMeetingRequest object describing the request to forward a meeting invitation.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to get auto-reply settings.

Gets the email box ID of the mailbox whose settings are being retrieved.

A mailbox ID.

Gets the requested format of the auto-reply settings.

An EmailMailboxAutoReplyMessageResponseKind value representing the requested format of the returned settings.

Informs the email client that the request was processed successfully.

The requested settings, in the requested format. An asynchronous get operation on an EmailMailboxGetAutoReplySettingsRequest.

Informs the client that the request was not processed successfully.

An asynchronous get operation on an EmailMailboxGetAutoReplySettingsRequest.

Encapsulates information about a request to get auto-reply settings.

Gets the EmailMailboxGetAutoReplySettingsRequest object associated with this request.

An EmailMailboxGetAutoReplySettingsRequest object describing the request to get auto-reply settings.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to move a folder.

Gets the folder ID of the folder to be moved.

A folder ID.

Gets the mailbox ID of the mailbox containing the folder to be moved.

A mailbox ID.

Gets the new folder name of the file to be moved.

The new folder name. Note that you rename a folder by requesting a move to the current parent folder, but with a new name.

Gets the parent folder ID of the new parent folder.

A folder ID. Note that you rename a folder by requesting a move to the current parent folder, but with a new name.

Informs the email client that the request was processed successfully.

An asynchronous move operation on an EmailMailboxMoveFolderRequest.

Informs the client that the request was not processed successfully.

An asynchronous move operation on an EmailMailboxMoveFolderRequest.

Encapsulates information about a request to move a folder.

Gets the EmailMailboxMoveFolderRequest object associated with this request.

An EmailMailboxMoveFolderRequest object describing the request to move a folder.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to propose a new time for a meeting.

Gets the comment to be added to the proposal for a new meeting time.

The comment, as text.

Gets the mailbox ID to use to send the proposed new meeting time.

A mailbox ID.

Gets the message ID of the meeting invitation for which a new time is being proposed.

A message ID.

Gets the proposed new duration of the meeting.

The new duration of the meeting.

Gets the proposed new start time for the meeting.

The new start time.

Gets the subject of the proposal for a new meeting time.

A subject line. Data providers that use email use this value for the Subject of the email.

Informs the email client that the request was processed successfully.

An asynchronous move operation on an EmailMailboxProposeNewTimeForMeetingRequest.

Informs the client that the request was not processed successfully.

An asynchronous proposal operation on an EmailMailboxProposeNewTimeForMeetingRequest.

Encapsulates information about a request to propose a new time for a meeting.

Gets EmailMailboxProposeNewTimeForMeetingRequest the object associated with this request.

An EmailMailboxProposeNewTimeForMeetingRequest object describing the request to propose a new meeting time.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to resolve a list of recipients.

Gets the mailbox ID where the recipients should be resolved.

A mailbox ID.

Gets the list of recipients to be resolved.

A list of recipients.

Informs the email client that the request was processed successfully.

A list of EmailRecipientResolutionResult objects with details about resolution results. An asynchronous resolve operation on an EmailMailboxResolveRecipientsRequest.

Informs the client that the request was not processed successfully. Note that this means the operation failed to execute properly, and does not indicate anything about the recipients. See ReportCompletedAsync to understand how success or failure of resolution for individual recipients is reported.

An asynchronous resolve operation on an EmailMailboxResolveRecipientsRequest.

Encapsulates information about a request to resolve a list of recipients.

Gets the EmailMailboxResolveRecipientsRequest object associated with this request.

An EmailMailboxResolveRecipientsRequest object describing the request to resolve a list of recipients.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to read a batch of server-side search results.

Gets the folder ID of the folder where the search is to be performed.

A folder ID.

Gets the mailbox ID of the mailbox where the search is to be performed.

A mailbox ID.

Gets the search options to be applied to this search.

An EmailQueryOptions object specifying the search options.

Gets the search session ID of this server-side batch read request.

A search session ID.

Gets the suggested batch size for the server-side search batch read.

The suggested number of messages in a batch. Clients suggest a batch size based on client-side criteria such as screen real estate, storage capacity, or bandwidth.

Informs the email client that the request was processed successfully.

An asynchronous batch read request operation on an EmailMailboxServerSearchReadBatchRequest.

Informs the client that the request was not processed successfully.

An EmailBatchStatus value describing the current status of the batch. An asynchronous batch read request operation on an EmailMailboxServerSearchReadBatchRequest.

Saves a message that meets server-side search criteria.

A message that matches the search criteria of a server-side batch read request. An asynchronous message save operation on an EmailMailboxServerSearchReadBatchRequest.

Encapsulates information about a request to read a batch of results from a server-side search.

Gets the EmailMailboxServerSearchReadBatchRequest object associated with this request.

An EmailMailboxServerSearchReadBatchRequest object describing the request to read a batch of server-side search results.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to set auto-reply settings.

Gets the new settings.

An EmailMailboxAutoReplySettings object describing the new auto-reply settings.

Gets the mailbox ID whose auto-reply settings are being set.

A mailbox ID.

Informs the email client that the request was processed successfully.

An asynchronous set operation on an EmailMailboxSetAutoReplySettingsRequest.

Informs the client that the request was not processed successfully.

An asynchronous set operation on an EmailMailboxSetAutoReplySettingsRequest.

Encapsulates information about a request to set auto-reply settings.

Gets the EmailMailboxSetAutoReplySettingsRequest object associated with this request.

An EmailMailboxSetAutoReplySettingsRequest object describing the request to set auto-reply settings.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request from a client to sync a mailbox.

Gets the mailbox ID of the mailbox to synchronize.

A mailbox ID.

Informs the email client that the request was processed successfully.

An asynchronous sync operation on an EmailMailboxSyncManagerSyncRequest.

Informs the client that the request was not processed successfully.

An asynchronous sync operation on an EmailMailboxSyncManagerSyncRequest.

Encapsulates information about a request to sync a mailbox.

Gets the EmailMailboxSyncManagerSyncRequest object associated with this request.

An EmailMailboxSyncManagerSyncRequest object describing the sync request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request from a client to update a meeting response.

Gets the comment to be used in updating the meeting response.

The comment text.

Gets the mailbox ID of the mailbox that holds the meeting response to be updated.

A mailbox ID.

Gets the message ID of the meeting response to be updated.

A message ID.

Gets the response value to be used in updating the meeting response.

An EmailMeetingResponseType value specifying the new response in the updated meeting response.

Gets a value that indicates whether an update should be sent to the meeting owner when the meeting response is updated.

When true, notify the owner that the meeting response has been updated.

Gets the subject to be used on the updated meeting response.

The subject, as text.

Informs the email client that the request was processed successfully.

An asynchronous update operation on an EmailMailboxUpdateMeetingResponseRequest.

Informs the client that the request was not processed successfully.

An asynchronous update operation on an EmailMailboxUpdateMeetingResponseRequest.

Encapsulates information about a request to update a meeting response.

Gets the EmailMailboxUpdateMeetingResponseRequest object associated with this request.

An EmailMailboxUpdateMeetingResponseRequest object describing the meeting response update request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to validate certificates.

Gets the list of certificates to be validated.

A list of certificates to be validated.

Gets the mailbox ID against which the certificates are to be validated.

A mailbox ID.

Informs the email client that the request was processed successfully. Note that success does not mean that all certificates validated successfully. Rather, it means that all certificates' validation status was assessed.

A list of EmailCertificateValidationStatus values. The first status value in this list is the status of the first certificate in the Certificates property of the original request. An asynchronous validation operation on an EmailMailboxValidateCertificatesRequest.

Informs the client that the request was not processed successfully. Specifically, not all of the certificates' validation state was assessed successfully.

An asynchronous validation operation on an EmailMailboxValidateCertificatesRequest.

Encapsulates information about a request to validate certificates.

Gets the EmailMailboxValidateCertificatesRequest object associated with this request.

An EmailMailboxValidateCertificatesRequest object describing the certificate validation request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Describes the reason for the background execution request.

To support location tracking.

To save data.

No reason specified.

Specifies the possible background execution request result values.

App execution is allowed.

App execution is denied.

The object that is passed as a parameter to the event handler that is invoked when the system revokes background execution.

Gets the reason background execution was revoked.

The reason background execution was revoked.

Describes the reason background execution was revoked.

The app was resumed while it was executing in the background.

Background execution is revoked due to system resources.

Supports managing a request for background execution. For more information on how to use Extended Execution, see Run while minimized with Extended Execution

Creates an **ExtendedExecutionSession** object.

This property is not used in the current release.

This property is not used in the current release.

This property is not used in the current release.

This property is not used in the current release.

Gets or sets the reason for the for the background execution request.

The reason for the for the background execution request.

The **Revoked** event occurs when the system revokes background execution.

Closes the session and removes the application's capability to run in the background.

Requests background execution.

The result of the request.

Describes the reason for the extended execution request.

To play audio.

To save data.

To perform any task that requires extended execution time.

No reason specified.

Specifies the possible extended execution request result values.

Extended execution is allowed.

App execution is not allowed.

Passed to the event handler that is invoked when the system revokes extended execution.

Gets the reason extended execution was revoked.

The reason extended execution was revoked.

Describes the reason extended execution was revoked.

The app was resumed during its extended execution.

Extended execution is revoked due to system resources.

Supports managing a request for extended execution. This API requires the use of restricted capabilities and cannot be used for Store applications.

Creates an ExtendedExecutionForegroundSession object

Gets or sets a string to display in the shell.

A string to display in the shell.

Gets or sets the reason for the extended execution request.

The reason for the for the extended execution request.

This event occurs when the system revokes extended execution.

Closes the session and removes the application's extended execution capability.

Requests extended execution

The result of the request.

Allows the lock screen app to request that the device unlocks, and allows the app to register to be notified when the device begins to unlock.

Indicates the device is unlocking.

Gets a LockApplicationHost object.

A LockApplicationHost object.

Requests that the device unlocks.

Represents a lock screen badge for an app.

Gets the name.

The name.

Gets the glyph to display.

The glyph.

Gets the logo to display with the badge.

The logo.

Gets the number to display with the badge.

The number.

Launches the app corresponding to the badge.

Provides access to the same data that the default lock screen has access to, such as wallpaper, badges, and so on.

Gets the alarm icon to display.

The alarm icon.

Gets the badges to display.

The badges.

Gets the detail text to display.

The text.

Gets the image to display on the lock screen.

The image to display.

Indicates the alarm icon has changed.

Indicates the badges have changed.

Indicates the detail text has changed.

Indicates the lock screen image has changed.

Represents an unlock deferral.

Notifies the system that your deferral is complete. If your deferral takes too long to complete, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app.

Represents the lock screen unlocking events.

Gets the deadline by which the lock screen app must unlock the device. If your unlocking deferral takes too long, your lock screen app will be terminated by the system and potentially removed as the user’s default lock app.

The deadline by which your app must unlock the device.

Gets a LockScreenUnlockingDeferral, which defers the unlocking of the device.

An unlock deferral.

This class represents an address that is used in the Payment Request API. This class reflects the W3C PaymentAddress interface.

Creates a new PaymentAddress object.

The address lines.

Gets or sets the AddressLines.

The city.

Gets or sets the City.

The country. Values must be from the CLDR standard.

Gets or sets the Country.

The dependent locality within a city.

Gets or sets the DependentLocality.

Language code for the address. Values must be valid IETF language tags as specified by the BCP-47 standard.

Gets or sets the LanguageCode.

Organization in the address.

Gets or sets the Organization.

The phone number of the recipient.

Gets or sets the PhoneNumber.

The address postal code.

Gets or sets the PostalCode.

This field is used to allow extensions to the class. It is not present in the W3C definition.

Gets or sets Properties.

The name of the recipient.

Gets or sets the Recipient.

The region of a country.

Gets or sets the Region.

The sorting code.

Gets or sets the SortingCode.

This class serves as a result of the CanMakePaymentsAsync method.

Creates a new PaymentCanMakePaymentResult object.

The status value.

Gets the status of whether a payment can be made.

The status of whether a payment can be made.

This enumeration represents the result of querying whether a payment can be made.

No.

There is no qualifying card on file.

The payment is not allowed.

The specified payment method is not supported.

There's an unknown reason.

The user is not signed in.

Yes, a payment can be made.

This class describes a monetary value associated with a purchase. For example, charges or discounts. This class reflects the W3C PaymentCurrencyAmount dictionary.

Creates a new PaymentCurrencyAmount object

The monetary value. An exception will be thrown if this value doesn't match the following regex pattern. The currency identifier. The default **CurrencySystem** is urn:iso:std:iso:4217.

Creates a new PaymentCurrencyAmount object.

The monetary value. An exception will be thrown if this value doesn't match the following regex pattern. The currency. Valid values are determined by *currencySystem*. For example, if *currencySystem* is urn:iso:std:iso:4217 then **USD** is a valid currency value. The currency system.

The currency identifier.

Gets or sets the Currency.

The currency system.

Gets or sets the CurrencySystem.

The monetary value.

Gets or sets the value.

This class provides information about the requested transaction; it is passed to the PaymentRequest and PaymentRequestChangedResult constructors. This class reflects the W3C PaymentDetails dictionary.

Creates a PaymentDetails object.

Creates a PaymentDetails object.

The total.

Creates a PaymentDetails object.

The total. The display items.

This is a collection of PaymentItem classes items for a payment request. These represent the breakdown of items in the payment request. Some examples are shoes or taxes.

Gets or sets the DisplayItems.

A collection of PaymentDetailsModifier classes for which provide the ability to change the transaction cost based on the payment method used.

Gets or sets the Modifiers.

A collection of PaymentShippingOption classes for a payment request.

Gets or sets the ShippingOptions.

This is the total cost of the transaction.

Gets or sets the Total.

This class is used when payment methods (see PaymentRequest.MethodData ) have additional costs or discounts associated with them. This class reflects the W3C PaymentDetailsModifier dictionary.

Creates a PaymentDetailsModifier object.

The supported method IDs. The total.

Creates a PaymentDetailsModifier object.

The supported method IDs. The total. The additional display items.

Creates a PaymentDetailsModifier object.

The supported method IDs. The total. The additioanl display items.

The additional display items.

Gets or sets the AdditionalDisplayItems.

Optional information.

Gets or sets the JsonData.

A collection of payment method that this modifier applies to.

Gets or sets the SupportedMethodIds.

This is the total of all DisplayItems. This value serves as a replacement for the PaymentDetails.Total property when one of the payment methods in the SupportedMethodIds list is used. Therefore, this value needs to be the sum of PaymentDetail.DisplayItems, the selected shipping option in the PaymentDetails.ShippingOptions collection (See PaymentShippingOption.IsSelected ), and AdditionalDisplayItems.

Gets or sets the Total.

This class represents a payment item. This class reflects the W3C PaymentItem dictionary.

Creates a PaymentItem object. The Pending property is set to false by default.

The label. The amount.

The amount.

Gets or sets the amount.

The label.

Gets or sets the Label.

Indicates that the item may not be finalized, yet. For example, a merchant may initially quote the total cost assuming they will be shipping locally. But this value could change if the user provides an overseas shipping address, which would require the merchant to increase the price to account for international shipping.

Gets or sets the Pending status.

This class is used to submit payment requests.

Creates a new PaymentMediator object.

This method checks if a payment can be made on the paymentRequest.

The payment request to check. Returns an asynchronous operation that completes with a bool indicating whether a payment can be made.

Gets the list of payment methods currently supported.

When the asynchronous operation completes, it returns a collection of the supported payment methods.

Submits a payment request.

The payment request. When the asynchronous operation completes, it returns a submission result.

Submits a payment request.

The payment request. A handler for when the payment request changes. When the asynchronous operation completes it returns submission results.

A class that contains information about a payment merchant.

Creates a new PaymentMerchantInfo object.

Creates a new PaymentMerchantInfo object.

The uri.

The full name of the package.

Gets or sets the PackageFullName.

A read-only property containing the URI.

Gets the Uri.

A class containing data about a payment method. This class reflects the W3C PaymentMethodData dictionary.

Creates a PaymentMethodData object.

The supported method IDs.

Creates a PaymentMethodData object.

The supported method IDs. The data associated with a payment method.

Data about the payment method. For example, if the Basic Card Payment method is being used then this must contain data confirming to the BasicCardRequest dictionary type.

Gets the JsonData.

The supported method IDs.

Gets the SupportedMethodIds.

An enumeration that indicates whether the option is required or optional.

Property is not needed or used by the merchant.

Property is not needed by the merchant, but they will accept it if provided. For example, a merchant could optionally send you a receipt to your email address.

The merchant can't (or is unwilling to) process the transaction without this information.

A class containing payment options. This class reflects the W3C PaymentOptions dictionary.

Creates a new PaymentOptions object.

Indicates whether to request the payer email.

Gets or sets the RequestPayerEmail option.

Indicates whether to request the payer name.

Gets or sets the RequestPayerName.

Indicates whether to request the payer phone number.

Gets or sets the RequestPayerPhoneNumer.

Indicates whether to request shipping. If this value is set to true, then PaymentDetails.ShippingOptions must not be empty.

Gets or sets RequestShipping.

The shipping type.

Gets or sets the ShippingType.

A class that contains information about a payment request. This class is reflects the W3C PaymentRequest interface.

Creates a PaymentRequest object.

The details. The method data.

Creates a PaymentRequest object.

The details. The method data. The merchant information.

Creates a PaymentRequest object.

The details. The method data. The merchant information. The options.

Creates a new PaymentRequest object.

The details. The method data. The merchantInfo. The options. The ID.

The details

Gets or sets the Details.

Gets the payment request ID.

The payment request ID.

The merchant info.

Gets or sets the MerchantInfo

A collection of PaymentMethodData classes. This collection represents the list of payment methods supported by the merchant.

Gets the MethodData.

The options.

Gets or sets the Options.

A class containing arguments from the PaymentRequestChanged delegate.

The change kind.

Gets the ChangeKind.

The selected shipping option. This will be non-null if ChangeKind is set to PaymentRequestChangeKind.ShippingOption.

Gets the SelectedShippingOption.

The shipping address. This will be non-null if ChangeKind is set to PaymentRequestChangeKind.ShippingAddress.

Gets the ShippingAddress.

This method is called by the merchant to confirm that it has received and processed the changes to the payment request. And it provides a way for the merchant to update the details of the request, if required.

The change result.

A handler that is triggered when a payment request has changed.

The payment request. The args.

The result of the payment changed payment request.

Creates a new PaymentRequestChangedResult object.

Whether the change was accepted by the merchant.

Creates a new PaymentRequestChangedResult object.

Whether the change is accepted by the merchant. The updated payment details.

Indicates whether the change was accepted by the merchant. For example, this might be set to false, if the user specified an overseas shipping address but the merchant is unwilling to ship internationally.

Gets or sets the ChangeAcceptedByMerchant.

The message.

Gets or sets the Message.

The updated payment details.

Gets or sets the UpdatedPaymentDetails.

An enumeration indicating what was changed in the payment request.

The shipping address was changed.

The shipping option was changed.

An enumeration that describes whether or not the transaction completed successfully.

Payment failed by the merchant.

Payment was successfully processed by the merchant.

Unknown status provided by the merchant.

An enumeration that describes whether the user successfully accepted the payment request. See PaymentRequestSubmitResult.

The user cancelled the payment request

The payment request failed.

The payment request succeeded.

A class containing the payment request submission result.

The response from the payment request submission. This will be non-null if Status is equal to PaymentRequestStatus.Succeeded.

Gets the Response.

The status of the submission.

Gets the Status.

A class that contains the payment response. This class reflects the W3C PaymentResponse interface.

The payer email.

Gets the PayerEmail.

The payer name.

Gets the PayerName.

The payer phone number.

Gets the PayerPhoneNumber.

The payment token.

Gets the PaymentToken.

The shipping address.

Gets the ShippingAddress.

The shipping option

Gets the ShippingOption.

Completes a payment response.

The status. An asynchronous action.

A class that contains information about a shipping option. This class reflects the W3C PaymentShippingOption dictionary.

Creates a new PaymentShippingOption object.

The label. The amount.

Creates a new PaymentShippingOption object.

The label. The amount. Whether this option is selected.

Creates a new PaymentShippingOption object.

The label. The amount. Whether this option is selected. The tag.

The amount.

Gets or sets the Amount.

Indicates whether this shipping option is selected. A merchant is required to check that only a single shipping option within a request is marked as selected.

Gets or sets IsSelected.

The label.

Gets or sets the Label.

The tag.

Gets or sets the tag.

An enumeration that describes the shipping type.

Delivery.

Pickup.

Shipping.

A class containing details about a payment token.

Creates a new PaymentToken object.

The payment method ID.

Creates a PaymentToken object.

The payment method ID. The JSON details.

Details of the payment token. This contains the information that the merchant will use to process the payment. The format of the data will depend on the payment method used. For example, if the Basic Card Payment method is being used, then this must contain data conforming to the BasicCardResponse dictionary type.

Gets the JsonDetails.

The payment method ID.

Gets the PaymentMethodId.

Creates a new PaymentAppCanMakePaymentTriggerDetails.

Gets the payment request.

The payment request.

Reports the status of whether the payment can be made.

The value.

This class is used to register an app as a payment provider app so that it can start processing PaymentTransactions that were submitted through the Payment Request APIs (Windows.ApplicationModel.Payments ).

The current PaymentAppManager object.

Gets or sets the Current property.

Registers this app as a payment provider.

The supported payment method IDs. Returns an asynchronous action.

Unregisters this app as a payment provider.

An asynchronous action.

This class contains information about a payment transaction that was submitted through the Windows.ApplicationModel.Payments API. The payment provider app uses this class to accept that payment transaction or reject it after verifying the payment through the provider's infrastructure.

The payer email.

Gets the PayerEmail.

The payer name.

Gets or sets the PayerName.

The payer phone number.

Gets or sets the PayerPhoneNumber.

The payment request.

Gets the PaymentRequest.

Accepts the payment.

The payment token. An asynchronous operation that completes with a PaymentTransactionAcceptResult.

Gets a PaymentTransaction object from an ID.

The ID. An asynchronous operation that completes with an instance of PaymentTransaction.

Rejects the payment transation.

Updates the selected shipping option.

The selected shipping option. An asynchronous operation that completes with a PaymentRequestChangedResult.

Updates the shipping address.

The shipping address. Returns an asynchronous operation that completes with a PaymentRequestChangedResult.

This class contains the status of a payment transaction after attempting to accept it.

The status of a payment transaction accept operation.

Gets or sets the Status.

Provides preview functionality that let apps interact with the holographic shell, allowing the user to see content in the world around them.

Gets whether the current app view will display in a Mixed Reality headset.

Whether the current view will display in a headset.

Gets whether a given app activation is targeted at the holographic shell.

The app activation to inspect. Whether the activation is targeted at the holographic shell.

Provides preview functionality that let apps influence the placement of the system keyboard in the holographic shell. This API is available only to a limited set of apps while in the preview phase.

Gets an object that allows for override of the placement of the system keyboard in the holographic shell while the current view is visible. This API is available only to a limited set of apps while in the preview phase.

The placement override object.

Resets the placement of the system keyboard in the holographic shell to its natural position. This API is available only to a limited set of apps while in the preview phase.

Overrides the placement of the system keyboard to appear at a specific position and orientation, while keeping its natural size. This API is available only to a limited set of apps while in the preview phase.

The coordinate system relative to which the keyboard will be placed. The position of the top-center of the keyboard. The normal of the keyboard.

Overrides the placement of the system keyboard to appear at a specific position and orientation, setting a custom maximum keyboard size. This API is available only to a limited set of apps while in the preview phase.

The coordinate system relative to which the keyboard will be placed. The position of the top-center of the keyboard. The normal of the keyboard. The maximum size for the keyboard.

Provides simplified access to app resources such as app UI strings.

Constructs a new ResourceLoader object for the "Resources" subtree of the currently running app's main ResourceMap.

Constructs a new ResourceLoader object for the specified ResourceMap.

The resource identifier of the ResourceMap that the new resource loader uses for unqualified resource references. It can then retrieve resources relative to those references.

Gets a ResourceLoader object for the Resources subtree of the currently running app's main ResourceMap. This ResourceLoader uses a default context associated with the current view.

A resource loader for the Resources subtree of the currently running app's main ResourceMap.

Gets a ResourceLoader object for the specified ResourceMap. This ResourceLoader uses a default context associated with the current view.

The resource identifier of the ResourceMap that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. A resource loader for the specified ResourceMap.

Gets a ResourceLoader object for the specified UIContext.

The UI context for which to get the ResourceLoader. A resource loader for the specified UIContext.

Gets a ResourceLoader object for the Resources subtree of the currently running app's main ResourceMap. This ResourceLoader uses a default context that's not associated with any view.

A resource loader for the Resources subtree of the currently running app's main ResourceMap. This ResourceLoader uses a default context that's not associated with any view. You can't use this ResourceLoader to retrieve any resource that has resource candidates qualified for scale.

Gets a ResourceLoader object for the specified ResourceMap. This ResourceLoader uses a default context that's not associated with any view.

The resource identifier of the ResourceMap that the new resource loader uses for unqualified resource references. The loader can then retrieve resources relative to those references. A resource loader for the Resources subtree of the currently running app's main ResourceMap. This ResourceLoader uses a default context that's not associated with any view. You can't use this ResourceLoader to retrieve any resource that has resource candidates qualified for scale.

Returns the most appropriate string value of a resource, specified by resource identifier, for the default ResourceContext of the view in which the ResourceLoader was obtained using ResourceLoader.GetForCurrentView.

The resource identifier of the resource to be resolved. The most appropriate string value of the specified resource for the default ResourceContext.

Returns the most appropriate string value of a resource, specified as a Uri for a resource identifier, for the default ResourceContext of the currently running app.

A Uri that represents the resource to be retrieved. The most appropriate string value of the specified resource for the default ResourceContext.

Returns the most appropriate string value of a resource, specified by a Uniform Resource Identifier (URI) resource identifier, for the default ResourceContext of the currently running app.

A Uniform Resource Identifier (URI) that represents the resource to be retrieved. The most appropriate string value of the specified resource for the default ResourceContext.

Represents a single logical, named resource, such as a string resource named 'Header1'.

Gets all possible candidate values for this named resource.

A set of ResourceCandidate objects, each of which describes one possible value for this named resource and the qualifiers under which it applies.

Gets a URI that can be used to refer to this named resource.

A URI that can be used to refer to this named resource. See [URI schemes](https://docs.microsoft.com/previous-versions/windows/apps/jj655406(v=win.10)) for information on identifying resources.

Resolves this NamedResource object against the default context and returns the most appropriate candidate.

The most appropriate candidate for the default context.

Resolves this NamedResource object against a supplied context and returns the most appropriate candidate.

The context against which the NamedResource should be resolved. The most appropriate candidate for the specified context.

Resolves this NamedResource object against the default context and returns a list of all possible candidates in preference order.

A list of ResourceCandidate objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate.

Resolves this NamedResource object against a supplied context and returns a list of all possible candidates in preference order.

The context against which the NamedResource should be resolved. A list of ResourceCandidate objects, in order of preference. The object in first position in the list is the most appropriate candidate for the corresponding context, and the object in last position is the least appropriate.

Represents a single possible value for a given NamedResource, the qualifiers associated with that resource, and how well those qualifiers match the context against which it was resolved.

Indicates whether this ResourceCandidate can be used as a default fallback value for any context.

**TRUE** if this candidate can be used as a default fallback value for any context, **FALSE** otherwise.

Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated.

**TRUE** if the ResourceCandidate matched the context, **FALSE** otherwise.

Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated as a result of being a true match, a default fallback value, or a mixed match with default fallback (that is, a match in relation to some qualifiers but using default fallback values for other qualifiers).

**TRUE** if this candidate is an acceptable default fallback value, **FALSE** otherwise.

Gets the type of resource that is encapsulated in this ResourceCandidate.

A value that specifies the type of resource that is encapsulated in this ResourceCandidate.

Gets the qualifiers associated with this ResourceCandidate.

The ResourceQualifier s associated with this ResourceCandidate.

Gets the value of this ResourceCandidate, expressed as a string.

The string value.

Returns the value of a qualifier, given its name.

The name of the qualifier. The value of the qualifier.

Asynchronously returns a StorageFile that accesses the value of this ResourceCandidate. This only works on certain types of ResourceCandidate s that are files.

An asynchronous operation to return the requested StorageFile.

Asynchronously returns an [IRandomAccessStream](https://docs.microsoft.com/previous-versions/hh438400(v=vs.85)) that accesses the value of this ResourceCandidate.

An asynchronous operation to return the requested [IRandomAccessStream](https://docs.microsoft.com/previous-versions/hh438400(v=vs.85)).

Defines values that represent the type of resource that is encapsulated in a ResourceCandidate.

The resource is embedded data in some containing resource file (such as a .resw file).

The resource is a file.

The resource is a string.

Represents a collection of ResourceCandidate objects.

Gets the number of ResourceCandidate objects in the set.

The number of ResourceCandidate objects in the set.

Returns an iterator to enumerate the items in the set of ResourceCandidate objects.

The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty.

Returns the ResourceCandidate at the specified index in the set.

The zero-based index of the ResourceCandidate in the set to return. The ResourceCandidate at the specified index.

Returns the ResourceCandidate objects that start at the specified index in the set.

The zero-based index of the start of the ResourceCandidate objects in the set to return. The ResourceCandidate objects in the set that start at *startIndex*. The number of ResourceCandidate objects returned.

Returns the index of a specified ResourceCandidate in the set.

The ResourceCandidate to find in the set. The zero-based index of the ResourceCandidate, if the item is found. The method returns zero if the item is not found. A Boolean that is **TRUE** if the ResourceCandidate is found, otherwise **FALSE** if the item is not found.

Encapsulates all of the factors (ResourceQualifier s) that might affect resource selection.

Creates a cloned ResourceContext object.

Gets or sets the language qualifier for this context.

A collection of BCP-47 language tags.

Gets a writable, observable map of all supported qualifiers, indexed by name.

The map of qualifiers, which you use to map a qualifier name to a qualifier value. The qualifier value returned represents the current setting. Here is a reference table of all the possible qualifier values that can be returned. See Tailor your resources for language, scale, high contrast, and other qualifiers for an explanation of the general concept of qualifiers, how to use them, and the purpose of each of the qualifier names.

Creates a clone of this ResourceContext, with identical qualifiers.

A new, cloned ResourceContext.

Creates a new ResourceContext that matches a supplied set of qualifiers.

The list of qualifiers to be matched. The new ResourceContext.

Gets a default ResourceContext associated with the current view for the currently running application.

The default context associated with the current view.

Gets a default ResourceContext associated with the specified UIContext for the currently running application.

The UI context for which to get the ResourceContext. The default ResourceContext associated with the specified UI context.

Gets a default ResourceContext not associated with any view.

A default ResourceContext not associated with any view.

Overrides the qualifier values supplied by this context to match a specified list of resolved ResourceQualifier s. Typically the resolved ResourceQualifier s are associated with a resource that was looked up earlier.

The ResourceQualifier s to be applied to the context.

Resets the overridden values for all qualifiers on the given ResourceContext instance.

Resets the overridden values for the specified qualifiers on the given ResourceContext instance.

The names of the qualifiers to be reset.

Removes any qualifier overrides from default contexts of all views across the app.

Removes qualifier overrides for the specified qualifiers from default contexts of all views across the app.

The names of the qualifiers to be reset.

Applies a single qualifier value override to default contexts of all views for the current app.

The name of the qualifier to override. The override value to set.

Applies a single qualifier value override to default contexts of all views for the current app, and specifies the persistence of the override.

The name of the qualifier to override. The override value to set. The persistence of the override value.

Represents a collection of ResourceContext language qualifiers.

Gets the number of ResourceContext language qualifiers in the set.

The number of ResourceContext language qualifiers in the set.

Returns an iterator to enumerate the items in the set of ResourceContext language qualifiers.

The iterator. The current position of the iterator is index 0, or the end of the set if the set is empty.

Returns the ResourceContext language qualifier at the specified index in the set.

The zero-based index of the ResourceContext language qualifier in the set to return. The ResourceContext language qualifier at the specified index.

Returns the ResourceContext language qualifiers that start at the specified index in the set.

The zero-based index of the start of the ResourceContext language qualifiers in the set to return. The ResourceContext language qualifiers in the set that start at *startIndex*. The number of ResourceContext language qualifiers returned.

Returns the index of a specified ResourceContext language qualifier in the set.

The ResourceContext language qualifier to find in the set. The zero-based index of the ResourceContext language qualifier, if the item is found. The method returns zero if the item is not found. A Boolean that is **TRUE** if the ResourceContext language qualifier is found; otherwise, **FALSE**.

Structure that determines version and counts of resources returned for the app package.

Framework-generated checksum.

Major version of resources to be returned.

Minor version of resources to be returned.

Number of named resources to be returned.

Number of resource subtrees to be returned.

Provides access to application resource maps and more advanced resource functionality.

Gets a map of ResourceMap objects typically associated with the app packages, indexed by package name.

Contains all default resource maps for all packages used by the app, as well as any resource maps that have been loaded explicitly.

Gets the ResourceManager for the currently running application.

The application default ResourceManager, initialized with the resources for all of the packages in the package graph.

Gets the default ResourceContext for the currently running application. Unless explicitly overridden, the default ResourceContext is used to determine the most appropriate representation of any given named resource.

The resource context.

Gets the ResourceMap that is associated with the main package of the currently running application.

The resource map.

Gets a list of all named resources for an app package.

The name of the app package. Specifies the resource version and the named resource count. A list of NamedResource objects.

Gets a list of all collections of resource subtrees for an app package.

The name of the app package. Specifies the resource version and the resource subtree count. A list of resource subtrees (ResourceMap objects).

Determines whether a supplied string matches the resource reference format (an ms-resource string URI identifier).

The string you want to match. **TRUE** if the string matches.

Loads one or more resource index ("PRI") files and adds their contents to the default resource manager.

The files you want to add.

Unloads one or more resource index ("PRI") files.

The files you want unloaded.

A collection of related resources, typically either for a particular app package, or a resource file for a particular package.

Gets the number of resources in the map.

The number of resources in the map.

Gets a URI that can be used to refer to this ResourceMap.

The URI that refers to this ResourceMap.

Returns an iterator to enumerate the items in the map.

The iterator. The current position of the iterator is index 0, or the end of the set if the map is empty.

Returns a ResourceMap that represents a part of another ResourceMap, typically used to access a particular resource file within an app package.

A resource map identifier that identifies the root of the new subtree. For details, see the remarks for ResourceMap class. The subtree ResourceMap.

Returns the most appropriate candidate for a resource that is specified by a resource identifier within the default context.

A resource identifier specified as a name or reference. For details, see the remarks for ResourceMap class. A ResourceCandidate that describes the most appropriate candidate.

Returns the most appropriate candidate for a resource that is specified by a resource identifier for the supplied context.

A resource specified as a name or reference. For details, see the remarks for ResourceMap class. The context for which to select the most appropriate candidate. A ResourceCandidate that describes the most appropriate candidate.

Determines whether the map can retrieve a resource with the specified resource identifier.

The resource identifier to locate in the map. For syntax details, see the remarks for ResourceMap class. **TRUE** if the key is found, otherwise **FALSE**.

Returns the NamedResource at the specified resource identifier in the map.

The resource identifier to use to locate the resource in the map. For syntax details, see the remarks for ResourceMap class. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Splits the map view into two views.

One half of the original map. The second half of the original map.

Supports iteration over a ResourceMap.

Gets the current item in the ResourceMap.

The key and NamedResource key-value pair for the current item.

Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the ResourceMap.

**TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**.

Returns all the items in the ResourceMap.

The items in the map. The number of items in the map.

Moves the iterator forward to the next item and returns HasCurrent.

**TRUE** if the iterator refers to a valid item that is in the map, and otherwise **FALSE**.

An unchangeable view into a map of ResourceMap objects.

Gets the number of ResourceMap objects in the map.

The number of ResourceMap objects in the map.

Returns an iterator to enumerate the items in the map view.

The iterator. The current position of the iterator is index 0, or the end of the map if the map is empty.

Determines whether the map view contains the specified key.

The key to locate in the map view. **TRUE** if the key is found, otherwise **FALSE** if it is not found.

Returns the ResourceMap at the specified key in the map view.

The key to locate in the map view. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Splits the map view into two views.

One half of the original map. The second half of the original map.

Supports iteration over a ResourceMapMapView object.

Gets the current item in the ResourceMapMapView.

The key and ResourceMap key-value pair for the current item.

Gets a value that indicates whether there is a current item, or whether the iterator is at the end of the ResourceMapMapView.

**TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**.

Returns all the items in the ResourceMapMapView.

The items in the map view. The number of items in the map view.

Moves the iterator forward to the next item and returns HasCurrent.

**TRUE** if the iterator refers to a valid item that is in the map view, and otherwise **FALSE**.

Defines the qualifiers associated with a ResourceCandidate.

Indicates whether this qualifier should be considered as a default match when no match is found.

**TRUE** if this candidate can be used as a default fallback value for any context; otherwise, **FALSE**.

Indicates whether a given qualifier for a given candidate matched the context when a named resource is resolved to a candidate for some given context.

**TRUE** if this qualifier matched the environment against which it was evaluated; otherwise, **FALSE**.

The name of the qualifier.

The name of the qualifier.

The value of the qualifier.

The value of the qualifier.

A score that indicates how well the qualifier matched the context against which it was resolved.

A score in the range 0.0– 1.0.

An unchangeable view into a map of ResourceQualifier objects.

Gets the number of ResourceQualifier objects in the map.

The number of ResourceQualifier objects in the map.

Returns an iterator to enumerate the items in the map view.

The iterator. The current position of the iterator is index 0, or the end of the map view if the map view is empty.

Determines whether the map view contains the specified key.

The key to locate in the map view. **TRUE** if the key is found, otherwise **FALSE** if it is not found.

Returns the qualifier name at the specified key in the map view.

The key to locate in the map view. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Splits the map view into two views.

One half of the original map. The second half of the original map.

Notifies listeners of dynamic changes to a map of ResourceQualifier objects, such as when items get added or removed, and allows qualifier values to change.

Gets the number of ResourceQualifier objects in the observable map.

The number of ResourceQualifier objects in the map.

Occurs when the map changes.

Removes all items from the observable map.

Returns an iterator to enumerate the items in the observable map.

The iterator. The current position of the iterator is index 0, or the end of the observable map if the observable map is empty.

Returns an unchangeable view of the observable map.

The view of the map.

Determines whether the observable map contains the specified key.

The key to locate in the observable map. **TRUE** if the key is found, otherwise **FALSE** if it is not found.

Inserts or replaces an item in the observable map.

The key associated with the item to insert. The item to insert. **TRUE** if an item with the specified key is an existing item and was replaced, otherwise **FALSE**.

Returns the qualifier name at the specified key in the observable map.

The key to locate in the observable map. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the observable map.

The key associated with the item to remove.

Possible values for the persistence of a global qualifier value override.

The override value persists on the local machine.

The override value is not persistent.

An unchangeable view into a vector of ResourceQualifier objects.

Gets the number of ResourceQualifier objects in the view.

The number of objects in the view.

Returns an iterator to enumerate the items in the view.

The iterator. The current position of the iterator is index 0, or the end of the view if the view is empty.

Returns the ResourceQualifier at the specified index in the view.

The zero-based index of the ResourceQualifier in the view to return. The ResourceQualifier at the specified index.

Returns the ResourceQualifier objects that start at the specified index in the view.

The zero-based index of the start of the objects in the view to return. The objects in the view that start at *startIndex*. The number of objects returned.

Returns the index of a specified ResourceQualifier in the view.

The ResourceQualifier to find in the set. The zero-based index of the object, if found. The method returns zero if the object is not found. A Boolean that is **TRUE** if the object is found, otherwise **FALSE** if the object is not found.

Stores settings that determine whether the app provides suggestions based on local files, and that define the criteria used to locate and filter these suggestions.

Creates a new instance of the localContentSuggestionSettings class.

An Advanced Query Syntax (AQS) string that limits the types and kinds of files that are used to provide suggestions. If no Advanced Query Syntax (AQS) string is specified, suggestions are provided from all local files in locations specified by the locations property.

The Advanced Query Syntax (AQS) string that is used to refine which local, indexed files are used to provide suggestions. By default, this string is empty. Learn more about Advanced Query Syntax (AQS) in .

Indicates whether suggestions based on local files are displayed in the search pane.

True if suggestions from local files are displayed; otherwise, false. The default value of the object is false.

A list of the storageFolder objects that contain files that are used to provide suggestions. If the list is empty, suggestions are provided from files in all of the local libraries for which the app declared capabilities.

The list of storageFolder locations that contain files that are used to provide suggestions. By default, this list is empty and suggestions are provided from the local files in all of the libraries for which the app declared capabilities.

A list of the file properties whose values are used to provide suggestions from local files. If the list is empty, all of the file properties that are available for suggestions are used.

The list of the file properties that are used to provide suggestions from local files. By default, this list is empty and all of the file properties that are available for suggestions are used.

Provides information about query text that the user enters through an Input Method Editor (IME).

A list of the text alternatives for the current query text. These alternatives account for uncomposed text the user is entering in an IME.

A list of the text alternatives for the query text.

The length of the portion of the query text that the user is composing with an Input Method Editor (IME).

The length of the portion of the query text that the user is composing with an Input Method Editor (IME).

The starting location of the text that the user is composing with an Input Method Editor (IME).

The starting location of the query text that the user is composing with an Input Method Editor (IME).

Provides information about query text that the user enters through an Input Method Editor (IME).

Initializes a new instance of the SearchQueryLinguisticDetails class.

A list of the text alternatives for the current query text. The starting location of the text that the user is composing with an Input Method Editor (IME). The length of the portion of the query text that the user is composing with an Input Method Editor (IME).

A list of the text alternatives for the current query text. These alternatives account for uncomposed text the user is entering in an IME.

A list of the text alternatives for the query text.

The length of the portion of the query text that the user is composing with an Input Method Editor (IME).

The length of the portion of the query text that the user is composing with an Input Method Editor (IME).

The starting location of the text that the user is composing with an Input Method Editor (IME).

The starting location of the query text that the user is composing with an Input Method Editor (IME).

Represents a collection of search suggestions to be displayed in the search pane in response to a suggestionsrequested event.

The number of suggestions in the collection.

The number of suggestions.

Appends a query suggestion to the list of search suggestions for the search pane.

The text of the query suggestion.

Appends a list of query suggestions to the list of search suggestions for the search pane.

The list of query suggestions.

Appends a suggested search result to the list of suggestions to display in the search pane.

The text of the suggested result. The detail text for the suggested result. The unique tag that identifies this suggested result. The image to accompany the results suggestion. The image should be 40 x 40. Windows will scale or crop smaller or larger images. The alternate text for the image.

Appends a text label that is used to separate groups of suggestions in the search pane.

The text to use as a separator. This text should be descriptive of any suggestions that are appended after it.

Stores suggestions and information about the request for suggestions.

Indicates whether the request for suggestions to display is canceled.

**True** if the request was canceled, otherwise **false**. The default value is **false**.

The suggestions to display in the search pane or in-app search box for the current query. Apps provide suggestions to display by appending them to this SearchSuggestionCollection object.

The suggestions to display. Apps provide suggestions by appending them to this SearchSuggestionCollection object.

Gets an object that lets an app respond to a request for suggestions asynchronously.

An object that lets an app signal when it has fulfilled the request for search suggestions.

Enables the app to signal when it has finished populating a SearchSuggestionCollection object while handling the SuggestionsRequested event. Use a deferral if and only if your app needs to respond to a request for suggestions asynchronously.

Signals that the app has finished populating a SearchSuggestionCollection object while handling the SuggestionsRequested event.

Defines methods and properties you can use to get license and listing info about the current app and perform in-app product purchases.

Gets the GUID generated by the Windows Store when your app has been certified for listing in the Windows Store.

The GUID that identifies the app in the Windows Store.

Gets the license metadata for the current app.

The license metadata for the current app.

Gets the Uniform Resource Identifier (URI) of the app's listing page in the web catalog of the Windows Store.

The Uniform Resource Identifier (URI) of the app's listing page in the Windows Store.

Retrieves the promotion campaign ID for the current app.

The advertising campaign ID for your app.

Requests all receipts for the purchase of the app and any in-app products. For examples of how receipt information can be used, see Using receipts to verify product purchases.

An XML-formatted string that contains all receipt information for the purchase of the app and any in-app products.

Retrieves a Microsoft Store ID key that can be used to query for product entitlements or to consume product entitlements that are owned by the current user.

An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see Manage product entitlements from a service. An anonymous ID that identifies the current user in the context of services that you manage as the publisher of the current app. If you maintain user IDs in the context of your services, you can use this parameter to associate your ID for the current user with the new Microsoft Store ID key (the user ID will be embedded in the key). Otherwise, if you don't need to associate a user ID with the Microsoft Store ID key, you can pass any string value. The collections ID key for the current user. This key is valid for 90 days.

Retrieves a Microsoft Store ID key that can be used to grant entitlements for free products on behalf of the current user.

An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see Manage product entitlements from a service. An anonymous ID that identifies the current user in the context of services that you manage as the publisher of the current app. If you maintain user IDs in the context of your services, you can use this parameter to associate your ID for the current user with the new Microsoft Store ID key (the user ID will be embedded in the key). Otherwise, if you don't need to associate a user ID with the Microsoft Store ID key, you can pass any string value. The purchase ID key for the current user. This key is valid for 90 days.

Requests the receipt for the specified product ID. For examples of how receipt information can be used, see Using receipts to verify product purchases.

The unique identifier for the product that you specified this identifier when you submitted the app to the Microsoft Store An XML-formatted string that contains the receipt for the specified *productId.*

Returns a list of purchased consumable in-app products that have not been reported to the Microsoft Store as fulfilled.

When the operation completes, a list of consumable in-app products not yet reported as fulfilled is returned (UnfulfilledConsumable objects). Each item of this list provides the product ID, offer ID, and transaction ID associated with a product.

Loads the app's listing information asynchronously.

The apps' listing information. If the method fails, it returns an **HRESULT** error code.

Loads the app listing information asynchronously, returning features and products in the ProductListings collection that match all supplied keywords.

The list of keywords by which to filter the ProductListings collection that is returned in the ListingInformation object. The app's listing information, with ProductListings collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match all of the given keywords, the ProductListings collection will be empty.

Loads the app listing information asynchronously, returning features and products in the ProductListings collection that match any of the given products IDs.

The list of product IDs by which to filter the ProductListings collection. The app's listing information, with ProductListings collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no products or features are found that match the given product IDs, the ProductListings collection will be empty.

Notifies the Microsoft Store that the purchase of a consumable add-on (also called an in-app product or IAP) is fulfilled and that the user has the right to access the content.

The product ID of the consumable add-on to report as fulfilled. The transaction ID for the purchase of the consumable add-on. A FulfillmentResult value that indicates the fulfillment status for the consumable add-on.

Notifies the Microsoft Store that the application has fulfilled the in-app product. This product cannot be re-purchased until the app has confirmed fulfillment using this method.

The ID of the product that has been delivered to the user.

Requests the purchase of a full app license.

Determines if this method should return the receipts for this app. If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app purchases. If *includeReceipt* is set to false, this string is empty.

Requests the purchase of an add-on (also called an in-app product or IAP). Additionally, calling this method displays the UI that is used to complete the transaction via the Microsoft Store.

The product ID of the add-on to purchase. A PurchaseResults that contains the results of the in-app product purchase request.

Requests the purchase of an add-on (also called an in-app product or IAP). Additionally, calling this method displays the UI that is used to complete the transaction via the Microsoft Store.

RequestProductPurchaseAsync(productId, includeReceipt) may be altered or unavailable for releases after Windows 8.1. Instead, use RequestProductPurchaseAsync(productId). The product ID of the add-on to purchase. Determines if the method should return the receipts for the specified *productId.* A string providing in-app transaction details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml.

Requests the purchase of an add-on (also called an in-app product or IAP). Additionally, calling this method displays the UI that is used to complete the transaction via the Microsoft Store. This overload includes parameters you can use to display details for a specific offer within a large catalog of in-app purchases that is represented by a single product entry in the Store.

The product ID of the add-on to purchase. The specific in-app feature or content within the large purchase catalog represented on the Microsoft Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Microsoft Store only uses this value to itemize the PurchaseResults. The name of the app feature or content offer that is displayed to the user at time of purchase. A PurchaseResults that contains the results of the in-app product purchase request.

Defines methods and properties used to instantiate an object that you can use to get simulated license info during testing.

Gets a simulated app ID. Since CurrentAppSimulator is intended only for testing during app development, the returned CurrentAppSimulator.AppId will contain only 0's.

The GUID that identifies the app in the Windows Store.

Gets the simulated license metadata for the current app as provided by the simulation.

The license metadata for the current app as provided by the simulation.

Gets the simulated Uniform Resource Identifier (URI) that represents a Microsoft Store listing page for the current app.

The Uniform Resource Identifier (URI) of the Microsoft Store listing page for the current app as defined by the simulation.

Retrieves the promotion campaign ID for the current app.

The advertising campaign ID for your app.

Creates the async operation that the user can use to simulate requesting all receipts for this app and any in-app product purchases. For examples of how receipt information can be used, see Using receipts to verify product purchases.

An XML-formatted string that contains all receipts for this app and any in-app product purchases.

Creates the async operation that the user can use to simulate requesting the receipt for the specified product ID. For examples of how receipt information can be used, see Using receipts to verify product purchases.

The unique identifier for the product. This ID is that was specified when the product was submitted for the app to the Store. An XML-formatted string that contains the receipt for the specified product ID.

Returns a list of purchased consumable in-app products that have not been fulfilled locally.

When the operation completes, a list of unfulfilled consumable in-app products (UnfulfilledConsumable objects) is returned. Each item in this list provides the product ID, offer ID, and transaction ID associated with a product.

Loads the simulated app listing information asynchronously.

The app listing information as defined by the simulation. If the method fails, it returns an **HRESULT** error code.

Loads the simulated app listing information asynchronously, returning in-app products in the ProductListings collection that match all supplied keywords.

The list of keywords by which to filter the ProductListings collection that is returned in the ListingInformation object. The simulated app listing information, with ProductListings collection filtered by keywords. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match all of the given keywords, the ProductListings collection will be empty.

Loads the simulated app listing information asynchronously, returning available in-app products in the ProductListings collection that match any of the given products IDs.

The list of product IDs by which to filter the ProductListings collection. The simulated app listing information, with ProductListings collection filtered by product IDs. If the method fails, it returns an **HRESULT** error code. If no in-app products are found that match the given product IDs, the ProductListings collection will be empty.

Reloads the simulator using a StorageFile containing the **WindowsStoreProxy.xml** file.

The WindowsStoreProxy.xml file that the simulator uses. The async operation that reloads the simulator.

Simulates notifying the Microsoft Store that the purchase of a consumable add-on (also called an in-app product or IAP) is fulfilled and that the user has the right to access the content.

The product ID of the consumable add-on to report as fulfilled. The transaction ID for the simulated purchase of the consumable add-on. A FulfillmentResult value that indicates the fulfillment status for the consumable add-on.

Creates the async operation that simulates a user request to buy a full license for the current app.

Determines if the method should return the receipts for this app. If the *includeReceipt* parameter is set to true, this string contains XML that represents all receipts for the app and any in-app product purchases. If *includeReceipt* is set to false, this string is empty.

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Microsoft Store.

The product ID (as defined by the simulation) of the add-on to purchase. A PurchaseResults that contains the results of the simulated in-app product purchase request.

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Microsoft Store.

RequestProductPurchaseAsync(productId, includeReceipt) may be altered or unavailable for releases after Windows 8.1. Instead, use RequestProductPurchaseAsync(productId). The product ID (as defined by the simulation) of the add-on to purchase. Determines if the method should return the receipts for the specified *productId.* A string providing in-app product purchase details for the provided *productId*. If *includeReceipt* is set **true**, the returned string will include a full receipt xml.

Creates the async operation that displays the UI that is used to simulate the purchase of an add-on (also called an in-app product or IAP) from the Microsoft Store. This overload includes parameters you can use to display details for a specific offer within a large catalog of in-app purchases that is represented by a single product entry in the Store.

The product ID (as defined by the simulation) of the add-on to purchase. The specific in-app product within the large purchase catalog represented on the Microsoft Store by the *productId.* This value correlates with the content your app is responsible for fulfilling. The Microsoft Store only uses this parameter value to itemize the PurchaseResults. The name of the in-app product that is displayed to the user at time of purchase. A PurchaseResults that contains the results of the simulated in-app product purchase request.

Defines values used to indicate fulfillment status for a consumable in-app product.

The specified transaction ID has been passed or the consumable in-app product has already been fulfilled.

The purchase is not complete. At this point it is still possible for the transaction to be reversed due to provider failures and/or risk checks.

The purchase request has been reverted.

There was an issue receiving fulfillment status.

The purchased consumable in-app product was fulfilled.

Represents the method that will handle the LicenseChanged event.

Provides access to the current app's license metadata.

Gets the license expiration date and time relative to the system clock.

The date and time that the app's trial license will expire.

Gets a value that indicates whether the license is active.

Returns true if the license is active, and otherwise false. Returns false if the license is missing, expired, or revoked. See the remarks in IsTrial for more info.

Gets a value that indicates whether the license is a trial license.

Returns true if the license is a trial license, and otherwise false.

Gets the associative list of licenses for in-app products that the user is currently entitled to.

The associative list of feature licenses.

Raises a notification event when the status of the app's license changes.

Provides the listing info that describes the app in the Microsoft Store.

Gets the age rating for the app.

The age rating.

Gets the currency code associated with the user's market, such as **USD** or **CAD**.

The currency code associated with the user's market, such as **USD** or **CAD**.

Gets the country code associated with the user's location, such as **US** or **CA**, that is used to identify their market for transactions in the current session.

The country code associated with the user's location, such as **US** or **CA**.

Gets the app's description in the current market.

The app's description in the current market.

Gets the app's base price formatted for the current market and currency.

The app's base price with the appropriate formatting for the current market and currency.

Gets the app's purchase price formatted for the current market and currency.

The app's purchase price with the appropriate formatting for the current market and currency.

Gets a value that indicates whether the app is on sale.

Returns true if the app is on sale, and otherwise false.

Gets the app's name in the current market.

The app's name in the current market.

Gets information about add-ons (also called in-app products or IAPs) available for purchase.

The array of ProductListing objects that describes the app's add-ons.

Gets the end date of the sale period for the app.

The date and time that the app's sale period will end.

Provides info about a license that is associated with an add-on (also called an in-app product or IAP).

Gets the current expiration date and time of the add-on (also called an in-app product or IAP) license.

The date and time indicating when the add-on license expires.

Indicates if the add-on (also called an in-app product or IAP) license is currently active.

Returns **true** if the add-on's license is active, and otherwise **false**. This property can return **false** if the license is missing, expired, or revoked.

Indicates if the add-on (also called an in-app product or IAP) is consumable. A consumable add-on can be purchased, used, and purchased again.

**true** if the add-on is a consumable add-on; Otherwise, **false**.

Gets the ID of an add-on (also called an in-app product or IAP). This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase.

The ID specified in Partner Center to identify this add-on.

Provides localized information that details an add-on (also called an in-app product or IAP).

Gets the currency code associated with the user's market, such as **USD** or **CAD**.

The currency code associated with the user's market, such as **USD** or **CAD**.

Gets the description for the add-on (also called an in-app product or IAP).

The description for the product.

Gets the base price for the add-on (also called an in-app product or IAP) with the appropriate formatting for the current market.

The base price for the add-on with the appropriate formatting for the current market.

Gets the purchase price for the in-app product with the appropriate formatting for the current market.

The purchase price with the appropriate formatting for the current market.

Gets the URI of the image associated with the add-on (also called an in-app product or IAP).

The URI to the image associated with the add-on.

Gets a value that indicates whether the add-on (also called an in-app product or IAP) is on sale.

Returns true if the in-app product is on sale, and otherwise false.

Gets the list of keywords associated with the add-on (also called an in-app product or IAP). These strings correspond to the value of the **Keywords** field in the properties page for the add-on in Partner Center. These keywords are useful for filtering product lists by keyword, for example, when calling LoadListingInformationByKeywordsAsync.

The keywords associated with the add-on.

Gets the descriptive name of the add-on (also called an in-app product or IAP) that is displayed customers in the current market.

The add-on's descriptive name as it is seen by customers in the current market.

Gets the product ID for the add-on that this **ProductListing** represents.

The product ID for the add-on.

Gets the type of this add-on (also called an in-app product or IAP). Possible values are defined by ProductType.

The product type. Possible values include **Consumable** and **Durable**.

Gets the end date of the sale period for the add-on (also called an in-app product or IAP).

The date and time that the add-on's sale period will end.

Gets the custom developer data string (also called a tag) that contains custom information about an add-on (also called an in-app product or IAP). This string corresponds to the value of the **Custom developer data** field in the properties page for the add-on in Partner Center.

The custom developer data for the add-on.

Used to provide the product name that is displayed to the user at time of purchase. This class is used in the creation of a RequestProductPurchaseAsync operation to visually represent a specific offer within a large catalog of in-app products, which is represented by a single product entry in the Microsoft Store.

Creates an instance of ProductPurchaseDisplayProperties.

Creates an instance of ProductPurchaseDisplayProperties that includes the specified product name to display to the user.

The product name displayed to the user.

Windows Phone only. This is an internal product description.

Internal product description.

Windows Phone only. Gets or sets the location of an image used to represent the product at time of purchase.

The image location.

Gets or sets the product name that is displayed to the user at time of purchase.

The product name.

Defines values used to indicate the transaction status when purchasing an in-app product.

The transaction did not complete because this in-app product has already been purchased by the user, and it cannot be purchased again.

The transaction did not complete because the last purchase of this consumable in-app product has not been reported as fulfilled to the Microsoft Store.

The purchase did not occur because the user decided not to complete the transaction (or the transaction failed for other reasons).

The transaction succeeded and the user has been notified.

Specifies the product type for an in-app product.

A consumable product.

A durable product.

The product type is unknown.

Contains information detailing the results of an in-app product purchase transaction.

A unique ID used to identify a specific in-app product within a large catalog.

Unique string used to identify a particular in-app product with a large catalog.

A full receipt that provides a transaction history for the purchase of an in-app product.

An XML-formatted string.

The current state of the purchase transaction for an in-app product.

A purchase state value defined by the ProductPurchaseStatus enumeration.

A unique transaction ID associated with the purchase of a consumable in-app product.

A unique ID associated with a transaction.

Contains purchase and product information for an unfulfilled consumable in-app product.

A unique ID used to identify a consumable in-app product within a large purchase catalog.

The offer ID.

A unique ID used to identify a consumable in-app product. This ID is used by the app to get info about the product or feature that is enabled when the customer buys it through an in-app purchase.

The product ID.

A unique ID used to identify the transaction that included the purchase of a consumable in-app product.

The transaction ID.

Provides members for managing license info for apps.

Installs the specified app license.

The contents of the license to install. An object that represents the installation operation.

Gets license entitlement info for the specified products.

The content IDs of the products for which to get license entitlement info. The key IDs of the products for which to get license entitlement info. An asynchronous operation that, on successful completion, returns a LicenseSatisfactionResult object that provides license entitlement info for the specified products.

Refreshes license info for app licenses on the current device.

A LicenseRefreshOption that indicates whether to refresh all app licenses on the device or only the licenses for currently running apps. An object that represents the asynchronous operation.

Defines values that can be used with the LicenseManager.RefreshLicensesAsync method to specify which app licenses to refresh on the current device.

Refreshes all app licenses on the device.

Refreshes only the licenses for currently running apps.

Contains license entitlement info for a product.

Gets a value that indicates whether a license entitlement exists for the product.

True if a license entitlement exists for the product; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with the current device.

True if the license entitlement is associated with the current device; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with installation media.

True if the license entitlement is associated with installation media; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with an open license.

True if the license entitlement is associated with an open license; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with a pass.

True if the license entitlement is associated with a pass; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with the current signed in user.

True if the license entitlement is associated with the current signed in user; otherwise, false.

Gets a value that indicates whether the license entitlement is associated with a trial.

True if the license entitlement is associated with a trial; otherwise, false.

Provides license entitlement information that is returned by the GetSatisfactionInfosAsync method for the specified products.

Contains the error code that was returned by GetSatisfactionInfosAsync.

The error code that was returned by GetSatisfactionInfosAsync.

Provides access to entitlement info that is returned by the GetSatisfactionInfosAsync method.

A map of key and value pairs that represent entitlement info for the specified products. In each pair, the key is a content ID that you passed to GetSatisfactionInfosAsync, and the value is a LicenseSatisfactionInfo object that provides entitlement info for the corresponding product.

Defines values that represent the supported download mode types in the Delivery Optimization settings for the current device. The DownloadMode property returns one of these values.

Delivery Optimization is bypassed and BITS is used instead.

Group peer sharing for Delivery Optimization is enabled. Peering occurs across internal subnets, between devices that belong to the same group, including devices in remote offices.

Peer-to-peer caching is disabled but Delivery Optimization can still download content from Windows Update servers or WSUS servers.

Internet peer sources for Delivery Optimization are enabled.

Peer sharing for Delivery Optimization on the same network is enabled.

Delivery Optimization cloud services are disabled.

Defines values that represent the supported download mode sources in the Delivery Optimization settings for the current device. The DownloadModeSource property returns one of these values.

The download mode is based on default values.

The download mode is configured by policy (Group Policy or an MDM solution).

Provides access to the Delivery Optimization settings for the current device.

Gets the current download mode type in the Delivery Optimization settings for the current device.

The current download mode type in the Delivery Optimization settings for the current device.

Gets the source of the current download mode in the Delivery Optimization settings for the current device.

The source of the current download mode in the Delivery Optimization settings for the current device.

Gets the Delivery Optimization settings for the current device.

An object that provides the Delivery Optimization settings for the current device.

Defines static methods and properties for accessing information about the device hardware and configuring information about the system, the mobile operator, and the active user account. These members are used in various Microsoft Store scenarios.

Gets hardware manufacturer information for the current device.

An object that provides information about the hardware manufacturer of the current device.

Gets or sets a value that indicates whether the Microsoft Store prompts the user before making a purchase.

A **UInt32** value that indicates whether the Microsoft Store prompts the user before making a purchase. <table>

Given a list of hardware features, this method returns a modified list that contains only the hardware features that are supported on the current device.

A list of StoreSystemFeature objects that represent the hardware features to be queried on the current device. An asynchronous operation that, on successful completion, returns a list of hardware features that are supported on the current device. If you use Asynchronous programming, the result type is a read-only list/vector of StoreSystemFeature items. (You can use APIs of IVectorView<StoreSystemFeature> for C++ or JavaScript, APIs of IReadOnlyList<StoreSystemFeature> for .NET.)

Gets the Store user account ID for the current Azure AD user who is signed in to the Store.

The Store user account ID for the current Azure AD user who is signed in to the Store.

Gets the Store user account ID for the specified Azure AD user who is signed in to the Store.

A Windows.System.User object that identifies the Azure AD user for which you want to retrieve the user account ID. The Store user account ID for the specified user.

Gets a value that indicates whether the Windows Store prompts the specified user before making a purchase.

An object that identifies the user for which to query. A **UInt32** value that indicates whether the Windows Store prompts the specified user before making a purchase. <table>

Gets Microsoft Store log data for the current device.

A value that specifies options for the log data request. An asynchronous operation that, on successful completion, returns an IRandomAccessStreamReference object that contains the log data.

Gets the Store user account ID for the current user who is signed in to the Store.

The Store user account ID for the current user who is signed in to the Store.

Gets the Store user account ID for the specified user who is signed in to the Store.

A Windows.System.User object that identifies the user for which you want to retrieve the Store user account ID. The Store user account ID for the specified user.

Determines whether the current user has a Microsoft Store account.

True if the current user has a Microsoft Store account; otherwise false.

Determines whether the specified user has a Microsoft Store account.

An object that identifies the user for which to query. True if the specified userhas a Microsoft Store account; otherwise false.

Determines whether apps can be pinned to the desktop on the current device.

True if apps can be pinned to the desktop on the current device; otherwise, false. For example, this method returns false if the current device has no desktop.

Determines whether apps can be pinned to the Start menu on the current device.

True if apps can be pinned to the Start menu on the current device; otherwise, false. For example, this method returns false if the current device has no Start menu.

Determines whether apps can be pinned to the taskbar on the current device.

True if apps can be pinned to the taskbar on the current device; otherwise, false. For example, this method returns false if the current device has no taskbar.

Determines whether the specified user ID is also being used to sign in to the Microsoft Store on the device.

The user ID (typically obtained from the WebAccount.Id property) to check. True if the user account specified by *webAccountId* is the same account that is signed in to the Microsoft Store; otherwise false.

Determines whether the specified user and user ID is also being used to sign in to the Microsoft Store on the device.

An object that identifies the user for which to query. The user ID (typically obtained from the WebAccount.Id property) to check. True if the user account specified by *webAccountId* is the same account that is signed in to the Microsoft Store; otherwise false.

Pins the specified app to the desktop for the all users on the current device.

The package family name of the app to pin to the desktop.

Pins the specified app to the desktop for the specified user on the current device.

The user for which the app will be pinned to the desktop. The package family name of the app to pin to the desktop.

Sets the Store user account ID for the current Azure AD user who is signed in to the Store so that other apps can query against this ID.

The Store user account ID (typically obtained from the WebAccount.Id property) to set for the Azure AD user who is currently signed in to the Store.

Sets the Store user account ID for the specified Azure AD user so that other apps can query against this ID.

A Windows.System.User object that identifies the Azure AD user whose Store user account ID you want to set. The Store user account ID (typically obtained from the WebAccount.Id property) to set for the specified Azure AD user.

Configures mobile operator information for the device.

The mobile operator ID. The maximum app download size defined by the mobile operator, in MB. The maximum OS update download size defined by the mobile operator, in MB.

Sets a value that indicates whether the Microsoft Store prompts the user before making a purchase.

An object that identifies the user for which to perform this operation.

Sets the Store user account ID for the current user who is signed in to the Store so that other apps can query against this ID.

The Store user account ID (typically obtained from the WebAccount.Id property) to set for the user who is currently signed in to the Store.

Sets the Store user account ID for the specified user so that other apps can query against this ID.

A Windows.System.User object that identifies the user whose Store user account ID you want to set. The Store user account ID (typically obtained from the WebAccount.Id property) to set for the specified user.

Configures miscellaneous system information for the device.

The ID of the hardware manufacturer. The ID of the Windows Store content modifier. The expiration date for the system configuration. A descriptor string that specifies the hardware components supported by the device.

Determines whether the Microsoft Store for Business is enabled for the current user.

True if the Microsoft Store for Business is enabled for the current user; otherwise false.

Determines whether the Microsoft Store for Business is enabled for the specified user.

A Windows.System.User object that identifies the user for whom you want to determine whether the Microsoft Store for Business is enabled. True if the Microsoft Store for Business is enabled for the specified user; otherwise false.

Provides information about the manufacturer for the current device.

Gets the hardware manufacture ID for the current device.

The hardware manufacture ID for the current device.

Gets the name of the hardware manufacturer for the current device.

The name of the hardware manufacturer for the current device.

Gets the model name for the current device.

The model name for the current device.

Gets the ID of the Microsoft Store content modifier.

The ID of the Microsoft Store content modifier.

Defines options that can be specified while using GetStoreLogDataAsync to get Microsoft Store log data for the current device.

No log options are specified.

Try to get log data with elevated privileges.

Defines static methods for retrieving the in-app product SKUs available for the current app and requesting the purchase of an in-app product SKU for the app.

Retrieves the in-app products available for the current app asynchronously, including the available SKUs for each product.

An asynchronous operation that, on successful completion, returns the collection of in-app products for the current app (including the available SKUs for each product). If you use Asynchronous programming, the result type is a read-only list/vector of StorePreviewProductInfo items. (You can use APIs of IVectorView<StorePreviewProductInfo> for C++ or JavaScript, APIs of IReadOnlyList<StorePreviewProductInfo> for .NET.)

Requests the purchase of a SKU for an in-app product that is associated with the current app. Calling this method displays the UI that is used to complete the transaction via the Microsoft Store.

Specifies the ID of the in-app product. This corresponds to the StorePreviewProductInfo.ProductId value and the StorePreviewSkuInfo.ProductId values for all SKUs of the in-app product. Specifies the ID of the SKU for the in-app product. This corresponds to the StorePreviewSkuInfo.SkuId value. An asynchronous operation that, on successful completion, returns a StorePreviewPurchaseResults that contains the results of the in-app product purchase request.

Provides information about an in-app product, including details about available SKUs.

Gets the description of the in-app product.

The description for the in-app product.

Gets the ID of the in-app product.

The ID of the in-app product. This corresponds to the StorePreviewSkuInfo.ProductId value for all SKUs of the in-app product.

Gets the type of the in-app product.

One of the following strings that specifies the type of the in-app product. <table>

Gets information about the available SKUs for the in-app product.

A list of StorePreviewSkuInfo objects that provide information about the available SKUs for the in-app product.

Gets the name of the in-app product that is displayed to customers.

The name of the in-app product that is displayed to customers.

Defines values that are used to indicate the transaction status when purchasing an in-app product SKU by using the RequestProductPurchaseByProductIdAndSkuIdAsync method.

The transaction did not complete because this in-app product SKU has already been purchased by the user, and it cannot be purchased again. This value only applies to durable in-app products.

The transaction did not complete because the last purchase of this consumable in-app product SKU has not been reported as fulfilled to the Microsoft Store. This value only applies to consumable in-app products.

The purchase did not occur because the user decided not to complete the transaction (or the transaction failed for other reasons).

The transaction succeeded and the user has been notified.

Contains information about the results of a purchase transaction for an in-app product SKU that was purchased by using the RequestProductPurchaseByProductIdAndSkuIdAsync method.

Gets the current state of the purchase transaction for an in-app product SKU that was purchased by using the RequestProductPurchaseByProductIdAndSkuIdAsync method.

The status of the purchase transaction.

Provides information about the available SKUs for an in-app product.

Gets the currency code for the current market.

The currency code for the current market.

Gets custom developer data for the current SKU.

Custom developer data for the current SKU.

Gets the description for the current SKU.

The description for the current SKU.

Gets extended data for the current SKU.

Extended data for the current SKU.

Gets the current SKU's purchase price with the appropriate formatting for the current market.

The current SKU's purchase price with the appropriate formatting for the current market.

Gets the ID of the product that this SKU is associated with.

The ID of the product that this SKU is associated with. This corresponds to the StorePreviewProductInfo.ProductId value.

Gets the ID of this SKU.

The ID of this SKU.

Gets a string that specifies the type of the in-app product SKU.

A string that specifies the type of the in-app product SKU.

Gets the name of the in-app product SKU that is displayed to customers.

The name of the in-app product SKU that is displayed to customers.

Defines values that represent hardware features that can be queried for the current device by using the FilterUnsupportedSystemFeaturesAsync method.

The device chipset uses the ARM CPU architecture.

The device chipset uses the ARM64 CPU architecture.

The device chipset uses the x64 CPU architecture.

The device chipset uses the x86 CPU architecture.

The device has a front-facing camera.

The device has a rear-facing camera.

The device supports Direct3D 12 feature level 12.0.

The device supports Direct3D 12 feature level 12.1.

The device supports DirectX10.

The device supports DirectX11.

The device supports DirectX9.

The device has a gyroscope.

The device supports hover touch.

The device has a magnetometer.

The device has 12 GB of memory.

The device has 16 GB of memory.

The device has 1 GB of RAM.

The device has 20 GB of memory.

The device has 2 GB of RAM.

The device has 300 MB of RAM.

The device has 4 GB of memory.

The device has 6 GB of memory.

The device has 750 MB of RAM.

The device has 8 GB of memory.

The device includes an NFC device.

The display resolution is 720p.

The display resolution is WVGA.

The display resolution is 720p or WVGA.

The display resolution is WVGA or WXGA.

The display resolution is WXGA

The display resolution is WXGA or 720p.

The device has 1 GB of video memory.

The device has 2 GB of video memory.

The device has4 GB of video memory.

The device has 6 GB of video memory.

Provides the ability to host a custom UI to request an authentication token.

Requests an authentication token for the specified account using the specified custom UI.

An object that represents the request to an online identity provider for an authentication token. An object that identifies the account for which to request the authentication token. The custom UI that is shown to the user to retrieve information needed for the authentication token (such as a user ID or password). An asynchronous operation that, on successful completion, returns a WebTokenRequestResult object that represents the results of the web token request.

Requests an authentication token using the specified custom UI.

An object that represents the request to an online identity provider for an authentication token. The custom UI that is shown to the user to retrieve information needed for the authentication token (such as a user ID or password). An asynchronous operation that, on successful completion, returns a WebTokenRequestResult object that represents the results of the web token request.

Defines the types of toasts that can be shown by the system during and after app installation.

The operating system chooses the appropriate toast.

No toast.

A toast with a popup.

A toast without a popup.

Represents an app that is in the installation queue.

Retrieves information about app installs that are children of the current app install. This property only returns a value if the current app install is the parent of other app installs that are part of a the same app bundle.

A collection of AppInstallItem objects that represent the children app installs of the current app install.

Gets or sets the notification toast mode for when the app installation completes.

An object that indicates whether the system will show a toast or not when an app completes its install. The choices include default, toast with or without a popup, and no toast. If the default is set, the system will choose the appropriate toast.

Gets or sets the notification toast mode for when the app installation is in progress.

A value that indicates whether the system will show a toast or not during app installation. Choices include default, toast with or without a popup, and no toast. If the default is set, the system will choose the appropriate toast.

Gets the type of the current app install.

A value that indicates whether the app is being installed, updated, or repaired.

Indicates whether the current app install was initiated by the user.

True if the current app install was initiated by the user; otherwise, false.

Indicates whether the current app install is part of an app bundle, and therefore pausing or canceling the app install might affect other items in the installation queue.

True if the current app install is part of an app bundle, and therefore pausing or canceling the app install might affect other items in the installation queue; otherwise, false.

Gets a value that indicates whether the app that is in the installation queue will be automatically launched after it is installed.

True if the app in the installation queue will be automatically launched after it is installed; otherwise, false.

Gets the package family name for the current app.

The package family name for the current app.

Gets or sets a value that indicates whether the product being installed should be pinned to the desktop after installation is complete.

True to pin the app to the desktop; otherwise, false.

Gets or sets a value that indicates whether the product being installed should be pinned to the **Start** menu after installation is complete.

True to pin the app to the **Start** menu; otherwise, false.

Gets or sets a value that indicates whether the product being installed should be pinned to the taskbar after installation is complete.

True to pin the app to the taskbar; otherwise, false.

Gets the product ID for the current app.

The product ID for the current app.

Occurs when the installation of the current app has finished.

Occurs when the installation status of the current app has changed.

Cancels the installation of the current app.

Cancels the installation of the current app, with the option to generate telemetry data.

A correlation vector string that can be used to generate telemetry data.

Gets the installation status of the current app.

A value that specifies the installation status of the current app.

Pauses the installation of the current app.

Pauses the installation of the current app, with the option to generate telemetry data.

A correlation vector string that can be used to generate telemetry data.

Restarts the installation of the current app.

Restarts the installation of the current app, with the option to generate telemetry data.

A correlation vector string that can be used to generate telemetry data.

Provides members for programmatically installing apps, including the ability to start an app install and get a list of app installs currently in progress.

Creates and initializes a new instance of the AppInstallManager class.

Gets or sets the user identity associated with the app installs.

The user identity associated with the app installs.

Retrieves information about all apps that are currently in the installation queue.

A collection of AppInstallItem objects that represent all apps that are currently in the installation queue.

Retrieves information about all the apps that are part of a single app bundle that is currently in the installation queue.

A collection of AppInstallItem objects that represent all the apps that are part of a single app bundle that is currently in the installation queue.

Gets or sets the auto update setting for apps on the current computer or device.

A value that specifies the auto update setting for apps on the current computer or device.

Gets or sets a value that indicates whether the calling app has elevated administrative privileges to ensure installing an app for all users will succeed.

True indicates the calling app has elevated administrative privileges; otherwise, false.

Occurs when an app has finished installing.

Occurs when the status of an app in the installation queue has changed.

Cancels the installation of the specified app.

The product ID of the app whose installation should be canceled.

Cancels the installation of the specified app, with the option to generate telemetry data.

The product ID of the app whose installation should be canceled. A correlation vector string that can be used to generate telemetry data.

Grants a free entitlement for the specified app to all users on the current device.

The Store ID of the app for which you want to grant the entitlement. The ID of the campaign that is associated with the entitlement. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns a GetEntitlementResult object that indicates the status of the entitlement grant.

Grants a free entitlement for the specified app to the current user.

The Store ID of the app for which you want to grant the entitlement. The ID of the campaign that is associated with the entitlement. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns a GetEntitlementResult object that indicates the status of the entitlement grant.

Grants a free entitlement for the specified app to the specified user.

A Windows.System.User object that represents the user to which you want to grant the entitlement. The Store ID of the app for which you want to grant the entitlement. The ID of the campaign that is associated with the entitlement. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns a GetEntitlementResult object that indicates the status of the entitlement grant.

Determines whether the specified app has permission to install on the current computer or device.

The product ID of the app that this method will check to determine if it has permission to be installed. An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false.

Determines whether the specified app has permission to install on the current computer or device, with the option to generate telemetry data.

The product ID of the app that this method will check to determine if it has permission to be installed. The SKU ID of the app that this method will check to determine if it has permission to be installed. The catalog ID of the app that this method will check to determine if it has permission to be installed. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false.

Determines whether the specified app has permission to install on the current computer or device for the specified user, with the option to generate telemetry data.

An object that identifies the user to specify for this operation. The product ID of the app that this method will check to determine if it has permission to be installed. The SKU ID of the app that this method will check to determine if it has permission to be installed. The catalog ID of the app that this method will check to determine if it has permission to be installed. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns true if the app has permission to be installed; otherwise false.

Determines whether the specified app can be installed on the current computer or device.

The product ID of the app that this method will check to determine if it can be installed. The SKU ID of the app that this method will check to determine if it can be installed. An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false.

Determines whether the specified app can be installed on the current computer or device for the specified user.

An object that identifies the user to specify for this operation. The product ID of the app that this method will check to determine if it can be installed. The SKU ID of the app that this method will check to determine if it can be installed. An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false.

Returns a value that indicates whether the package with the specified identity info is allowed to be installed on the current device.

A correlation vector string that can be used to generate telemetry data for the operation. The identity name of the package, as specified in the package manifest. The publisher name of the package, as specified in the package manifest. True if the package with the specified identity info is allowed to be installed on the current device; otherwise, false.

Returns a value that indicates whether the package with the specified identity info is allowed to be installed on the current device for the specified user.

An object that identifies the user to specify for this operation. A correlation vector string that can be used to generate telemetry data for the operation. The identity name of the package, as specified in the package manifest. The publisher name of the package, as specified in the package manifest. True if the package with the specified identity info is allowed to be installed on the current device for the specified user; otherwise, false.

Determines whether the specified app is blocked by policy on the current computer or device.

The name of the app that this method will check to determine if is blocked by policy. The publisher name of the app that this method will check to determine if is blocked by policy. An asynchronous operation that, on successful completion, returns true if the app can be installed; otherwise false.

Moves the specified app to the front of the download queue.

The product ID of the app to move to the front of the download queue. A correlation vector string that can be used to generate telemetry data.

Pauses the installation of the specified app.

The product ID of the app whose installation should be paused.

Pauses the installation of the specified app, with the option to generate telemetry data.

The product ID of the app whose installation should be paused. A correlation vector string that can be used to generate telemetry data.

Restarts the installation of the specified app.

The product ID of the app whose installation should be restarted.

Restarts the installation of the specified app, with the option to generate telemetry data.

The product ID of the app whose installation should be restarted. A correlation vector string that can be used to generate telemetry data.

Searches for all available updates to apps installed on the current computer or device.

An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Searches for all available updates to apps installed on the current computer or device, with the option to generate telemetry data.

A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Searches for all available updates to apps installed on the current computer or device, with the ability to allow forced app restarts and the option to generate telemetry data.

A correlation vector string that can be used to generate telemetry data. The ID of the caller. Provides additional options for the operation, including the ability to allow forced app restarts. An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Searches for all available updates to apps installed on the current computer or device for the specified user, with the option to generate telemetry data.

An object that identifies the user to specify for this operation. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Searches for all available updates to apps installed on the current computer or device for the specified user, with the ability to allow forced app restarts and the option to generate telemetry data.

An object that identifies the user to specify for this operation. A correlation vector string that can be used to generate telemetry data. The ID of the caller. Provides additional options for the operation, including the ability to allow forced app restarts. An asynchronous operation that, on successful completion, returns the collection of apps that have available updates. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Searches for updates for the specified app.

The product ID of the app to be queried for updates. The SKU to be queried for updates. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the available update.

Searches for updates for the specified app, with the option to generate telemetry data.

The product ID of the app to be queried for updates. The SKU ID of the app to be queried for updates. The catalog ID of the app to be queried for updates. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the available update.

Searches for updates for the specified app, with the ability to allow a forced app restart and the option to generate telemetry data.

The product ID of the app to be queried for updates. The SKU ID of the app to be queried for updates. A correlation vector string that can be used to generate telemetry data. The ID of the caller. Provides additional options for the operation, including the ability to allow a forced app restart. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the available update.

Searches for updates for the specified app and user, with the option to generate telemetry data.

An object that identifies the user to specify for this operation. The product ID of the app to be queried for updates. The SKU ID of the app to be queried for updates. The catalog ID of the app to be queried for updates. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the available update.

Searches for updates for the specified app and user, with the ability to allow a forced app restart and the option to generate telemetry data.

An object that identifies the user to specify for this operation. The product ID of the app to be queried for updates. The SKU ID of the app to be queried for updates. A correlation vector string that can be used to generate telemetry data. The ID of the caller. Provides additional options for the operation, including the ability to allow a forced app restart. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the available update.

Starts the installation of the specified app.

The product ID of the app to install. The SKU ID of the app to install. True to attempt to repair the installation of an app that is already installed; otherwise, false. True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the app that was added to the installation queue.

Starts the installation of the specified app, with the option to generate telemetry data.

The product ID of the app to install. The SKU ID of the app to install. True to attempt to repair the installation of an app that is already installed; otherwise, false. True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. The catalog ID of the app to install. The bundle ID of the app to install. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the app that was added to the installation queue.

Starts the installation of the specified app or app bundle.

The product ID of the app to install. The catalog ID of the app to install. The flight ID of the app to install. The ID of the caller. True to attempt to repair the installation of an app that is already installed; otherwise, false. True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. A correlation vector string that can be used to generate telemetry data. The package storage volume where the app or app bundle will be installed. An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Starts the installation of the specified app or app bundle, with the ability to specify additional install options such as whether to allow a forced app restart.

The product ID of the app to install. The flight ID of the app to install. The ID of the caller. A correlation vector string that can be used to generate telemetry data. Provides additional options for the operation, including the ability to allow a forced app restart. An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Starts the installation of the specified app or app bundle for the specified user.

An object that identifies the user to specify for this operation. The product ID of the app to install. The catalog ID of the app to install. The flight ID of the app to install. The ID of the caller. True to attempt to repair the installation of an app that is already installed; otherwise, false. True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings. A correlation vector string that can be used to generate telemetry data. The package storage volume where the app or app bundle will be installed. An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Starts the installation of the specified app or app bundle for the specified user, with the ability to specify additional install options such as whether to allow a forced app restart.

An object that identifies the user to specify for this operation. The product ID of the app to install. The flight ID of the app to install. The ID of the caller. A correlation vector string that can be used to generate telemetry data. Provides additional options for the operation, including the ability to allow a forced app restart. An asynchronous operation that, on successful completion, returns the app or set of apps (for an app bundle) that were added to the installation queue. If you use Asynchronous programming, the result type is a read-only list/vector of AppInstallItem items. (You can use APIs of IVectorView<AppInstallItem> for C++ or JavaScript, APIs of IReadOnlyList<AppInstallItem> for .NET.)

Starts the update of an app specified by the package family name.

The package family name of the app to update. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the app update that was added to the installation queue.

Starts the update of an app specified by the package family name, with the option to generate telemetry data.

The package family name of the app to update. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the app update that was added to the installation queue.

Starts the update of an app for a given user specified by the package family name, with the option to generate telemetry data.

An object that identifies the user to specify for this operation. The package family name of the app to update. A correlation vector string that can be used to generate telemetry data. An asynchronous operation that, on successful completion, returns an AppInstallItem that represents the app update that was added to the installation queue.

Provides data for the ItemCompleted and ItemStatusChanged events.

Gets an object that describes the app that has finished installing (for the ItemCompleted event) or whose installation status has changed (for the ItemStatusChanged event).

An object that describes the app that has finished installing or whose installation status has changed.

Provides options you can use in several method overloads of the AppInstallManager class for installing app updates.

Creates and initializes a new instance of the AppInstallOptions class.

Gets or sets a value that indicates whether to allow a forced restart of the app that is being installed.

True to allow a forced restart of the app that is being installed; otherwise, false.

Gets or sets the promotion campaign ID that is associated with the app to install.

The promotion campaign ID that is associated with the app to install.

Gets or sets the catalog ID of the app to install.

The catalog ID of the app to install.

Gets or sets the notification toast mode for when the app installation completes.

A value that indicates whether the system will show a toast or not when an app completes its install. Choices include default, toast with or without a popup, and no toast. If the default is set, the system will choose the appropriate toast.

Gets or sets the extended promotion campaign ID that is associated with the app to install.

The extended promotion campaign ID that is associated with the app to install.

Gets or sets a value that indicates whether to install the app to non-removable storage even if the user has configured apps to install to SD card, or whether to install the app to non-removable storage or SD card according to the user's settings.

True to install the app to non-removable storage even if the user has configured apps to install to SD card; false to install the app to non-removable storage or SD card according to the user's settings.

Gets or sets a value that indicates whether the application will be installed for all users.

True to install the application for all users; false to install the application for the current user only.

Gets or sets the notification toast mode for when the app installation is in progress.

A value that indicates whether the system will show a toast or not during app installation. Choices include default, toast with or without a popup, and no toast. If the default is set, the system will choose the appropriate toast.

Gets or sets a value that indicates whether to automatically launch the app after it is installed.

True to automatically launch the app after it is installed; otherwise, false.

Gets or sets a value that determines whether the product being installed should be pinned to the desktop after installation is complete.

True to pin the app to the desktop; otherwise, false.

Gets or sets a value that indicates whether the product being installed should be pinned to the **Start** menu after installation is complete.

True to pin the app to the **Start** menu; otherwise, false.

Gets or sets a value that indicates whether the product being installed should be pinned to the taskbar after installation is complete.

True to pin the app to the taskbar; otherwise, false.

Gets or sets a value that indicates whether to attempt to repair the installation of an app that is already installed.

True to attempt to repair the installation of an app that is already installed; otherwise, false.

Gets or sets a value that indicates whether the installation of the app should pause after the download and staging step but not complete the final install.

True to pause the install after the download and staging of the app but not complete the final app registration; otherwise, false.

Gets or sets the package storage volume where the app or app bundle will be installed.

The package storage volume where the app or app bundle will be installed.

Defines the app install states that are returned by the InstallState property of the AppInstallStatus class.

The license is being acquired for the app.

The app install is canceled.

The app install is complete.

The app is being downloaded.

The app install encountered an error.

The app is in the process of being installed.

The app install was paused.

The app install was paused because the battery is low.

The app install was paused because the app package was large enough to trigger a prompt for the user to download the app over Wi-Fi.

The app install was paused because the app package was large enough to require the user to download the app over Wi-Fi.

The app install is pending.

The app is ready to download.

The app data is being restored.

The app install is starting.

Describes the status of an app that is in the installation queue.

Gets the number of bytes that have been downloaded for the current app.

The number of bytes that have been downloaded for the current app.

Gets the download size in bytes for the current app.

The download size in bytes for the current app.

Gets the error code for an app that has encountered an installation failure.

The error code for an app that has encountered an installation failure.

Gets the installation state of the current app.

A value that specifies the installation state of the current app.

Gets a value that indicates whether an app restart is pending.

True if an app restart is pending; otherwise, false.

Gets the completion percentage for the installation of the current app.

The completion percentage for the installation of the current app.

Gets a value that indicates whether the app can be launched, even if the app has not yet finished installing.

True if the app can be launched; otherwise, false.

Gets an object that identifies the user for which the app is being installed.

An object that identifies the user for which the app is being installed.

Defines the different app install types that are returned by the InstallType property of the AppInstallItem class.

The app is being installed.

The app installation is being repaired.

The app is being updated.

Provides options you can use in several method overloads of the AppInstallManager class for searching for app updates.

Creates and initializes a new instance of the AppUpdateOptions class.

Gets or sets a value that specifies whether to allow a forced restart of the app that is being queried for updates.

True to allow a forced restart of the app; otherwise, false.

Gets or sets a value that indicates whether the updates should be automatically downloaded and installed if they are found.

True to automatically queue up, download and install app updates if any are found. False adds the updates to the install queue in a paused state.

Gets or sets the catalog ID of the app to be queried for updates.

The catalog ID of the app to be queried for updates.

Defines the automatic app update setting values that can be returned by the AutoUpdateSetting property of the AppInstallManager class.

Automatic app updates are disabled by the user.

Automatic app updates are disabled by policy.

Automatic app updates are enabled by the user.

Automatic app updates are enabled by policy.

Provides access to the result of a request to grant a free entitlement.

Indicates the result of a request to grant a free entitlement.

A GetEntitlementStatus value that indicates the result of a request to grant a free entitlement.

Defines the possible results of a request to grant a free entitlement by using the GetFreeDeviceEntitlementAsync, GetFreeUserEntitlementAsync, or GetFreeUserEntitlementForUserAsync methods.

The request was unsuccessful because of a network connection error.

The request was unsuccessful because the specified user does not have a Microsoft account that is associated with the Store on the current device.

The request was unsuccessful because of a server error.

The request succeeded.

Represents the content metadata of this activity in JSON format.

Provide the **UserActivityContentInfo** in the form of a JSON string.

The JSON content.

A **UserActivity** is created by an app during its execution to notify the system of a user work stream that can be continued on another device, or at another time on the same device. It provides information about a task the user is engaged in.

Create a UserActivity with a specified activity ID

The ID for this activity.

Gets and sets the activation Uniform Resource Identifier (URI).

The activation URI.

Gets the activity ID that was assigned to this **UserActivity** when it was created.

The activity ID.

Gets or sets the content information object for this user activity.

A content information object that implements IUserActivityContentInfo.

Gets and sets the MIME (Multipurpose Internet Mail Extensions) type of the content stored at UserActivity.ContentUri. For example, "text/plain".

The content type.

Gets and sets the content Uniform Resource Identifier (URI) of the content or document that is represented by the UserActivity.

The content URI.

Gets and sets the fallback Uniform Resource Identifier (URI) to use if there is no handler for the activation URI.

The fallback URI.

Gets and sets whether the particular activity's metadata should be uploaded to the Microsoft Cloud.

The boolean representing whether metadata should uploaded. If not set, this property defaults to True.

Gets the state (**Published** or **New**) of this **UserActivity**.

The state of this **UserActivity**.

Gets information that can be used for the details tile for this activity.

The description, icon, and so on, associated with this **UserActivity**.

Creates a UserActivitySession that this user activity will be associated with. You must call this method on the UI thread.

The created session.

Publish the UserActivity.

An asynchronous action that can be awaited.

Serializes the UserActivity into a JSON string. Among other things, the JSON string will contain the App display name, the activation URL, the content URL, content information, and visual element information such as description, background color, and so on.

The JSON text representation of the **UserActivity**.

Serializes a collection of UserActivity objects into a JSON string. Among other things, the JSON string will contain the App display name, the activation URL, the content URL, content information, and visual element information such as description, background color, and so on for each **UserActivity**.

The collection of user activities to convert to JSON. A JSON string representing the user activities.

Constructs a UserActivity from a JSON string.

The JSON string that represents the **UserActivity**. A **UserActivity** constructed from the JSON string.

Creates a collection of UserActivity objects from a JSON string.

The JSON string that represents a collection of **UserActivity** objects. A collection of **UserActivity** objects.

Provides graphical information about a user activity. Overrides information the system provides about the user activity.

Create a **UserActivityAttribution** object.

Create a **UserActivityAttribution** object with the specified icon image URI.

The Uniform Resource Identifier (URI) of the icon image to use with this **UserActivityAttribution**.

Get or set whether to allow Windows to append a query string to the image URI supplied from IconUri when retriving the image. The query string includes information that can be used to choose the ideal image based on the DPI of the display, the high contrast setting, and the user's language.

**True** to allow windows to append a query string to the image URI; **false** otherwise.

Get or set the text that describes the icon.

The alternative text string.

Get or set the Uniform Resource Identifier (URI) for the icon image.

The URI that identifies the icon image.

Creates or gets UserActivity objects created on this or another device.

Delete a specific user activity.

The identifier of the user activity to delete. An asynchronous action.

Deletes all of the user activities registered by this app.

An asynchronous action.

Disable the automatic creation of a session when a new UserActivity is created.

Provides access to the User Activities associated with the user's Managed Service Account (MSA).

A channel that can be used to create or get User Activity objects.

Gets a UserActivityChannel object that can be used to get or create UserActivity objects for the specified user in the context of the current app.

The User that you want to get or create UserActivity objects for. The UserActivityChannel object for the specified user.

Create (or get) a UserActivity with the specified id.

The identifier for the **UserActivity**. An existing **UserActivity** if the **activityId** matches; otherwise a new **UserActivity** that is given the specified id.

Get up to the specified number of the most recently engaged user activities, sorted by the time each user activity ended.

The maximum number of user activities to get. Fewer may be returned if there aren't as many user activities as requested. A list of user activities, sorted by when the activities ended.

Gets the session history for a user activity.

Identifies the user activity to get session history for. Get user activity sessions that were active between **startTime** and now. A list of user activity session objects that were active during the specified time for the specified user activity.

Get a channel, specific to a specified web account, to use to record user activity.

The web account to associate user activity with. The channel to use to record user activity. The channel will be associated with the web account.

Represents the content metadata of this activity in JSON format.

Creates a **UserActivityContentInfo** from a JSON string.

The content to store in JSON format. A **UserActivityContentInfo** that contains the JSON data.

Provides the **UserActivityContentInfo** in the form of a JSON string.

The JSON content.

Passed as an argument to the UserActivityRequestManager.UserActivityRequested event. Used to return a UserActivity to the caller.

Sets the UserActivity to return when the UserActivityRequested event is raised.

The user activity to store.

Passed to the UserActivityRequestManager.UserActivityRequested event. Allows the handler of the event to pass back a UserActivity.

Gets the UserActivityRequest associated with a call to the UserActivityRequestManager.UserActivityRequested event handler.

The **UserActivityRequest** object.

Gets a deferral object so that you can have more time to handle the UserActivityRequestManager.UserActivityRequested event.

The deferral object.

Handle external requests to create a UserActivity.

Raised when a request is made to the application to create an on-demand UserActivity object.

Gets the UserActivityRequestManager associated with the current view.

The **UserActivityRequestManager** for the current view.

Tracks a UserActivity while the user is engaged in that activity.

Gets the id of this **UserActivitySession**.

The activity ID.

Indicates that the user is no longer engaged in the activities associated with this session.

Provides the start and end time that a user was engaged in a particular activity.

Get the time when the user stopped engaging in the UserActivity associated with this **UserActivitySessionHistoryItem**.

The stop time for the **UserActivity**.

Get the time when the user started engaging in the UserActivity associated with this **UserActivitySessionHistoryItem**.

The start time for the **UserActivity**.

Gets the UserActivity associated with this **UserActivitySessionHistoryItem**.

The **UserActivity** instance associated with this **UserActivitySessionHistoryItem**.

Defines the states of a UserActivity.

The **UserActivity** has not yet been published.

The **UserActivity** has been published on this (or another) device.

Contains information, such as the description and icon, that can be shown in the details tile for a UserActivity.

Gets or sets the visual information about a user activity.

The visual information such as the URI for the icon, text used by screen readers, and so on.

Set the text which is shown in the top banner of the activity card.

The text that will appear in the top banner of the activity card.

Gets and sets the background color for the details tile for this **UserActivity**.

The color for the background.

Gets and sets the content that is used for the details tile for this **UserActivity**

The content of the tile.

Gets and sets the description text that is used for the details tile for this **UserActivity**.

The description.

Gets and sets the display text that is used for the details tile text for this **UserActivity**.

The display text.

Manages the creation and deletion of user activities.

Creates a user activity session.

Delete user activities created during a specified timeframe.

The channel that was used to create the user activities. The beginning of the time range in which to delete user activities. The end of the time range in which to delete user activities. An asynchronous action.

Represents a user data account used to access email, contacts, calendars, and so on.

This API supports the product infrastructure and is not intended to be used directly from your code.

A ContactGroup.

Gets the unique identifier for the type of the account.

The unique identifier for the type of the account such as Exchange, Google, Pop/IMAP and so on.

Gets or sets the human readable display name for the user data account.

The human readable display name for the user data account.

Gets the enterprise identity associated with the user account.

The enterprise identity associated with the user account.

Gets a list of package family names for apps that have explicit read access even if they don't have the system capability.

A list of package family names for apps that have explicit read access even if they don't have the system capability.

Gets the icon associated with the UserDataAccount.

The icon associated with the UserDataAccount.

Gets a string that uniquely identifies the UserDataAccount on the local device.

A string that uniquely identifies the UserDataAccount on the local device.

Gets a Boolean value indicating if the user account data is encrypted when the device becomes locked.

A Boolean value indicating if the user account data is encrypted when the device becomes locked.

Gets or sets a value indicating whether other apps on the device have read access to the UserDataAccount.

Value indicating whether other apps on the device have read access to the UserDataAccount.

Gets the unique identifier for the app package that created the UserDataAccount.

The unique identifier for the app package that created the UserDataAccount.

Provides a place to store data to be used by the app when interacting with a UserDataAccount provider.

Data to be used by the app when interacting with a UserDataAccount provider.

Gets or sets a user name associated with the UserDataAccount that is suitable for displaying.

A user name associated with the UserDataAccount that is suitable for displaying.

Asynchronously deletes all the contact, calendar and email data associated with the account.

An async action indicating success or failure.

Returns a collection of AppointmentCalendar instances associated with the UserDataAccount.

A collection of AppointmentCalendar instances associated with the UserDataAccount.

Returns a collection of ContactAnnotationList instances associated with the UserDataAccount.

A collection of ContactAnnotationList instances associated with the UserDataAccount.

This API supports the product infrastructure and is not intended to be used directly from your code.

A collection of ContactGroup instances.

Returns a collection of ContactList instances associated with the UserDataAccount.

A collection of ContactList instances associated with the UserDataAccount.

Returns a collection of EmailMailbox instances associated with the UserDataAccount.

A collection of EmailMailbox instances associated with the UserDataAccount.

Returns a collection of UserDataTask instances associated with the UserDataAccount.

A collection of UserDataTask instances associated with the UserDataAccount.

Asynchronously persists the UserDataAccount to the database.

Async action that indicates completion of the save operation.

This API supports the product infrastructure and is not intended to be used directly from your code.

The type of user data content.

Appointment data content.

Contact data content.

Email data content.

Provides APIs to interact with the user’s data accounts including those implemented by the operating system.

Gets the UserDataAccountManagerForUser object for the specified user.

The user account to use to get the UserDataAccountManagerForUser object. Returns the data account manager for the account specified by the *user* parameter.

Asynchronously returns the UserDataAccountStore from the system.

Specifies the access type, such as read-only for all accounts or read/write for the calling app's accounts. Returns the UserDataAccountStore.

This method shows the resolve message for an account error.

The user data account ID. An async action indicating success or failure.

This method shows the account settings.

The user data account ID. An async action indicating success or failure.

Shows the add account UI.

The type of user data content. Returns the newly added or already existing account.

Represents a user data account manager for a specific user.

Gets the User represented by this data account manager.

The User represented by this data account manager.

Retrieves a UserDataAccountStore object that enables searching or retrieving user data accounts on the device.

Specifies the type of read/write access requested. An asynchronous operation that returns a UserDataAccountStore object upon successful completion.

Specifies the rights granted to other apps for reading this UserDataAccount.

Other apps on the device can read all properties of this UserDataAccount.

Other apps on the device cannot read any properties of this UserDataAccount.

Only the operating system can read data from this UserDataAccount.

Represents a data store that contains user accounts.

Occurs when the UserDataAccountStore changes.

Asynchronously creates a user data account, specifying a displayable user name.

A string containing the user name that is suitable for display. Returns the newly created UserDataAccount.

Asynchronously creates a user data account, specifying a displayable user name and a GUID that identifies the app in the Microsoft Store.

A string containing the user name that is suitable for display. The GUID that identifies the app in the Microsoft Store. Returns the newly created UserDataAccount.

Asynchronously creates a user data account, specifying a displayable user name, a GUID that identifies the app in the Microsoft Store, and the enterprise identity associated with the user account.

A string containing the user name that is suitable for display. The GUID that identifies the app in the Microsoft Store. The enterprise identity associated with the user data account. Returns the newly created UserDataAccount.

Returns a collection of UserDataAccount objects from the store based on the UserDataAccountStoreAccessType value passed into RequestStoreAsync.

Returns the collection of user data accounts, scoped by access request.

Asynchronously gets the specified account.

The Id string identifying the account. Returns the UserDataAccount identified by the *id* parameter.

Specifies the requested access type in a call to RequestStoreAsync.

Read-only access to app user data accounts and system user data accounts.

Read/write access to the current app's user data accounts.

Provides data for the StoreChanged event.

Gets the deferral object for the StoreChanged event.

The deferral object for the StoreChanged event.

Provides access to data about an account operation.

Gets the type of account operation, such as adding an account or updating settings.

The type of account operation, such as adding an account or updating settings.

Represents data about an account for partner service.

Gets the type of this user account.

The type of this user account.

Gets the human readable display name for this user account.

The human readable display name for this user account.

Gets the priority for the service that uses this kind of user account.

The priority for the service that uses this kind of user account.

Provides the data for adding a new user account.

Gets the types of content supported by the user account, such as email, contacts, and appointments.

The types of content supported by the user account, such as email, contacts, and appointments.

Gets the type of this account operation.

The type of this account operation.

Gets a list of UserDataAccountPartnerAccountInfo objects for this operation.

A list of UserDataAccountPartnerAccountInfo objects for this operation.

Reports back to the calling app that the operation is complete.

The identifier for the user account upon which the operation completed.

Defines the type of an account operation.

An add account operation

An operation to resolve errors on an account

An account settings operation

Specifies the type of the user data account.

An Microsoft Exchange account

A POP or IMAP account

Provides the data for a "resolve errors" account operation.

Gets the type of this account operation.

The type of this account operation.

Gets the user account ID for this "resolve errors" operation.

The user account ID for this "resolve errors" operation.

Reports back to the calling app that the operation is complete.

Provides the data for an account settings operation.

Gets the type of this account operation.

The type of this account operation.

Gets the user account ID for this settings operation.

The user account ID for this settings operation.

Reports back to the calling app that the operation is complete.

Specifies the type of authentication.

Uses a base64 encoded string that contains the user name and password.

Uses OAuth for authentication.

Uses single sign on for authentication.

Represents device settings for app sync relationships.

Initializes a new instance of the DeviceAccountConfiguration class.

Gets or sets the identifier for the device account icon.

The identifier for the device account icon.

Gets or sets the name that identifies the device account.

The name that identifies the device account.

Gets or sets a Boolean value indicating if the full email message should always be downloaded as opposed to only header information.

A Boolean value indicating if the full email message should always be downloaded.

Gets or sets the identifier for the authentication certificate for this account.

The identifier for the authentication certificate for this account.

Gets or sets the DeviceAccountAuthenticationType for this account.

The DeviceAccountAuthenticationType for this account.

Gets or sets a Boolean value that indicates if the authentication certificate should be automatically selected.

A Boolean value that indicates if the authentication certificate should be automatically selected.

Gets or sets a Boolean value that indicates if the CalDav server requires an SSL connection.

A Boolean value that indicates if the CalDav server requires an SSL connection.

Gets or sets the address of the CalDav server.

The address of the CalDav server.

Gets or sets an enum value that specifies how often the account is synced.

An enum value that specifies how often the account is synced.

Gets or sets a Boolean value indicating if calendar syncing is enabled.

A Boolean value indicating if calendar syncing is enabled.

Gets or sets a Boolean value that indicates if the CardDav server requires an SSL connection.

A Boolean value that indicates if the CardDav server requires an SSL connection.

Gets or sets the address of the CardDav server.

The address of the CardDav server.

Gets or sets an enum value that specifies how often the account is synced.

An enum value that specifies how often the account is synced.

Gets or sets a Boolean value indicating if contacts syncing is enabled.

A Boolean value indicating if contacts syncing is enabled.

Gets or sets the value that identifies the device account type.

The value that identifies the device account type.

Gets a Boolean value that indicates if this device is allowed to sync with the email server.

A Boolean value that indicates if this device is allowed to sync with the email server.

Gets or sets the network domain of the device.

The network domain of the device.

Gets or sets the email address of the current user.

The email address of the current user.

Gets or sets a Boolean value indicating if email syncing is enabled.

A Boolean value indicating if email syncing is enabled.

Gets or sets the incoming email server address.

The incoming email server address.

Gets or sets the incoming mail server's encryption certificate hash.

The incoming mail server's encryption certificate hash.

Gets or sets the incoming mail server's password.

The incoming mail server's password.

Gets or sets the port number to use to connect to the incoming email server.

The port number to use to connect to the incoming email server.

Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server.

A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the incoming email server.

Gets or sets the username to use when connecting to the incoming email server.

The username to use when connecting to the incoming email server.

Gets or sets a Boolean value indicating if a client authentication certificate is required by the server.

A Boolean value indicating if a client authentication certificate is required by the server.

Gets or sets a Boolean value that indicates if the device account is managed outside the organization.

A Boolean value that indicates if the device account is managed outside the organization.

Gets or sets a Boolean value indicating if authentication is enabled for the outgoing mail server.

A Boolean value indicating if authentication is enabled for the outgoing mail server.

Gets or sets a Boolean value indicating if authentication is required by the outgoing mail server.

A Boolean value indicating if authentication is required by the outgoing mail server.

Gets or sets a Boolean value indicating if single sign on (SSO) authentication is supported by the server.

A Boolean value indicating if single sign on (SSO) authentication is supported by the server.

Gets a Boolean value that indicates if the sync schedule is managed by the system as opposed to the app.

A Boolean value that indicates if the sync schedule is managed by the system as opposed to the app.

Gets or sets an enum value that indicates how many days of email to keep on the client.

An enum value that indicates how many days of email to keep on the client.

Gets or sets the OAuth refresh token used to create a new access token.

The OAuth refresh token used to create a new access token.

Gets or sets the outgoing email server address.

The outgoing email server address.

Gets or sets the outgoing mail server's encryption certificate hash.

The outgoing mail server's encryption certificate hash.

Gets or sets the outgoing mail server's password.

The outgoing mail server's password.

Gets or sets the port number to use to connect to the outgoing email server.

The port number to use to connect to the outgoing email server.

Gets or sets a Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server.

A Boolean value indicating if Secure Sockets Layer (SSL) should be used when connecting to the outgoing email server.

Gets or sets the username to use when connecting to the outgoing email server.

The username to use when connecting to the outgoing email server.

Gets or sets a value indicating the type of the server.

Enum value indicating the type of the server.

Gets or sets the single sign on account ID.

The single sign on account ID.

Gets or sets an enum value that specifies how often the account is synced.

An enum value that specifies how often the account is synced.

Gets or sets a Boolean value indicating if the incoming server's certificate hash has been confirmed.

A Boolean value indicating if the incoming server's certificate hash has been confirmed.

Gets or sets a Boolean value that indicates if the account has been modified by the user.

A Boolean value that indicates if the account has been modified by the user.

Gets or sets a Boolean value indicating if the outgoing server's certificate hash has been confirmed.

A Boolean value indicating if the outgoing server's certificate hash has been confirmed.

Specifies the type of icon to use for the device account.

Uses the Exchange icon.

Uses a generic account icon.

Uses the Microsoft account icon.

Uses the Outlook icon.

Specifies how many days of email to keep on the client.

Keep all the email.

Keep email from the last 14 days.

Keep email from the last day.

Keep email from the last 30 days.

Keep email from the last 3 days.

Keep email from the last 7 days.

Keep email from the last 90 days.

Defines the server types for syncing.

Exchange server

IMAP server

POP server

Specifies how often the account is synced.

The account is synced as items arrive at the server (push model).

The account is synced once daily.

The account is synced every 15 minutes.

The account is synced every 2 hours.

The account is synced every 30 minutes.

The account is synced every 60 minutes.

The account is synced manually.

Provides the ability to display the system UI for managing sync relationships.

Asynchronously displays the system UI to manage the sync relationships for the specified accounts.

The list of accounts to manage in the system UI. Returns an updated list of accounts.

Asynchronously creates a device account using the specified DeviceAccountConfiguration.

The configuration to use when creating the account. Returns a string with the newly created device account ID.

Asynchronously deletes the specified device account.

The ID of the device account to delete. Returns an async action indicating that the operation has completed.

Asynchronously gets the DeviceAccountConfiguration for the specified device account.

The ID for the device account. Reutrns the DeviceAccountConfiguration for the device account specified by the *accountId* parameter.

Asynchronously, and temporarily, replaces the default local account by using the specified account.

The user ID of the account used to temporarily replace the default local account. Returns an async action indicating that the operation has completed.

Represents a task.

Initializes a new instance of the UserDataTask class.

Gets or sets the completion date and time of the task.

The completion date and time of the task.

Gets or sets a string value. The string contains extended details that describe the task. Details is of type String and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string.

The extended details that describe the task.

Gets or sets the type of task details, plain text or HTML.

The type of task details.

Gets or sets the due date of the task.

the due date of the task.

Gets the unique identifier of the task.

The unique identifier of the task.

Gets the kind of task (For example: Recurring etc.).

The kind of task (For example: Recurring etc.).

Gets the unique identifier for the task list associated with the task.

The unique identifier for the task list associated with the task.

Gets or sets the priority of the task.

The priority of the task.

Gets or sets an object that represents when and how often a task occurs.

An object that represents when and how often a task occurs

Gets or sets an object that represents how many times and at what interval the task is generated.

An object that represents how many times and at what interval the task is generated.

Gets or sets a time span value. The value declares the amount of time to subtract from the DueDate, and that time used as the issue time for a reminder for a task. A **null** value indicates that the task won't issue a reminder. Reminder is of type IReference(TimeSpan).

A time span value, or **null** to issue no reminder.

Gets or sets an ID that can be used by a service provider to access the UserDataTask in their remote system.

An ID that can be used by a service provider to access the UserDataTask in their remote system.

Gets or sets a UserDataTaskSensitivity -typed value that indicates the sensitivity of the task.

A UserDataTaskSensitivity -typed value that indicates the sensitivity of the task.

Gets or sets the starting date and time for the task.

The date and time to use as the starting time for the task.

Gets or sets a string that communicates the subject of the task. Subject is of type String and a maximum of 255 characters in length.

The subject of the task.

Represents a group of UserDataTask objects.

Gets the list of UserDataTask objects returned by a search operation.

The list of tasks returned by a search operation.

Specifies the days of the week on which an task occurs.

The task occurs on Friday.

The task occurs on Monday.

The task doesn't occur on any days of the week.

The task occurs on Saturday.

The task occurs on Sunday.

The task occurs on Thursday.

The task occurs on Tuesday.

The task occurs on Wednesday.

Defines the type of content in task details.

Content is in HTML markup.

Content is in plain text.

Defines the type of task.

A task that reoccurs at specific date and at some regular interval.

A task that reoccurs at some regular interval.

A task with no special conditions that cause it to reoccur.

Represents a list of UserDataTask objects.

Gets or sets the name of the UserDataTaskList, suitable for display in the user interface.

The name of the UserDataTaskList, suitable for display in the user interface.

Gets the locally unique identifier for this UserDataTaskList.

The locally unique identifier for this UserDataTaskList.

Gets an object that provides operations that an app can perform on a task list that it has not created.

An object that provides operations that an app can perform on a task list that it has not created.

Gets or sets a value indicating the read access level to this UserDataTaskList for other apps on the system.

A value indicating the read access level to this UserDataTaskList for other apps on the system.

Gets or sets a value indicating the write access level to this UserDataTaskList for other apps on the system.

A value indicating the write access level to this UserDataTaskList for other apps on the system.

Gets the name of the source of the UserDataTaskList, suitable for display in the user interface.

The name of the source of the UserDataTaskList, suitable for display in the user interface.

Gets the UserDataTaskListSyncManager used to communicate with the server.

The UserDataTaskListSyncManager used to communicate with the server.

Gets a string that represents the ID of the user data account for this UserDataTaskList.

A string that represents the ID of the user data account for this UserDataTaskList.

Asynchronously deletes this UserDataTaskList, including all UserDataTask objects in the UserDataTaskStore.

An async action indicating that the method is complete.

Asynchronously deletes and individual UserDataTask from this UserDataTaskList and the UserDataTaskStore.

The UserDataTask to delete. An async action indicating that the method is complete.

Asynchronously retrieves the specified UserDataTask object from the UserDataTaskList.

The string that identifies the UserDataTask to return. The UserDataTask identified by the *UserDataTask* parameter.

Gets a UserDataTaskReader object associated with this UserDataTaskList.

A UserDataTaskReader object associated with this UserDataTaskList.

Gets a UserDataTaskReader object associated with this UserDataTaskList by using the specified UserDataTaskQueryOptions.

The UserDataTaskQueryOptions to use when creating the UserDataTaskReader. A UserDataTaskReader object associated with this UserDataTaskList.

Adds a SyncManager to the UserDataTaskList.

An asynchronous registration operation that you can await.

Asynchronously saves this UserDataTaskList.

An async action indicating that the method has completed.

Asynchronously saves the specified UserDataTask to the UserDataTaskStore.

The task to save.

Provides operations that an app can perform on a task list that it has not created.

Asynchronously attempts to mark a task as completed.

The ID of the task to mark as completed. The ID of the task marked as completed.

Asynchronously attempts to create or update a task.

The task to create or update. A Boolean value indicating if the operation was successful.

Asynchronously attempts to delete a task.

The ID of the task to delete. A Boolean value indicating if the operation was successful.

Asynchronously attempts to skip the current instance of a reoccurring task and move to the next instance.

The ID of the reoccurring task. A Boolean value indicating if the operation was successful.

Specifies the level of task read access granted to other apps.

Other apps have read access to system and app tasks.

Other apps cannot access any tasks.

Other apps can only read system tasks.

Specifies the level of task write access granted to other apps.

Other apps can only write tasks for this app.

No write access is granted.

Provides functionality for syncing task information with the server.

Gets or sets the last time a sync was attempted with the server.

The last time a sync was attempted with the server.

Gets or sets the last time the UserDataTaskList was successfully synced with the server.

The last time the **UserDataTaskList** was successfully synced with the server.

Gets or sets the UserDataTaskListSyncStatus.

The UserDataTaskListSyncStatus.

Occurs when the sync status with the server has changed.

Asynchronously attempts to sync with the tasks server.

A Boolean value indicating if the sync was successful.

Defines the UserDataTaskList sync status.

There was an authentication error.

Idle.

There was a policy error.

Currently syncing.

An unknown error occurred.

The task list is up-to-date.

Represents a service that source apps can call to access task data.

Gets the user associated with this UserDataTaskManager.

The user associated with this UserDataTaskManager.

Gets the default UserTaskManager object.

Gets the default UserTaskManager object.

Gets the UserTaskManager object for the specified user.

The user account to use to get the UserTaskManager object. The UserTaskManager object for the specified user.

Retrieves a UserDataTaskStore object that enables searching or retrieving contacts on the device.

Specifies the type of read/write access requested. An asynchronous operation that returns a UserDataTaskStore object on successful completion.

Specifies the priority of the task.

The task is a high priority.

The task is a low priority.

The task has the normal priority.

Defines the type of task query.

The query is for all tasks.

The query is for tasks that are marked as completed.

The query is for tasks that are not marked as completed.

Represents the options selected for task query.

Instantiates a new instance of the UserDataTaskQueryOptions class.

Gets or sets the kind of tasks for which to query.

The kind of emails for which to query.

Gets or sets a Boolean value indicating whether the query results should be sorted.

A Boolean value indicating whether the query results should be sorted.

The property by which to sort. Currently limited to due date.

Sort by due date.

Used to read UserDataTask objects in batches from the UserDataTaskStore which may be local or remotely located.

Asynchronously reads a batch of UserDataTask objects from the UserDataTaskStore.

The batch of tasks read from the UserDataTaskStore.

Represents when and how often a task occurs.

Initializes a new instance of the UserDataTaskRecurrenceProperties class.

Gets or sets the day on which a task occurs. Day is of type UInt32, has a default value of 1, and can be a value from 1 to 31.

The day on which an appointment occurs.

Gets or sets a combination of UserDataTaskDaysOfWeek -typed values for all the days of the week on which a task occurs.

A combination of UserDataTaskDaysOfWeek -typed values that are combined by using a bitwise OR operation. The resulting value specifies all the days of the week on which a task occurs.

Gets or sets the interval between occurrences of a task. Interval is of type UInt32 and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on.

The interval on which a task occurs.

Gets or sets the month on which a task occurs. Month is of type UInt32, has a default value of 1, and can be a value from 1 to 12.

The month on which a task occurs.

Gets or sets the number of times a task recurs. Occurrences is of type IReference(UInt32) and is **NULL** by default. Occurrences is mutually exclusive with Until.

The number of times a task recurs.

Gets or sets a UserDataTaskRecurrenceUnit -typed value that indicates the frequency for which the task occurs.

A UserDataTaskRecurrenceUnit -typed value that indicates the frequency for which the task occurs.

Gets or sets the date and time until which a task is valid. Until is of type IReference(DateTime) and is **NULL** by default. Until is mutually exclusive with Occurrences.

The date and time until which a task is valid.

Gets or sets a UserDataTaskWeekOfMonth -typed value that indicates the week of the month for which the task occurs. The first week is the default.

Specifies the frequency for which a task occurs.

Task occurs daily.

Task occurs monthly.

Task occurs monthly on a particular day of the month.

Task occurs weekly.

Task occurs yearly.

Task occurs yearly on a particular day of the year.

Represents how often a task occurs.

Initializes a new instance of the UserDataTaskRegenerationProperties class.

Gets or sets the interval between occurrences of a task. Interval is of type UInt32 and has a default value of 1. For daily, the interval is the number of days in between, for weekly, the number of weeks, and so on.

The interval on which a task occurs.

Gets or sets the number of times a task recurs. Occurrences is of type IReference(UInt32) and is **NULL** by default. Occurrences is mutually exclusive with Until.

The number of times a task recurs.

Gets or sets a UserDataTaskRecurrenceUnit -typed value that indicates the frequency for which the task occurs.

A UserDataTaskRecurrenceUnit -typed value that indicates the frequency for which the task occurs.

Gets or sets the date and time until which a task is valid. Until is of type IReference(DateTime) and is **NULL** by default. Until is mutually exclusive with Occurrences.

The date and time until which a task is valid.

Specifies the frequency for which a task occurs.

Task occurs daily.

Task occurs monthly.

Task occurs weekly.

Task occurs yearly.

Specifies the sensitivity of a task.

The task is private and can't be viewed publicly.

The task is publicly available to view.

Represents a database that contains tasks.

Asynchronously creates a UserDataTaskList with the specified name.

A name for the new UserDataTaskList. The newly created UserDataTaskList.

Asynchronously creates a UserDataTaskList with the specified name.

A name for the new UserDataTaskList. The ID for the UserDataAccount to use when creating the UserDataTaskList.

Asynchronously returns the list of UserDataTaskList objects.

The list of UserDataTaskList objects.

Asynchronously gets the UserDataTaskList with the specified ID.

The ID of the UserDataTaskList to retrieve. The UserDataTaskList with the specified ID or null if the list is not found.

Defines the type of access the app has to the UserDataTaskStore.

Read and write access limited to operations available in the UserDataTaskListLimitedWriteOperations class.

Read and write tasks that belong to the app only.

Specifies the week of the month for which the task occurs.

The task occurs on the first week of the month.

The task occurs on the fourth week of the month.

The appointment occurs on the last week of the month.

The task occurs on the second week of the month.

The task occurs on the third week of the month.

Represents a connection to a data provider client.

Raised when the client app attempts to mark a task as completed.

Raised when the client app attempts to create or update a task.

Raised when the client app attempts to delete a task.

Raised when the client app attempts to skip the current instance of a reoccurring task and move to the next instance.

Raised when the client app attempts to sync all calendar appointments with the server.

Call this method to indicate that all event handlers have been set and the data provider is ready to start handling requests.

Represents trigger information about the background task in which data will be transferred between the app and its caller.

Gets the data connection over which task data can be transferred.

Gets the data connection over which task data can be transferred.

Details of a request to mark at task as completed.

Gets the task ID of the task to be marked as completed.

The task ID of the task to be marked as completed.

Gets the ID of the task list that contains the task that is to be marked as completed.

The task list that contains the task that is to be marked as completed.

Informs the client app that the request was processed successfully.

The ID of the task that was processed. An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to mark a task as completed.

Gets the UserDataTaskListCompleteTaskRequest object associated with this request.

A UserDataTaskListCompleteTaskRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to create or update a task.

Gets the UserDataTask of the task to be created or updated.

The UserDataTask of the task to be created or updated.

Gets the ID of the task list that contains the task that is to created or updated.

The ID of the task list that contains the task that is to created or updated.

Informs the client app that the request was processed successfully.

The UserDataTask of the task that was created or updated. An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to create or update.

Gets the UserDataTaskListCreateOrUpdateTaskRequest object associated with this request.

A UserDataTaskListCreateOrUpdateTaskRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to delete a task.

Gets the task ID of the task to be deleted.

The task ID of the task to be deleted.

Gets the ID of the task list that contains the task that is to be deleted.

The task list that contains the task that is to be deleted.

Informs the client app that the request was processed successfully.

An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to delete a task.

Gets the UserDataTaskListDeleteTaskRequest object associated with this request.

A UserDataTaskListDeleteTaskRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request to skip the current instance of a reoccurring task and move to the next instance.

Gets the task ID of the task to be skipped.

The task ID of the task to be skipped.

Gets the ID of the task list that contains the task to be skipped.

The ID of the task list that contains the task to be skipped.

Informs the client app that the request was processed successfully.

An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Encapsulates information about a request to skip a task.

Gets the UserDataTaskListSkipOccurrenceRequest object associated with this request.

A UserDataTaskListSkipOccurrenceRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

Details of a request from a client to sync a task list.

Gets the ID of the task list to be synced.

The ID of the task list to be synced.

Informs the client app that the request was processed successfully.

An asynchronous sync operation.

Informs the client that the request was not processed successfully.

An asynchronous sync operation.

Encapsulates information about a request to sync a task list.

Gets the UserDataTaskListSyncManagerSyncRequest object associated with this request.

A UserDataTaskListSyncManagerSyncRequest object describing the request.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing this request.

The command given to **Cortana**, using either speech or text, and routed to a background app.

Gets the value of the **Name** attribute for the **Command** element declared in the Voice Command Definition (VCD) file.

The command name.

Gets a dictionary containing the semantic properties of the recognized phrase in the voice command.

The semantic properties recognized in the voice command.

Gets the SpeechRecognitionResult object representing the results returned by the voice command.

The result of a speech recognition session.

Contains event data for the VoiceCommandCompleted event.

The reason the voice command completed.

The reason the voice command completed.

Specifies the possible reasons the voice command completed.

The background app service requested that the app launch in the foreground with a call to RequestAppLaunchAsync.

The user cancelled the interaction with **Cortana**.

Communication with **Cortana** failed.

The background app service completed the interaction by calling ReportSuccessAsync or ReportFailureAsync.

The background app service exited because not enough resources were available.

The background app service took too long to provide a response to **Cortana**.

Unknown error.

The response to the question specified by the background app and shown on the **Cortana** confirmation screen. This screen is displayed when the background app service calls RequestConfirmationAsync.

Gets the response to the question specified by the background app and shown on the **Cortana** confirmation screen.

**true** when the user responds with "Yes", **false** when the user responds with "No".

An asset, containing image, text, and link data, provided by the background app service for display on the **Cortana** canvas.

Creates an instance of the VoiceCommandContentTile class.

Gets or sets supplementary information the background app service can associate with the content tile. This information is not used by **Cortana**.

Supplementary information associated with the content tile.

Gets or sets a string as a launch parameter that can be associated with the response by the background app service.

The key/value pair.

Gets or sets the layout template used for the content tiles on the **Cortana** canvas.

The content tile template.

Gets or sets the image used on the content tile.

The image associated with the content tile.

Gets or sets the first line of text used on the content tile.

The first line of text associated with the content tile.

Gets or sets the second line of text used on the content tile.

The second line of text associated with the content tile.

Gets or sets the third line of text used on the content tile.

The third line of text associated with the content tile.

Gets or sets the title used on the content tile.

The title associated with the content tile.

The layout template used for content tiles on the **Cortana** canvas.

Only item title.<img src="./windows.applicationmodel.voicecommands/images/VoiceCommandContentTileType_TitleOnly_small.png" alt="TitleOnly" />

Item title with wide image.

Item title, up to two lines of text, and wide image. <img src="./windows.applicationmodel.voicecommands/images/VoiceCommandContentTileType_TitleWith280x140IconAndText_small.png" alt="TitleWith280x140IconAndText" />

Item title with small, square image.

Item title, up to three lines of text, and small square image. <img src="./windows.applicationmodel.voicecommands/images/VoiceCommandContentTileType_TitleWith68x68IconAndText_small.png" alt="TitleWith68x68IconAndText" />

Item title with tall image.

Item title, up to three lines of text, and tall image. <img src="./windows.applicationmodel.voicecommands/images/VoiceCommandContentTileType_TitleWith68x92IconAndText_small.png" alt="TitleWith68x92IconAndText" />

Item title with up to three lines of text. <img src="./windows.applicationmodel.voicecommands/images/VoiceCommandContentTileType_TitleWithText_small.png" alt="TitleWithText" />

Enables operations on a specific installed command set.

Gets the language (xml:lang ) value of the `CommandSet` element in the Voice Command Definition (VCD) file.

The language (`xml:lang`) of the command set.

Gets the `Name` attribute value of the `CommandSet` element in the Voice Command Definition (VCD) file.

The Name attribute value of the `CommandSet` element.

Populates a `PhraseList` element with an array of `Item` elements.

The string that corresponds to the label attribute of the `PhraseList` element. A string array of values that will be added to the `PhraseList` element as `Item` elements. A string array of values that will be added to the PhraseList element as Item elements.

A static class that enables registering and using command sets from a Voice Command Data (VCD) file.

A dictionary that contains all installed command sets that have a Name attribute set in the Voice Command Definition (VCD) file.

The dictionary of installed command sets that have a Name attribute set in the Voice Command Definition (VCD) file.

Installs the CommandSet elements in a Voice Command Definition (VCD) file.

An object representing a Voice Command Definition (VCD) file. An asynchronous handler called when the operation is complete.

The result obtained from the disambiguation screen displayed on the **Cortana** canvas.

The item selected from the list of items displayed on the **Cortana** disambiguation screen.

An asset, containing image and text data, provided by the background app service for display on the **Cortana** canvas.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas.

Gets or sets a string as a launch parameter that can be associated with the response by the background app service.

The string used as a launch parameter.

Gets the maximum number of content tiles the background app service can display on the **Cortana** canvas.

The maximum number of content tiles.

The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas.

The message that is spoken or shown by **Cortana**.

The secondary message (for disambiguation and confirmation screens only) that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood.

The message that is spoken or shown by **Cortana**.

The collection of assets, containing image and text data, provided by the background app service for display on the **Cortana** canvas.

The collection of assets.

Creates a VoiceCommandResponse object used in calls to ReportProgressAsync, ReportSuccessAsync or ReportFailureAsync.

The message that is spoken by **Cortana** and shown on the **Cortana** canvas. The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas.

Creates a VoiceCommandResponse object used in calls to ReportProgressAsync, ReportSuccessAsync or ReportFailureAsync.

The message that is spoken by **Cortana** and shown on the **Cortana** canvas. The collection of VoiceCommandContentTile objects, containing image and text data, shown as result cards on the **Cortana** canvas. The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas.

Creates a VoiceCommandResponse object used in calls to RequestConfirmationAsync or RequestDisambiguationAsync.

The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas.

Creates a VoiceCommandResponse object used in calls to RequestConfirmationAsync or RequestDisambiguationAsync.

The initial message that is spoken by **Cortana** and shown on the **Cortana** canvas. The secondary message that is spoken by **Cortana** and shown on the **Cortana** canvas, if a response was not understood. The collection of assets, containing image and text data, shown on the **Cortana** canvas. The response from the background app service for progress, completion, confirmation, or disambiguation screens displayed on the **Cortana** canvas.

The background app service connection to **Cortana**.

Gets the locale for the voice command.

The locale for the voice command.

Event raised when the voice command is completed and the background app service is about to be terminated.

Retrieves a VoiceCommandServiceConnection object from the AppServiceTriggerDetails that contains info associated with the background task for the app service.

Contains info associated with the background task for the app service. The background app service connection to **Cortana**.

Retrieves the voice command that the user submitted to **Cortana** by voice or text.

The VoiceCommand.

Sends a response to **Cortana** indicating the voice command has failed.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. An asynchronous handler called when the operation is complete.

Sends a response to **Cortana** indicating voice command is being processed.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. An asynchronous handler called when the operation is complete.

Sends a response to **Cortana** indicating the voice command has succeeded.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. An asynchronous handler called when the operation is complete.

Sends a response to **Cortana** indicating the command should be handled by the app in the foreground.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. An asynchronous handler called when the operation is complete.

Sends a response to **Cortana** indicating the voice command requires confirmation.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. The VoiceCommandConfirmationResult object with the user's response.

Sends a response to **Cortana** indicating the voice command returned more than one result and requires the user to select one.

The response from a background app service for progress, confirmation, disambiguation, completion, or failure screens displayed on the **Cortana** canvas. The VoiceCommandDisambiguationResult object with the user's response.

The message that is spoken by **Cortana** and shown on the **Cortana** canvas.

Creates an instance of the VoiceCommandUserMessage class.

Gets or sets the message that is shown on the **Cortana** canvas.

+ An informative statement on progress, completion, and error screens (see ReportProgressAsync, ReportSuccessAsync, ReportFailureAsync ).

The message that is spoken by **Cortana**.

+ An informative statement on progress, completion, and error screens (see ReportProgressAsync, ReportSuccessAsync, ReportFailureAsync ).

Represents a bar code assigned to a wallet item.

Initializes a new instance of the WalletBarcode class.

The symbology type for this barcode. Use one of the supported symbologies, such as **Upca**. Don't set to **Invalid** or **Custom**. The message (Value ) that the barcode represents.

Initializes a new instance of the WalletBarcode class.

A stream representing the bar code image.

Gets the symbology used by the bar code.

The bar code's symbology.

Gets a string representation of the barcode (its message).

The string representation of the barcode, which is the data message that the barcode represents.

Creates and returns a bitmap image stream for the barcode (or returns the custom image used during instantiation).

An asynchronous operation. If you use Asynchronous programming, the result type on successful completion is an IRandomAccessStreamReference instance. This can be assigned as the source for an image (with some additional code).

Represents the barcode symbology types that are supported for a WalletItem.

Uses the **Aztec** barcode symbology.

Uses the **Code 128** barcode symbology.

Uses the **Code 39** barcode symbology.

Uses a custom bar code symbology.

Uses the **EAN-13** barcode symbology.

Uses the **EAN-8** barcode symbology.

Invalid barcode type.

Uses the **ITF** barcode symbology.

Uses the **PDF417** barcode symbology.

Uses the **QR Code** barcode symbology.

Uses the **UPC-A** barcode symbology.

Uses the **UPC-E** barcode symbology.

Describes the position in the detail view of a wallet item that a WalletItemCustomProperty record should be displayed at.

If the value of the property at this position contains a URL (**http:// or https://**), the data is displayed as a button that can navigate to that URL.

The first footer slot in UI.

The second footer slot in UI.

The third footer slot in UI.

The fourth footer slot in UI.

The first header slot in UI.

The second header slot in UI.

This property is hidden from the detail view of the wallet item, but will be displayed on the back-of-card view of the item.

The first content slot in UI.

The second content slot in UI.

The first content slot in UI under Header2.

The second content slot in UI under Header2.

The third content slot in UI under Header2.

The fourth content slot in UI under Header2.

The fifth content slot in UI under Header2.

Represents an item (data) that is stored in the wallet.

Initializes a new instance of the WalletItem class.

The type of wallet item. The display name of the item.

Gets or sets the barcode that's representative of the wallet item.

The barcode of the item.

Gets or sets the background image of the body of the wallet item (uses a stream).

The background image of the body of the wallet item. This is a stream that contains the bitmap image.

Gets or sets the body color of the wallet item.

The body color of the item.

Gets or sets the body font color of the wallet item.

The body font color of the item.

Gets or sets a string that appears next to the app name in **About** info.

A string that appears next to the app name in the **About** info associated with a wallet item.

Gets or sets the name or title to be displayed to the user.

The display name of the wallet item.

Gets the collection of WalletItemCustomProperty objects associated with the wallet item.

The collection of WalletItemCustomProperty objects associated with the wallet item.

Gets or sets the expiration date of the wallet item.

The expiration date of the item. Can be **null** (the default).

Gets or sets the header background image of the wallet item.

The header background image of the item.

Gets or sets the header color of the wallet item.

The header color of the item.

Gets or sets the header font color of the wallet item.

The header font color of the item.

Gets the unique identifier of the wallet item.

The unique identifier of the wallet item. This usually isn't displayed in UI. This might be the same value as was used for the Value of the Barcode, but that's up to the implementation (yours or the wallet item provider).

Gets or sets whether this item is acknowledged by the app.

**false** if the item is new to the app (the default); Otherwise, **true**.

Gets or sets whether to launch your app when the user taps on the DisplayMessage.

**true** if your app should launch when the users taps on the display message; Otherwise, **false**;

Gets or sets whether your app should be launched when the user taps "see more transaction history".

**true** if your app should be launched when the user taps on "see more transaction history", Otherwise, **false**.

Gets or sets the issuer name of the wallet item.

The issuer name of the wallet item.

Gets the type of the wallet item.

The type of the item, as a value of the enumeration.

Gets or sets the date and time the data for this item was last updated.

The date and time the data for this item was last updated. Can be **null** (the default).

Gets or sets the medium (159 x 159) logo image of the wallet item.

The medium logo of the item, represented as a stream.

Gets or sets the large (336 x 336) logo image of the wallet item.

The large logo of the item, represented as a stream.

Gets or sets the small (99 x 99) logo image of the wallet item.

The small logo image of the item, represented as a stream.

Gets or sets the logo image of the wallet item. Use this property for a logo that doesn't have a specified size.

The logo image of the wallet item, represented as a stream.

Gets or sets the logo text of the wallet item.

The logo text of the item.

Gets or sets the promotional image of the wallet item.

The promotional image of the wallet item that will be displayed on back of the card, as a stream.

Gets or sets the date on which the item is valid.

The date on which the item is valid. Can be **null** (the default).

Gets or sets the description of the relevant date of the wallet item.

The description of the relevant date of the wallet item.

Gets a collection of all relevant locations for the wallet item.

A collection of all relevant locations for the wallet item

Gets the transaction history collection of the wallet item.

The transaction history collection of the item. This is a keyed map of WalletTransaction items.

Gets the collection of WalletVerb objects associated with the wallet item.

The collection of WalletVerb objects associated with the wallet item.

Defines a custom property on a wallet item. Apps can show data in the details view or back of card view of the item.

Initializes a new instance of the WalletItemCustomProperty class.

The custom property label. Sets the initial Name value. The value of the property. Sets the initial Value value.

Gets or sets whether this WalletItemCustomProperty is entity-extracted and actionable upon display.

**true** if the WalletItemCustomProperty is entity-extracted and actionable upon display; Otherwise, **false**.

Gets or sets the optional position of this property when shown in the wallet item's detail view.

The optional position of this property when shown in the wallet item's detail view, as a value of the enumeration. The default is **Hidden**.

Gets or sets the custom property label.

The custom property label.

Gets or sets the optional position of this property when shown in the summary view for a wallet item.

The optional position of this property when shown in the summary view for a wallet item, as a value of the enumeration. The default is **Hidden**.

Gets or sets the custom property value.

The custom property value.

Represents the kinds (classifications) of wallet items supported.

A boarding pass.

A deal.

A general item.

The item is invalid.

A membership card.

A payment instrument.

A ticket.

Defines a set of asynchronous actions and operations that manage the wallet items in the wallet database. These can be used to read the existing items, or to add and remove items.

Adds a new wallet item to the wallet.

The identifier of the wallet item. This value must be unique. This sets the initial WalletItem.Id value (the identifier is for the WalletItemStore store, and isn't part of the initialization of a WalletItem object. The wallet item to add to the wallet. An asynchronous action. If you use Asynchronous programming, the return type is **void**.

Clears all app-owned wallet items from the wallet data store.

An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Removes a specific wallet item with the given ID from the wallet data store.

The ID of the wallet item to remove from the data store. An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Returns the collection of all wallet items owned by this app.

An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use Asynchronous programming, the result type is a read-only list/vector of WalletItem items. (You can use APIs of IVectorView<WalletItem> for C++ or JavaScript, APIs of IReadOnlyList<WalletItem> for .NET.)

Returns the collection of wallet items of the given type that are owned by this app.

The type of wallet item to retrieve. An asynchronous operation that, on successful completion, returns the collection of wallet items of the specified type that are accessible by this app. If you use Asynchronous programming, the result type is a read-only list/vector of WalletItem items. (You can use APIs of IVectorView<WalletItem> for C++ or JavaScript, APIs of IReadOnlyList<WalletItem> for .NET.)

Gets an individual wallet item with the given ID from the wallet database. The item requested must be owned by this app.

The ID of the wallet item. An asynchronous operation that, on successful completion, returns the wallet item with the specified ID that is owned by this app. If you use Asynchronous programming, the result type is a single WalletItem. If an item with the specified ID cannot be found for this app in the current WalletItemStore or if the item isn't owned by this app, the result is **null**.

Imports data from a ".mswallet" XML file into the wallet store.".mswallet" is an XML serialization format for wallet item info. For a guide to the ".mswallet" format (and a link to schema in XSD), see [Quickstart: Creating and distributing .mswallet files](https://docs.microsoft.com/previous-versions/windows/apps/dn631256(v=win.10)).

The ".mswallet" file to import. An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use Asynchronous programming, the result type on successful completion is a single WalletItem.

Displays the Wallet UI.

An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Displays the item with the given ID in the Wallet UI.

The ID of the item to display. An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Updates a wallet item in the shared store, based on the changed values in the WalletItem object provided.

The updated data for the wallet item. An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Provides a static method to get an instance of the default wallet store for this app.

Requests an instance of the default wallet store for the app.

An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use Asynchronous programming, the result type is a single WalletItemStore object.

Represents relevant location data for a wallet item. A WalletRelevantLocation object represents the individual items for the WalletItem.RelevantLocations property.

Initializes a new instance of the WalletRelevantLocation class.

Gets or sets the message associated with a relevant location.

The message associated with a relevant location.

Gets or sets the basic geographic position information of the location.

The basic geographic position of the location. BasicGeoposition is a structure, so use field syntax to set the **Latitude** and **Longitude** data.

Describes the position in the summary view of a wallet item that a WalletItemCustomProperty should be displayed.

The first summary line.

The second summary line.

The item is hidden in the summary view.

Represents a single wallet transaction in the transaction history.

Initializes a new instance of the WalletTransaction class.

Gets or sets the summary description (suitable for user UI) of the transaction.

The transaction description.

Gets or sets the transaction amount.

The transaction amount.

Gets or sets a description (suitable for user UI) of the transaction location.

The text description of the transaction location.

Gets or sets whether to display the time of the transaction.

**true** if the time of the transaction should be displayed; otherwise, **false**.

Gets or sets whether to launch your app when the user taps "see more transaction history".

**true** if your app should be launched when the user taps "see more transaction history"; otherwise, **false**.

Gets or sets the date and time of the transaction.

The date and time of the transaction. Can be **null** (the default), but for this particular property it's uncommon for the value to remain **null** when you're viewing an existing transaction.

Represents a wallet verb, which is potentially used for app activation. This is a string suitable for UI that is descriptive of the action.

Initializes a new instance of the WalletVerb class.

The name of the custom verb. Sets the value of the Name property.

Gets or sets the custom verb name.

The name of the custom verb.

Defines values used by the GetAppStatusForItem method indicating if an app is installed for the specified WalletItem.

The app for the wallet item is installed on this device.

An app exists for the wallet item, but it is not installed on the device.

There is no app associated with the wallet item.

Defines a set of asynchronous actions and operations that manage the wallet items in the system wallet database. These can be used to read the existing items, or to add and remove items.

Occurs when items in the WalletItemSystemStore have changed.

Asynchronously removes a specific wallet item with the given ID from the wallet system data store.

The ID of the wallet item to remove from the system data store. An asynchronous action. If you use Asynchronous programming, the result type is **void**.

Gets a WalletItemAppAssociation value indicating if an app is installed for the specified WalletItem.

The item for which to retrieve the status. The WalletItemAppAssociation value indicating if an app is installed for the specified WalletItem specified by the *item* parameter.

Returns the collection of all system wallet items owned by this app.

An asynchronous operation that, on successful completion, returns the collection of wallet items accessible by this app. If you use Asynchronous programming, the result type is a read-only list/vector of WalletItem items. (You can use APIs of IVectorView<WalletItem> for C++ or JavaScript, APIs of IReadOnlyList<WalletItem> for .NET.)

Imports data from a ".mswallet" XML file into the system wallet store.

The ".mswallet" file to import. An asynchronous operation that, on successful completion, returns the wallet item that was imported into the wallet. If you use Asynchronous programming, the result type on successful completion is a single WalletItem.

Launches the app that is associated with the given wallet item.

The wallet item to launch an app for. An async action indicating that the operation has completed.

Provides a static method to get an instance of the system wallet store for this app.

Requests an instance of the system wallet store for the app.

An asynchronous operation that, on successful completion, returns an instance of the default wallet store. If you use Asynchronous programming, the result type is a single WalletItemSystemStore object.

Provides utility methods for use with HTML-formatted data.

Converts HTML-formatted data to a string that contains the text content extracted from the HTML.

A String containing HTML-formatted data. A String of text content.

Encapsulates a JSON value.

Gets the type of the encapsulated JSON value. Possible types are defined by JsonValueType.

The JSON value type.

Returns a pointer to the array if the ValueType of the encapsulated value is **Array**. If it is not, an exception is thrown.

A pointer to the encapsulated array.

Returns the Boolean if the ValueType of the encapsulated value is Boolean. If it is not, an exception is thrown.

The encapsulated value.

Returns the number (a Double ) if the ValueType of the encapsulated value is **Number**. If it is not, an exception is thrown.

The encapsulated value.

Returns a pointer to the object if the ValueType of the encapsulated value is **Object**. If it is not, an exception is thrown.

A pointer to the encapsulated object.

Returns the String if the ValueType of the encapsulated value is String. If it is not, an exception is thrown.

The encapsulated String value.

Retrieves the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Represents a JSON array.

Creates a new JsonArray object that represents a JSON array.

Gets the size (count) of the array.

The count of items in the array.

Gets the type of the values within the array. Possible types are defined by JsonValueType.

The JSON value type.

Adds a new item to the array.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the array.

The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty.

Gets the JsonArray if the ValueType of the encapsulated value is **Array**.

The JsonArray.

Gets the JsonArray at the specified index if the ValueType of the encapsulated value is **Array** .

The specified index. The JsonArray at the specified index.

Returns the item located at the specified index.

The integer index for the value to retrieve. The JsonValue at the specified index.

Gets the Boolean value if the ValueType of the encapsulated value is Boolean.

The Boolean value.

Gets the Boolean value at the specified index if the ValueType of the value at that index is **Boolean**.

The specified index. The Boolean value at the specified index.

Gets all array items of type IJsonValue, starting from a specified index.

The starting index. Returns items of the IJsonValue. The index of *items* within the range of elements in an array that starts at *startIndex*.

Gets the number (a Double ) if the ValueType of the encapsulated value is **Number**.

The number value.

Gets the number (a Double ) at the specified index if the ValueType of the value at that index is **Number**.

The specified index. The number value at the specified index.

Gets the JsonObject if the ValueType of the encapsulated value is **Object**.

The JsonObject.

Gets the JsonObject at the specified index if the ValueType of the encapsulated value is **Object**.

The specified index. The JsonObject at the specified index.

Gets the String if the ValueType of the encapsulated value is String.

The String value.

Gets the String at the specified index if the ValueType of the encapsulated value is **String**.

The specified index. The String value at the specified index.

Gets a JsonArray view.

The JsonArray view.

Searches for a JsonValue object and returns the zero-based index of its first occurrence within the JsonArray.

The IJsonValue to look up. The zero-based index of the first occurrence of item within the JsonArray, if found; otherwise, –1. Returns a Boolean value indicating if an occurrence of *value* was found.

Inserts a JsonValue into an array at the specified index.

The zero-based index at which the item should be inserted. The IJsonValue object to insert.

Parses the specified JSON string that represents a JsonArray.

The specified JSON string.

Removes the element at the specified index of the collection.

The zero-based index of the element to remove.

Removes the last item in the array.

Clears the array and then inserts the provided collection of JsonValue objects as new array items.

The new collection items.

Sets the value at the specified index using the provided JsonValue.

The index at which to set the value. The value to set.

Returns the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Returns the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Parses the provided string into a JsonArray.

The specified string. The new JsonArray object. True if the JsonValue object was successfully created; otherwise, false.

Represents an error encountered while parsing JSON data.

Gets the specific error using the returned **HRESULT** value. Possible values are defined by JsonErrorStatus.

An **HRESULT** returned during the operation. The error encountered.

Defines errors encountered while parsing JSON data.

This operation exceeds the internal limit of 1024 nested JSON objects.

The number is invalid. It is possible the expressed value type of the JSON encapsulated data type does not match what is defined by JsonValueType.

The string is invalid. It is possible the expressed value type of the JSON encapsulated data type does not match what is defined by JsonValueType.

The specified JsonValue cannot be found.

An unknown error occurred.

Represents a JSON object containing a collection of name and JsonValue pairs.

Initializes a new instance of a JsonObject that represents a JSON object containing a collection of name and JsonValue pairs.

Gets the size (count) of the collection.

The count of items in the collection.

Gets the type of the encapsulated JSON value. Possible types are defined by JsonValueType.

The JSON value type.

Removes all items from the collection.

Returns the iterator for iteration over the key/value pairs in the JsonObject.

The iterator object. The iterator's current position is at the 0-index position, or at the array end if the array is empty.

Returns a JsonArray if the ValueType of the encapsulated value is **Array**.

The JsonArray.

Gets a Boolean if the ValueType of the encapsulated value is Boolean.

The Boolean value.

Gets the JsonArray value with the specified name.

The name. The JsonArray with the specified *name*.

Gets the JsonArray value with the specified name, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The JsonArray with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the Boolean value with the specified name.

The name. The Boolean with the specified *name*.

Gets the Boolean value with the specified name, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The Boolean with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the number value (a Double ) with the specified name.

The name. The Double with the specified *name*.

Gets the number value (a Double ) with the specified name, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The Double with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the JsonObject value with the specified name.

The name. The JsonObject value with the specified name.

Gets the JsonObject value with the specified name, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The JsonObject with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the String value with the specified name.

The name. The String value with the specified name.

Gets the String value with the specified name, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The String with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the JsonValue value with the specified name.

The name. The JsonValue value with the specified name.

Gets the specified JsonValue value, or the provided default value if no such named value is found.

The name. The default value to use if the JSON property is not found. The JsonValue with the specified *name*, or if this value wasn't found, the *defaultValue* is returned.

Gets the number (a Double ) if the ValueType of the encapsulated value is **Number**.

The number value.

Gets the JsonObject if the ValueType of the encapsulated value is **Object**.

The encapsulated JsonObject.

Gets the String if the ValueType of the encapsulated value is String.

The String value.

Gets a JsonObject view.

The JsonObject view.

Indicates whether the JsonObject has an entry with the requested key.

The requested key. true if the JsonObject has an entry with the requested key; otherwise, false.

Adds a new entry to the JsonObject.

The key to insert. The IJsonValue to insert. true if calling the method replaced a value that already existed for the key; false if calling the method defined a new key.

Gets the JSON value associated with the supplied key, if an entry with that key exists.

The requested key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Parses the specified JSON string that represents a JsonObject into a JSON value.

The specified JSON string.

Removes a specific item from the JsonObject.

The key of the item to remove.

Sets the value of the first JsonValue object with the specified name to the specified value. If no such object is found, a new name and JsonValue pair is inserted into the JSON object.

The specified name. The specified value.

Retrieves the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Retrieves the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Parses the specified string that represents a JSON object into a JsonObject.

The specified JSON string. The resultant JsonObject. True if the JsonValue object was successfully created; otherwise, false.

Implements the IJsonValue interface which represents a JSON value.

Gets the type of the encapsulated JSON value. Possible types are defined by JsonValueType.

The JSON value type.

Creates a JsonValue from a Boolean.

The value to store in the JsonValue. The JsonValue.

Creates a JsonValue with a **NULL** value.

The JsonValue with a **NULL** value.

Creates a JsonValue from a Number (**Double**).

The Number to store in the JsonValue. The JsonValue.

Creates the string for a JsonValue.

The string for the JsonValue. The JsonValue.

Gets an array if the ValueType of the encapsulated value is **Array**.

The JsonArray.

Gets the Boolean if the ValueType of the encapsulated value is Boolean.

The Boolean value.

Gets the number (a Double ) if the ValueType of the encapsulated value is **Number**.

The number value.

Gets a JsonObject if the ValueType of the encapsulated value is **Object**.

The JsonObject.

Gets a String if the ValueType of the encapsulated value is String.

The String value.

Parses the specified JSON string into a JsonValue.

The specified JSON string.

Retrieves the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Retrieves the JSON representation of the encapsulated value.

A JSON representation of the encapsulated value.

Parses the specified string into a JsonValue.

The specified string. The new JsonValue object. True if the JsonValue object was successfully created; otherwise, false.

Specifies the JSON value type of a JsonValue object.

The JsonValue object is an Array.

The JsonValue object is a **Boolean**.

The JsonValue object is Null.

The JsonValue object is a **Double**.

The JsonValue object is an Object.

The JsonValue object is a **String**.

Represents a Portable Document Format (PDF) document.

Gets whether the Portable Document Format (PDF) document is password-protected.

True if the Portable Document Format (PDF) document is password-protected; otherwise, false.

Gets the number of pages in the Portable Document Format (PDF) document.

The number of pages in the Portable Document Format (PDF) document.

Gets a page from a Portable Document Format (PDF) document.

The location of the Portable Document Format (PDF) page relative to its parent document. The Portable Document Format (PDF) page.

Outputs an asynchronous operation. When the operation completes, a PdfDocument object is returned, which represents a Portable Document Format (PDF) document.

The file, which represents a Portable Document Format (PDF) document. The asynchronous operation.

Outputs an asynchronous operation. When the operation completes, a PdfDocument object is returned, which represents a Portable Document Format (PDF) document. Use this method if the Portable Document Format (PDF) document is password-protected.

The file, which represents a Portable Document Format (PDF) document. The password to open the Portable Document Format (PDF) document, if it requires one. The asynchronous operation.

Creates a PdfDocument object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system.

The stream of data, which represents a Portable Document Format (PDF) document. The asynchronous operation.

Creates a PdfDocument object, representing a Portable Document Format (PDF) document, from a stream of data that represents a Portable Document Format (PDF) document in the file system. Use this method if the Portable Document Format (PDF) document is password-protected.

The stream of data, which represents a Portable Document Format (PDF) document. The password to open the Portable Document Format (PDF) document, if it requires one. The asynchronous operation.

Represents a single page in a Portable Document Format (PDF) document.

Gets the group of dimension properties for a single page in a Portable Document Format (PDF) document.

The group of page dimension properties.

Gets the relative position of the Portable Document Format (PDF) page within its parent Portable Document Format (PDF) document.

The position of the Portable Document Format (PDF) page relative to its parent Portable Document Format (PDF) document.

Gets the Portable Document Format (PDF) page's preferred magnification factor.

The magnification scaling factor to display or print the Portable Document Format (PDF) page.

Gets the number of degrees that the Portable Document Format (PDF) page will be rotated when it's displayed or printed.

The number of degrees to rotate the Portable Document Format (PDF) page, expressed as one of the enumeration values.

Gets the Portable Document Format (PDF) page's size based on its related CropBox, MediaBox, and Rotation property values.

The Portable Document Format (PDF) page's computed size.

Releases all resources associated with the Portable Document Format (PDF) page.

Begins building the Portable Document Format (PDF) page. After this method finishes, the Portable Document Format (PDF) page is completely built.

Represents the fully-built Portable Document Format (PDF) page.

Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents, as an asynchronous action. This asynchronous action can be used to create an image of the Portable Document Format (PDF) page.

The stream of data, which represents a Portable Document Format (PDF) page's content. The asynchronous action.

Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an asynchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page.

The stream of data, which represents a Portable Document Format (PDF) page's contents. The requested set of display settings to apply to the display image that is output based on the Portable Document Format (PDF) page. The asynchronous action.

Represents the dimensions of a single page in a Portable Document Format (PDF) document.

Gets the size of a rectangle that contains the Portable Document Format (PDF) page's contents, including any meaningful surrounding white space, as intended by the Portable Document Format (PDF) page's creator.

The size of the Portable Document Format (PDF) page's contents and any meaningful surrounding white space.

Gets the size of a rectangle that specifies the clipped region of a Portable Document Format (PDF) page's contents when it is displayed.

The size of the Portable Document Format (PDF) page's clipped region.

Gets the size of a rectangle that specifies the cropped region of a Portable Document Format (PDF) page's contents when it is displayed.

The size of the Portable Document Format (PDF) page's cropped region.

Gets the size of a rectangle that defines the boundaries of the area that the Portable Document Format (PDF) page will be displayed or printed to.

The size of the Portable Document Format (PDF) page's display or print boundaries.

Gets the size of a rectangle that specifies the intended dimensions of the Portable Document Format (PDF) page after it has been trimmed.

The Portable Document Format (PDF) page's trimmed dimensions.

Represents display settings for a single page of a Portable Document Format (PDF) document, such as the page's background color and its encoding type.

Creates and initializes a new instance of display settings for a single page of a Portable Document Format (PDF) document.

Gets or sets the Portable Document Format (PDF) page's background color.

The Portable Document Format (PDF) page's background color.

Gets or sets the Portable Document Format (PDF) page's encoding type to be used while the page is being converted to a bitmap.

A BmpEncoderId value representing the unique identifier of the built-in bitmap encoder.

Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs).

The Portable Document Format (PDF) page's scaling factor relative to the page's destination display height boundary.

Gets or sets the final size of the rendering of the Portable Document Format (PDF) page in device-independent pixels (DIPs).

The Portable Document Format (PDF) page's scaling factor relative to the page's destination display width boundary.

Gets or sets whether the Portable Document Format (PDF) page uses the system's high contrast display setting.

False to use high contrast; otherwise, true.

Gets or sets a portion of the Portable Document Format (PDF) page to be displayed.

The portion of the Portable Document Format (PDF) page to be displayed.

Specifies the number of degrees that a page in a Portable Document Format (PDF) document is rotated in the rendered output.

No rotation.

A 180-degree rotation.

A 270-degree rotation.

A 90-degree rotation.

Identifies the normalization format of an AlternateWordForm object.

A string that has been recognized as a monetary amount.

A string that has been recognized as a date.

A regular string that has not been recognized as a number, currency, date, or time.

A string that has been recognized as a number.

A string that has been recognized as a time.

Identifies an alternate form of the word represented by a WordSegment object.. For example, this may contain a number in a normalized format.

Gets the text of the alternate word form identified by this AlternateWordForm object.

The alternate word form.

Gets the normalization format for this current AlternateWordForm object.

The normalization format.

Gets the TextSegment that identifies the source text's sub-string for which this AlternateWordForm object is an alternate.

The TextSegment structure that identifies the word in your provided text.

Represents a segment from your provided text that includes a word and any trailing whitespace and/or punctuation after this word.

Gets the TextSegment that identifies the source text's sub-string that is the selected word.

The TextSegment structure that identifies the word in your provided text.

Gets the text of the selected word identified by this SelectableWordSegment object.

The selected word.

Defines the signature of a function that is provided to SelectableWordsSegmenter.Tokenize.

Contains the selectable words, in reverse order, that precede the parameter *startIndex* that is provided to SelectableWordsSegmenter.Tokenize. Contains the selectable words that contain or follow the parameter *startIndex* that is provided to SelectableWordsSegmenter.Tokenize.

A segmenter class that is able to segment provided text into units appropriate for selecting text by words.

Creates a SelectableWordsSegmenter object. See the introduction in SelectableWordsSegmenter for a description of how the language supplied to this constructor is used.

A BCP-47 language tag.

Gets the language of the rules used by this SelectableWordsSegmenter object.

The BCP-47 language tag of the rules employed.

Determines and returns the selectable word or word stem which contains or follows a specified index into the provided text.

Provided text in which a word or word stem is to be selected. A zero-based index into *text*. It must be less than the length of *text*. A SelectableWordSegment that represents the selected word or word stem.

Determines and returns all of the selectable words or word stems in the provided text.

Provided text containing words or word stems to be selected. A collection of SelectableWordSegment objects that represent the selectable words or word stems.

Calls the provided handler with two iterators that iterate through the selectable words prior to and following a given index into the provided text.

Provided text containing words to be selected. A zero-based index into *text*. It must be less than the length of *text*. The function that receives the iterators.

Permits apps to perform text queries using Advanced Query Syntax (AQS) strings, with the option of providing a language tag to be employed in the query.

Creates a SemanticTextQuery from an Advanced Query Syntax (AQS) query string.

An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about AQS in Advanced Query Syntax (AQS).

Creates a SemanticTextQuery from an Advanced Query Syntax (AQS) query string and a language tag.

An Advanced Query Syntax (AQS) string that contains the desired query. Learn more about Advanced Query Syntax (AQS) in . The BCP-47 language tag to be employed in the query.

Returns segments of a source string that match the SemanticTextQuery object's query.

A source string to be queried. A collection of TextSegment structures that represent hits from the query.

Returns segments of a source string that match the SemanticTextQuery object's query over properties.

A source string to be queried. The name of the property. A collection of TextSegment structures that represent hits from the query.

Converts input phonetic characters into a collection of corresponding ideographic characters (Chinese characters).

Constructs a TextConversionGenerator object based on a specific BCP-47 language tag.

The BCP-47 language tag of the language in which the words are to be projected. Japanese ("ja") and Simplified Chinese ("zh-Hans") are supported.

Determines if the language tag specified is available for conversions, but is not installed on the user's device.

**true** if the language is available but not installed.

Gets the language tag of the successfully created TextConversionGenerator object.

The BCP-47 language tag of the conversion generator.

Asynchronously gets a list of candidate words based on the provided phonetic characters.

The phonetic characters of the words to be returned. An asynchronous operation to return an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of the list of candidate words.

Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters.

The phonetic characters of the words to be returned. The maximum number of candidate words to return. An asynchronous operation to return an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of the list of candidate words.

Represents the result of calling the TextReverseConversionGenerator.GetPhonemesAsync method, encapsulating both the original display text and the phonemes that match the original display text.

Gets the display text for a Japanese phoneme.

The display text as originally passed to TextReverseConversionGenerator.GetPhonemesAsync. In the typical use case of passing a Japanese sentence to that method, the display text is one phonetic part of the sentence in Kanji or a mix of Kanji and phonetic characters.

Gets the phonetic reading of the DisplayText, with Japanese characters in Hiragana.

The reading of the DisplayText, with Japanese characters in Hiragana.

Predicts Japanese words based on a phonetic characters prefix.

Constructs a TextPredictionGenerator object based on a specific BCP-47 language tag.

The BCP-47 language tag of the language in which the words are to be projected. Only Japanese ("ja") is supported.

Gets or sets the input scope for text prediction.

A CoreTextInputScope value.

Determines if the language tag specified is available for generating predictions, but is not installed on the user's device.

**true** if the language is available but not installed.

Gets the language tag of the successfully created TextPredictionGenerator object.

The BCP-47 language tag of the prediction generator.

Asynchronously retrieves a list of candidate words based on the provided phonetic characters prefix.

The beginning phonetic characters of the words to be returned. An asynchronous operation object which, when it completes, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of strings, which are the predicted words.

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix.

The beginning phonetic characters of the words to be returned. The maximum number of predicted words to return. An asynchronous operation object which, when it completes, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of strings, which are the predicted words.

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix and options.

The beginning phonetic characters of the words to be returned. The maximum number of predicted words to return. A TextPredictionOptions value containing prediction options. A collection of previously input words (to assist text prediction). An asynchronous operation object which, when it completes, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of strings, which are the predicted words.

Asynchronously retrieves a collection of strings containing next-word-prediction candidates.

The maximum number of candidates to return. A collection of previously input words (to assist text prediction). An asynchronous operation object which, when it completes, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of strings, which are the next-word-prediction candidates.

Defines constants that specify text prediction options.

Indicates that corrections should be retrieved.

Indicates that neither corrections nor predictions should be retrieved.

Indicates that predictions should be retrieved.

Reverse-converts a Japanese string which is mix of phonetic and ideographic characters, to a string of phonetic characters.

Constructs a TextReverseConversionGenerator object based on a specific BCP-47 language tag.

The BCP-47 language tag of the language in which the words are to be reverse-converted. Only Japanese ("ja") is supported.

Determines if the language tag specified is available for reverse conversions, but is not installed on the user's device.

**true** if the language is available but not installed.

Gets the language tag of the successfully created TextReverseConversionGenerator object.

The BCP-47 language tag of the reverse conversion generator.

Asynchronously reverse-converts a string which contains ideographic characters to a phonetic expression.

The string containing ideographic characters to be reverse-converted. An asynchronous operation to return the phonetic expression.

Returns a set of phonemes representing the given input string. This method is primarily intended for use in sorting data in the Japanese language. Phonetic reading is important for Japanese data handling, especially to sort names in proper phonetic order rather than in character code point order.

A string containing words in Japanese. On successful completion of the async operation, a list of TextPhoneme objects representing the input string in phoneme form.

Identifies a sub-string of a source text string. Your app can use this structure to obtain the segment of your provided text that is identified by AlternateWordForm, SelectableWordSegment, WordSegment, or SemanticTextQuery.

The number of characters in the associated text segment.

The zero-based index of the start of the associated text segment.

Provides a way for apps to get information about Unicode characters, per the Unicode Standard Annex #44.

Returns the supplementary Unicode character for the specified high and low surrogate pair.

The high surrogate value. This must be in the proper range: 0xD800 <= *highSurrogate* <= 0xDBFF. The low surrogate value. This must be in the proper range: 0xDC00 <= *lowSurrogate* <= 0xDFFF. The supplementary Unicode character.

Returns the UnicodeGeneralCategory of the specified Unicode character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. The Unicode general category for *codepoint*.

Returns the UnicodeNumericType of the specified Unicode character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. The Unicode numeric type for *codepoint*.

Returns the high and low surrogate pair values for the specified supplementary Unicode character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. The high surrogate value returned. The low surrogate value returned.

Determines if a specified Unicode character can be considered alphabetic.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is alphabetic; otherwise **FALSE**.

Determines if a specified Unicode character can be considered cased (uppercase, lowercase or titlecase).

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is cased; otherwise **FALSE**.

Determines if a specified Unicode character can be considered the beginning of a grapheme.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is the beginning of a grapheme; otherwise **FALSE**.

Determines if a specified Unicode character can be considered to continue a previous grapheme.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* continues the previous grapheme; otherwise **FALSE**.

Determines if a specified Unicode character is a high surrogate.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a high surrogate; otherwise **FALSE**.

Determines if a specified Unicode character can be considered a continuation character of an identifier in programming.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a continuation character of an identifier in programming; otherwise **FALSE**.

Determines if a specified Unicode character can be considered the start character of an identifier in programming.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is the start character of an identifier in programming; otherwise **FALSE**.

Determines if a specified Unicode character can be considered a lower case character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a lower case character; otherwise **FALSE**.

Determines if a specified Unicode character is a low surrogate.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a low surrogate; otherwise **FALSE**.

Determines if a specified codepoint is a non-character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a non-character; otherwise **FALSE**.

Determines if a specified Unicode character is a supplementary character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is a supplementary character; otherwise **FALSE**.

Determines if a specified Unicode character can be considered an upper case character.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is an upper case character; otherwise **FALSE**.

Determines if a specified Unicode character can be considered whitespace.

A Unicode character. This must be in the proper range: 0 <= *codepoint* <= 0x10FFFF. **TRUE** if *codepoint* is whitespace; otherwise **FALSE**.

Defines the Unicode general category of a character.

Closing character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. Signified by the Unicode designation "Pe" (punctuation, close).

Connector punctuation character that connects two characters. Signified by the Unicode designation "Pc" (punctuation, connector).

Control code character, with a Unicode value of U+007F or in the range U+0000 through U+001F or U+0080 through U+009F. Signified by the Unicode designation "Cc" (other, control).

Currency symbol character. Signified by the Unicode designation "Sc" (symbol, currency).

Dash or hyphen character. Signified by the Unicode designation "Pd" (punctuation, dash).

Decimal digit character, which is a character in the range 0 through 9. Signified by the Unicode designation "Nd" (number, decimal digit).

Enclosing mark character, which is a nonspacing combining character that surrounds all previous characters up to and including a base character. Signified by the Unicode designation "Me" (mark, enclosing).

Closing or final quotation mark character. Signified by the Unicode designation "Pf" (punctuation, final quote).

Format character that affects the layout of text or the operation of text processes, but is not normally rendered. Signified by the Unicode designation "Cf" (other, format).

Opening or initial quotation mark character. Signified by the Unicode designation "Pi" (punctuation, initial quote).

Number represented by a letter, instead of a decimal digit. For example, the Roman numeral for five, which is "V". The indicator is signified by the Unicode designation "Nl" (number, letter).

Character that is used to separate lines of text. Signified by the Unicode designation "Zl" (separator, line).

Lowercase letter. Signified by the Unicode designation "Ll" (letter, lowercase).

Mathematical symbol character, such as "+" or "=". Signified by the Unicode designation "Sm" (symbol, math).

Modifier letter character, which is a free-standing spacing character that indicates modifications of a preceding letter. Signified by the Unicode designation "Lm" (letter, modifier).

Modifier symbol character, which indicates modifications of surrounding characters. For example, the fraction slash indicates that the number to the left is the numerator and the number to the right is the denominator. The indicator is signified by the Unicode designation "Sk" (symbol, modifier).

Nonspacing character that indicates modifications of a base character. Signified by the Unicode designation "Mn" (mark, nonspacing),

Character that is not assigned to any Unicode category. Signified by the Unicode code designation "Cn" (other, not assigned).

Opening character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. Signified by the Unicode designation "Ps" (punctuation, open).

Letter that is not an uppercase letter, a lowercase letter, a titlecase letter, or a modifier letter. Signified by the Unicode designation "Lo" (letter, other).

Number that is neither a decimal digit nor a letter number. For example, the fraction 1/2. The indicator is signified by the Unicode designation "No" (number, other).

Punctuation character that is not a connector, a dash, open punctuation, close punctuation, an initial quote, or a final quote. Signified by the Unicode designation "Po" (punctuation, other).

Symbol character that is not a mathematical symbol, a currency symbol or a modifier symbol. Signified by the Unicode designation "So" (symbol, other).

Character that is used to separate paragraphs. Signified by the Unicode designation "Zp" (separator, paragraph).

Private-use character, with a Unicode value in the range U+E000 through U+F8FF. Signified by the Unicode designation "Co" (other, private use).

Space character, which has no glyph but is not a control or format character. Signified by the Unicode designation "Zs" (separator, space).

Spacing character that indicates modifications of a base character and affects the width of the glyph for that base character. Signified by the Unicode designation "Mc" (mark, spacing combining).

High surrogate or low surrogate character. Surrogate code values are in the range U+D800 through U+DFFF. Signified by the Unicode designation "Cs" (other, surrogate).

Titlecase letter. Signified by the Unicode designation "Lt" (letter, titlecase).

Uppercase letter. Signified by the Unicode designation "Lu" (letter, uppercase).

Defines the type of numeral when a Unicode character represents a number.

A decimal digit in a decimal system that uses 0 through 9.

A digit in the range 0 through 9 that is used in special contexts.

Not a numeric character.

A character that represents another type of numeric value, such as a fraction.

Represents a word from your provided text.

Gets the alternate forms (if any) associated with the current word.

A collection of AlternateWordForm objects that represent alternate forms of the current word.

Gets the TextSegment that identifies the source text's sub-string that is a word.

The TextSegment structure that identifies the word in your provided text.

Gets the text of the word identified by this WordSegment object.

The current word.

Defines the signature of a function that is provided to WordsSegmenter.Tokenize.

Contains the selectable words, in reverse order, that precede the parameter *startIndex* that is provided to WordsSegmenter.Tokenize. Contains the selectable words that contain or follow the parameter *startIndex* that is provided to WordsSegmenter.Tokenize.

A segmenter class that is able to segment provided text into words or word stems (depending on the particular language).

Creates a WordsSegmenter object. See the introduction in WordsSegmenter for a description of how the language supplied to this constructor is used.

A BCP-47 language tag.

Gets the language of the rules used by this WordsSegmenter object.

The BCP-47 language tag of the rules employed.

Determines and returns the word or word stem which contains or follows a specified index into the provided text.

Provided text from which the word or word stem is to be returned. A zero-based index into *text*. It must be less than the length of *text*. A WordSegment that represents the word or word stem.

Determines and returns all of the words or word stems in the provided text.

Provided text containing words or word stems to be returned. A collection of WordSegment objects that represent the words or word stems.

Calls the provided handler with two iterators that iterate through the words prior to and following a given index into the provided text.

Provided text containing words to be returned. A zero-based index into *text*. It must be less than the length of *text*. The function that receives the iterators.

Represents a parsed or unparsed entity in the XML document.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node or NULL if there is no right sibling.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node. This value is always NULL.

This value is always NULL.

Gets the notation name.

The notation name.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Returns the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Gets the public identifier associated with the entity.

The public identifier associated with the entity.

Gets the system identifier associated with the entity.

The system identifier associated with the entity.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the child node list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild * parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Contains a notation declared in the DTD or schema.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node or NULL if there is no right sibling..

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

This value is always NULL.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Gets the public identifier for the notation.

The public identifier for the notation.

Gets the system identifier for the notation.

The system identifier for the notation.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the child node list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expresssion. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Provides text manipulation methods that are used by several objects.

Gets or sets the node data depending on the node type.

The node data.

Gets the length of the data, in Unicode characters.

The length of the data, in Unicode characters.

Appends the supplied string to the existing string data.

The data to be appended to the existing string.

Deletes specified data.

The offset, in characters, at which to start deleting the string data. The number of characters to delete.

Inserts a string at the specified offset.

The offset, in characters, at which to insert the supplied string data. The data to be inserted into the existing string.

Replaces the specified number of characters with the supplied string.

The offset, in characters, at which to start replacing string data. The number of characters to replace. The new data that replaces the old string data.

Retrieves a substring of the full string from the specified range.

Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. Specifies the number of characters to retrieve from the specified offset. The returned substring.

Contains information for the entire Document Object Model. This interface represents a single node in the document tree. While all objects that implement this interface expose methods for dealing with children, not all objects that implement this interface may have children.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Encapsulates the methods needed to execute XPath queries on an XML DOM tree or subtree.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expresssion. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Encapsulates the methods needed to serialize a DOM tree or subtree to a string representation.

Gets and sets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Represents the text content of an element or attribute.

Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node.

The number of characters at which to split this text node into two nodes, starting from zero. The new text node.

The type of an IXmlNode, as returned by the NodeType property.

The node is an XmlAttribute type.

The node is an XmlComment type.

The node is an XmlCDataSection type.

The node is an XmlDocumentFragment type.

The node is an XmlDocument type.

The node is an XmlDocumentType type.

The node is an XmlElement type.

The node is an DtdEntity type.

The node is an XmlEntityReference object.

Default value. Never used by the API.

The node is a DtdNotation type.

The node is an XmlProcessingInstruction type.

The node is an XmlText type.

Represents an attribute of an XmlElement. Valid and default values for the attribute are defined in a document type definition (DTD) or schema.

This method is not applicable to this class and will throw an exception.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the attribute name.

The attribute name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

This property is not applicable to this class and will always return null.

NULL

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

This property always returns value **attributeNode**.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

This property is not applicable to this class and will throw an exception.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

This property is not applicable to this class and will throw an exception.

The left sibling of this node.

Gets a value that indicates whether the attribute is explicitly specified or derived from a default value in the document type definition (DTD) or schema.

True if the attribute is explicitly specified; false if the attribute is derived from a default value.

Gets or sets the attribute value.

The attribute value.

This method is not applicable to this class and will throw an exception.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the child node list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

This method is not applicable to this class and will throw an exception.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expresssion. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Represents a CDATA section of an XML document.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node. This property always returns NULL.

This property always returns NULL.

Gets or sets the node data depending on the node type.

The node data.

Gets the first child node. This property always returns NULL.

The first child node. This property always returns NULL.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node. This property always returns NULL because the CDataSection does not have children.

The last child node. This property is always NULL.

Gets the length of the data, in Unicode characters.

The length of the data, in Unicode characters.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

This method is not applicable to this class. The CDataSection does not have children. This method will throw an exception.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Appends the supplied string to the existing string data.

The data to be appended to the existing string.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Deletes specified data.

The offset, in characters, at which to start deleting the string data. The number of characters to delete.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children. The CDataSection does not have children. This method always returns false.

True if this node has children; otherwise false. This method always returns false.

Inserts a child node to the left of the specified node, or at the end of the child node list. This method is not applicable to this class and will throw an exception.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Inserts a string at the specified offset.

The offset, in characters, at which to insert the supplied string data. The data to be inserted into the existing string.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node. This method is not applicable to this class as the CDataSection does not have children. This method will throw an exception.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Replaces the specified number of characters with the supplied string.

The offset, in characters, at which to start replacing string data. The number of characters to replace. The new data that replaces the old string data.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList. This method is not applicable to this class and will throw an exception.

Specifies an XPath expresssion. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node.

The number of characters at which to split this text node into two nodes, starting from zero. The new text node.

Retrieves a substring of the full string from the specified range.

Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. Specifies the number of characters to retrieve from the specified offset. The returned substring.

Represents an XML comment.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node. This method always returns NULL.

The list of child nodes. This value is always NULL.

Gets or sets the node data depending on the node type.

The node data.

Gets the first child node. This property always returns NULL.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node. This property always returns NULL.

The last child node. This property always returns NULL.

Gets the length of the data in Unicode characters.

The length of the data, in Unicode characters.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

Gets or sets the text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Appends a new child node as the last child of the node. This method is not applicable to this class and it will throw an exception.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Appends the supplied string to the existing string data.

The data to be appended to the existing string.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Deletes the specified data.

The offset, in characters, at which to start deleting the string data. The number of characters to delete.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list. This method is not applicable to this class and will throw an exception.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Inserts a string at the specified offset.

The offset, in characters, at which to insert the supplied string data. The data to be inserted into the existing string.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it. This method is not applicable to this class and will throw an exception.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node. This method is not applicable to this class and will throw an exception.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Replaces the specified number of characters with the supplied string.

The offset, in characters, at which to start replacing string data. The number of characters to replace. The new data that replaces the old string data.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList. This method is not applicable to this class and will throw an exception.

Specifies an XPath expresssion. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node. This method is not applicable to this class and will throw an exception.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Retrieves a substring of the full string from the specified range.

Specifies the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. Specifies the number of characters to retrieve from the specified offset. The returned substring.

Represents the top level of the XML source. This class includes members for retrieving and creating all other XML objects.

Creates a new instance of the XmlDocument class.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

For XML, this property gets the address of the node that specifies the DTD. This property returns Null for HTML documents and XML documents without a DTD.

The document type.

Gets the root element of the document.

The root element of the document.

Returns the URL for the last loaded XML document.

The URL for the last loaded XML document.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the Implementation object for the document.

The Implementation object for the document.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list. This property is not applicable to this class.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

This property returns NULL.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Creates a new attribute with the specified name.

The name of the new attribute object. This name is subsequently available as the new node's NodeName property. The newly created attribute.

Creates a new attribute with the specified namespace and name.

The name of the desired namespace or a null value if no namespace is desired. The name of the new attribute object. This name is subsequently available as the new node's NodeName property. The newly created attribute.

Creates a CDATA section node that contains the supplied data.

The value to be supplied to the new CDATA section object's NodeValue property. The newly created object.

Creates a comment node that contains the supplied data.

The value to be supplied to the new comment object's NodeValue. The newly created comment node.

Creates an empty XmlDocumentFragment object.

The newly created object.

Creates an element node using the specified name.

The name for the new element node. The string is case-sensitive. This name is subsequently available as the element node's NodeName property. The newly created object.

Creates an element node using the specified namespace and name.

The name of the desired namespace or a null value if no namespace is desired. The name for the new element node. It is case-sensitive. This name is subsequently available as the element node's NodeName property. The newly created object.

Creates a new XmlEntityReference object.

The name of the entity referenced. This name is subsequently available as the new object's NodeName property. The newly created object.

Creates a processing instruction node that contains the supplied target and data.

The target part of the processing instruction. It supplies the NodeName property of the new object. The remainder of the processing instruction preceding the closing** ?>** characters. It supplies the NodeValue property for the new object. The newly created object.

Creates a text node that contains the supplied data.

The value to be supplied to the new text object's NodeValue. The created text node.

Returns the element that matches the ID attribute.

The ID to match. The element that matches the supplied ID. If no elements match, this method returns Null.

Returns a collection of elements that have the specified name.

The element name to find. The value "*" returns all elements in the document. The collection of elements that match the specified name.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Imports a node from another document to this document.

The object to be cloned. If true, any children of node will be cloned as well. If false, no children of the node will be cloned. The imported node.

Inserts a child node to the left of the specified node, or at the end of the child node list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Asynchronously loads an XML document from the specified file. The document is parsed using the default parser settings.

The file from which to load the document. The object that must be used to start the operation.

Asynchronously loads an XML document from the specified file. The document is parsed using the provided settings.

The file from which to load the document. Settings for customizing parser behavior. The object that must be used to start the operation.

Asynchronously loads an XML document from the specified location. The document is parsed using the default parser settings.

A URL that specifies the location of the XML file. The object that must be used to start the operation.

Asynchronously loads an XML document from the specified location. The document is parsed using the provided settings.

A URL that specifies the location of the XML file. Customizes parser behavior. An object that must be used to start the operation.

Loads an XML document using the supplied string. The document is parsed using the default parser settings.

The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment.

Loads an XML document using the supplied string. The document is parsed using the settings provided.

The XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment. The settings for parsing the document.

Loads an XML document using the buffer. The document is parsed using the default parser settings.

The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment.

Loads an XML document using the buffer. The document is parsed using the settings provided.

The buffer to load into this XML document object. This buffer can contain an entire XML document or a well-formed fragment. The settings for parsing the document.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Asynchronously saves an XML document to the specified file.

The file to save the document to. The object that must be used to start the operation.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Represents a lightweight object that is useful for tree insertion operations.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance. This property is not applicable to this class.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list. This property is not applicable to this class.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Contains information associated with the document type.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets a list of the entities declared in the **<!DOCTYPE>** declaration.

A list of the general entities, both external and internal, that are present in this document.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

A list of the general entities, both external and internal, that are present in this document.

The name of the document type.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns a list of the DtdNotation members that are present in the document type declaration.

A list of DtdNotation members that are present in the document type declaration.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Provides methods that are independent of any particular instance of the document object model.

Indicates support for the specified feature.

Specifies the feature to test. In Level 1, valid feature values are "XML", "DOM", and "MS-DOM" (case-insensitive). Specifies the version number to test. If NULL, tests for implementation of the feature in any version. In Level 1, "1.0" is the valid version value. True if the specified feature is implemented; otherwise false.

Encapsulates information specific to XML Element nodes.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Gets the element name.

The tag for this element.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the value of the attribute.

The name of the required attribute. The string value of the attribute.

Returns the attribute node.

The name of the required attribute. The returned attribute pointer.

Returns the specified attribute from the specified namespace.

The namespace of the attribute to get. The name of the attribute without the namespace prefix. The returned attribute pointer.

Returns the value of the attribute.

The namespace of the attribute to get. The name of the attribute without the namespace prefix. The string value of the attribute.

Returns a list of all descendant elements that match the supplied name.

The tag of the required elements. The required elements. The list can be empty.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes or replaces the named attribute.

The name of the attribute to be removed.

Removes the specified attribute from this element.

The attribute to be removed. The removed attribute, if any.

Removes the specified attribute from this element in the specified namespace.

The namespace of attribute to be removed. The name of the attribute without the namespace prefix.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Sets the value of the named attribute.

The name of the required attribute. The new value for the attribute.

Sets or updates the supplied attribute node on this element.

A pointer to the new attribute. The returned pointer to the previous attribute (if any) with the same name.

Sets or updates the supplied attribute node on this element. If you are not using any namespaces, then use the SetAttributeNode method.

The node to add to the collection. The attribute successfully added to the collection. If Null, no object is created.

Sets the value of the named attribute in the given namespace.

The namespace of the attribute being set. The name of the attribute being set. The new value for the attribute.

Represents an entity reference node.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Contains settings that are used during loading and parsing of XML documents. The default settings are chosen for the highest security. This class can be instantiated and is accepted by LoadXml, LoadFromUriAsync, and LoadFromFileAsync.

Creates a new XmlLoadSettings object.

Specifies whether default handling preserves white space.

True if default processing preserves white space; otherwise false. The default value is true.

Gets and sets the limits of the element depth of an XML document to be loaded into a DOM object.

The depth value. The default value is 256.

Gets or sets a value that specifies whether to prohibit or allow the inclusion of a DTD in the XML DOM document.

True to prohibit the inclusion of a DTD in the XML DOM document; false to allow the inclusion. The default value is true.

Gets or sets a value that specifies whether external definitions, resolvable namespaces, external subsets of document type definitions (DTDs), and external entity references are to be resolved at the time the document is parsed.

True if external definitions, resolvable namespaces, external subsets of DTDs, and external entity references are resolved at the time the document is parsed; otherwise false. The default value is false.

Gets or sets a value that specifies whether the XML parser should validate this document against the document type definition (DTD) on loading.

If true, the internal or external DTD will be used to validate the document. The default value is false.

Encapsulates iteration through the collection of attribute nodes.

Gets the length of the list of nodes.

The number of nodes in the list.

Gets the number of elements in the vector view.

The number of elements in the vector view.

Returns an iterator that iterates over the items in the collection.

The iterator.

Returns the item at the specified index in the vector view.

The zero-based index of the item in the vector view to return. The item in the vector view at the specified index.

Returns the items that start at the specified index of the vector view.

The zero-based index of the start of the items in the vector to return. The items in the vector view that start at *startIndex*. The number of items returned.

Retrieves the attribute with the specified name.

The name of the attribute. The returned attribute with the specified name. This method returns Null if the attribute node is not in this collection.

Retrieves the attribute with the specified namespace and name.

The namespace name of the attribute. The name of the attribute. The attribute with the specified namespace and name. This method returns Null if the attribute node is not in this collection.

Returns the index of a specified item in the vector view.

The item to find in the vector view. The zero-based index of the item if found. Zero is returned if the item is not found. TRUE if the item is found; otherwise, FALSE if it is not found.

Allows random access to individual nodes within the collection.

The index of the item within the collection. The first item is zero. The object to access. This method returns **null** if the index is out of range.

Removes the specified item.

The name of the attribute to remove from the collection. The node removed from the collection. This method returns Null if the named node is not an attribute.

Removes an item that is specified by a namespace and local name.

The namespace name of the attribute. The name of the attribute. The node removed from the collection. This method returns Null if the named node is not an attribute.

Adds the specified node to the collection.

The node to add to the collection. The attribute successfully added to the collection. If Null, no object is created.

Adds the specified node to the collection in the specified namespace. If you are not using any namespaces, then use the SetNamedItem method.

The node to add to the collection. The attribute successfully added to the collection. If Null, no object is created.

Describes a collection of nodes.

Gets the length of the list.

The length of the list. The range of valid child node indices is 0 to length-1 inclusive.

Gets the number of elements in the vector view.

The number of elements in the vector view.

Returns an iterator that iterates over the items in the collection.

The iterator.

Returns the item at the specified index in the vector view.

The zero-based index of the item in the vector view to return. The item in the vector view at the specified index.

Returns the items that start at the specified index of the vector view.

The zero-based index of the start of the items in the vector to return. The items in the vector view that start at *startIndex*. The number of items returned.

Returns the index of a specified item in the vector.

The item to find in the vector. The zero-based index of the item if found. Zero is returned if the item is not found. TRUE if the item is found; otherwise, FALSE if the item is not found.

Returns the item in the list at the specified index.

The zero-based index of the requested item. The requested item. This method returns NULL if the index is not valid.

Represents a processing instruction, which XML defines to keep processor-specific information in the text of the document.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets or sets the content of the processing instruction, excluding the target.

The content of the processing instruction, excluding the target.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Gets the target for the processing instruction.

The target application to which this processing instruction is directed.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Represents the text content of an element.

Gets the list of attributes of this node.

The attributes for this node.

Gets a list of children in the current node.

The list of child nodes.

Gets or sets the node data depending on the node type.

The node data.

Gets the first child node.

The first child node. This property returns NULL if there are no children.

Gets the text from inside the XML.

The text from inside the XML. Returns an empty string if there is no text.

Gets the last child node.

The last child node. This property is NULL if there are no children.

Gets the length of the data, in Unicode characters.

The length of the data, in Unicode characters.

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

The local name.

Returns the Uniform Resource Identifier (URI) for the namespace.

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Gets the next sibling of the node in the parent's child list.

The right sibling of this node.

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

The qualified node name, which varies depending on the node type.

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

The node type.

Gets or sets the text associated with the node.

The text associated with the node.

Returns the root of the document that contains the node.

The parent document that represents the root of the document.

Gets the parent node of the node instance.

The parent node.

Gets or sets the namespace prefix.

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Gets the previous sibling of the node in the parent's child list.

The left sibling of this node.

Appends a new child node as the last child of the node.

The new child node to be appended to the end of the list of children of this node. The new child node successfully appended to the list. If null, no object is created.

Appends the supplied string to the existing string data.

The data to be appended to the existing string.

Clones a new node.

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only. The newly created clone node.

Deletes specified data.

The offset, in characters, at which to start deleting the string data. The number of characters to delete.

Returns the XML representation of the node and all its descendants.

The XML representation of the node and all its descendants.

Determines whether a node has children.

True if this node has children; otherwise false.

Inserts a child node to the left of the specified node, or at the end of the list.

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the *newChild* parameter, because an attribute cannot have an attribute as a child. If *newChild* is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before *referenceChild*. The reference node. The node specified is where the *newChild* node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the *newChild* node is inserted at the end of the child list. If the *referenceChild* node is not a child of the current node, an error is returned. On success, the child node that was inserted. If null, no object is created.

Inserts a string at the specified offset.

The offset, in characters, at which to insert the supplied string data. The data to be inserted into the existing string.

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

Removes the specified child node from the list of children and returns it.

The child node to be removed from the list of children of this node. The removed child node. If null, the *childNode* object is not removed.

Replaces the specified old child node with the supplied new child node.

The new child that is to replace the old child. If null, the *referenceChild* parameter is removed without a replacement. The old child that is to be replaced by the new child. The old child that is replaced. If null, no object is created.

Replaces the specified number of characters with the supplied string.

The offset, in characters, at which to start replacing string data. The number of characters to replace. The new data that replaces the old string data.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

Specifies an XPath expression. Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Specifies an XPath expression. Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well. The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Splits this text node into two text nodes at the specified offset and inserts the new text node into the tree as a sibling that immediately follows this node.

The number of characters at which to split this text node into two nodes, starting from zero. The new text node.

Retrieves a substring of the full string from the specified range.

The offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data. The number of characters to retrieve from the specified offset. The returned substring.

Provides the methods needed by the Xslt processor.

Creates a new XsltProcessor object from the document provided.

The XSLT to process.

Processes a node and its children and returns the resulting XmlDocument.

The node to process. The resulting transformation.

Processes a node and its children and returns the resulting string transformation.

The node to process. The resulting transformation.

Used to set descriptive information about the app and the device it is running on.

A globally unique identifier associated with the app.

A GUID representing the globally unique identifier.

A collection of language-specific app names.

The app name in each supported language.

The date of manufacture.

The date of manufacture in a **YYYY-MM-DD** format.

The default app name assigned by the manufacturer- either the developer or the OEM. This property is a shortcut to the entry in the AppNames property for the DefaultLanguage.

The default app name.

The default description of the app. This property is a shortcut to the entry in the Descriptions property for the DefaultLanguage.

The app description.

The name of the manufacturer of the app. This property is a shortcut to the entry in the Manufacturers property for the DefaultLanguage.

The manufacturer name.

A collection of language-specific app description strings.

The app description.

Indicates if the service should advertise the provided AllJoynAboutData values.

True if enabled; otherwise, false.

A collection of language-specific manufacturer name strings.

The manufacturer name in each supported language.

The model number of the device running the app.

The device model number.

The version number of the app. Use of this property applies to Producer apps.

The version number.

A URL to the manufacturer or developer support portal.

The support URL.

Used to view data about another app and the device it is running on.

The version number for the implemented AllJoyn platform software.

Current version number.

A globally unique identifier associated with the app.

A GUID representing the globally unique identifier.

The name of the app.

The app name.

The date of manufacture.

A date value in the **YYYY-MM-DD** format.

The default language of the app.

The default language.

An app description provided by the manufacturer.

The app description.

The device ID used during advertising.

The device ID.

Name of the device.

The device name.

The current version of the hardware that the app is running on. This field is optional, presenting as an empty string if not set.

The hardware version number.

The name of the manufacturer.

The manufacturer name.

The model number of the device running the app.

The model number.

This is a set of fields, where each other named AllJoynAboutDataView property is also accessible. For example, ModelNumber is Properties**["ModelNumber"]**. Additionally, this property can be used to get custom properties.

A set of fields that provide access to AllJoynAboutDataView properties.

The version number of the app.

The version number.

The status returned by the GetDataBySessionPortAsync operation that created the AllJoynAboutDataView object.

The status code.

A list of languages supported by the app and will always include the DefaultLanguage.

A list of Language objects.

A URL to the manufacturer or developer support portal.

The support URL.

Gets the About data for a session.

The unique name. The bus attachment supporting the session. The port used to connect to the session. An object containing About data for the session.

Gets the About data for a session in a particular language.

The unique name. The bus attachment supporting the session. The port used to connect to the session. The language to return the descriptive data in. An object containing About data for the session in the set language.

Contains information about a join session request that is used to determine if the request will be accepted and initiate the session connection.

Generates an object containing information about the connection being accepted to the session and the method that completes the session join.

The unique bus name. The session port used for the connection. The type of traffic provided over the connection. Indicates network proximity. The IAllJoynAcceptSessionJoiner object used to complete the session join.

Indicates if the app joining the session is on the same network.

True if on the same network; otherwise, false.

The app joining the session is on the same physical node.

True if on the same node; otherwise, false.

The session port being used to connect to the session.

The session port number.

The traffic type supported during the session.

The traffic type.

The unique bus name of the app requesting a session connection.

The unique bus name of the app.

Called to accept the session connection.

Contains information about a successful or unsuccessful completion of an authentication operation.

The mechanism used during authentication.

The authentication mechanism.

The unique bus name of the Consumer being authenticated. On the initiating side this will be the unique bus name of the remote app being authenticated. On the accepting side this will be the unique bus name for the remote app.

The unique bus name.

Indicates if the remote app was authenticated.

True if the authentication was successful; otherwise, false.

Defines values used to indicate the mechanism used in authentication operations.

ECDHE_ECDSA key exchange.

ECDHE_NULL key exchange.

ECDHE_PSK has been deprecated and should no longer be used.

EcdhePsk is deprecated and might not work on all platforms. For more info, see MSDN.

ECDHE_SPEKE key exchange.

No mechanism used.

Secure Remote Password (SRP) anonymous has been deprecated and should no longer be used.

SrpAnonymous is deprecated and might not work on all platforms. For more info, see MSDN.

Secure Remote Password (SRP) logon (for example, username and password) has been deprecated and should no longer be used.

SrpLogon is deprecated and might not work on all platforms. For more info, see MSDN.

Represents a connection to the underlying communication pipeline (transport agnostic) that AllJoyn uses to communicate with other endpoints regardless of the transport.

Generates an AllJoynBusAttachment object using the default named pipe connection specification.

Generates an AllJoynBusAttachment object using the provided connection specification.

Specification used to initiate and maintain connections to a router node (bus). Windows 10 supports the 'npipe:' transport, formatted according to the .

This property returns an AllJoynAboutData object containing the descriptive data that the platform may advertise on behalf of the app.

An object containing descriptive information for an app.

A list of AllJoynAuthenticationMechanism objects representing the acceptable authentication mechanisms. Default values include Rsa and None.

The supported authentication mechanisms.

The connection specification used to establish and maintain the bus attachment. If a specification was not provided, this property will retrieve a default named pipe specification.

The connection specification.

The current state of the bus attachment. State changes are surfaced via StateChanged events. Possible values are defined by the AllJoynBusAttachmentState enumeration.

The state of the bus attachment.

The unique bus name associated with the remote app. This unique bus name is used to represent it on the bus via the bus attachment.

The unique bus name.

Occurs when a remote AllJoyn endpoint requests to join the bus attachement's session.

Occurs when verification of supplied credentials is complete.

Occurs when credentials are requested for authentication.

Occurs when credentials have been provided by a remote Consumer for verification.

Occurs when a remote AllJoyn endpoint joins the session of the bus attachment.

Occurs when the state of the bus attachment changes. The AllJoynBusAttachmentState enumeration defines the possible state values.

Initiates the connection.

Initiates a disconnect operation from the router node (bus).

Gets the About data for a specific AllJoyn endpoint. This method is intended to replace the less intuitive static AllJoynAboutDataView.GetDataBySessionPortAsync().

The AllJoyn endpoint from which to retrieve About data.

Gets the About data for a specific AllJoyn endpoint in a specific language. This method is intended to replace the less intuitive static AllJoynAboutDataView.GetDataBySessionPortAsync().

The AllJoyn endpoint from which to retrieve About data. The language in which to request About data. If the requested language is not supported, the remote device's default language will be used. This method makes acquiring About data more intuitive than it was in previous Windows releases.

Gets the default AllJoynBusAttachment as defined by the app's manifest.

The default bus attachment.

Creates a DeviceWatcher that yields AllJoyn bus objects that implement the entire set of interfaces.

The required interfaces that must be implemented by the bus objects. This can be a **List** of **String**. The device watcher for the bus objects.

Pings the specified connection asynchronously.

The unique name associated with the connection. An AllJoyn status code.

Defines values used to indicate the state of a connection with an AllJoyn bus that is managed by an AllJoynBusAttachment object.

Currently connected to the bus.

Connecting to the bus.

Disconnected from the bus.

Currently disconnecting from the bus.

Contains information about state and status changes to an AllJoyn bus connection managed by an AllJoynBusAttachment object.

Indicates the current state of a connection to an AllJoyn bus.

The current connection state.

Contains a status code that provides status information for AllJoynBusAttachment change events. Properties used in the generation of possible values are defined by AllJoynStatus.

The AllJoyn status code associated with the event.

Represents a bus object available over the transport agnostic communication pipeline.

Creates an AllJoynBusObject with the object path as the root object path. i.e. "/".

Create an AllJoynBusObject that will implement one or more interfaces at the specified object path.

The object path.

Create an AllJoynBusObject that will implement one or more interfaces at the specified object path with the AllJoynBusAttachment specified.

The object path. The bus attachment instance.

Gets the bus attachment of this AllJoynBusObject.

The bus attachment.

Gets the AllJoynSession for this AllJoynBusObject.

The AllJoyn session.

Event triggered when the AllJoynBusObject is stopped.

Adds an additional interface to be produced to the service provider.

The interface to be produced.

Starts the AllJoynBusObject. If the bus attachment is not already explicitly connected, starting the producer will automatically connect the bus attachment.

Stops the AllJoynBusObject.

Contains information about the stopped AllJoynBusObject.

Creates an AllJoynBusObjectStoppedEventArgs class used for communicating status of the AllJoynBusObject.Stopped event.

Value indicating the status.

Gets the status of the AllJoynBusObject that was stopped.

The status of the bus object.

Defines properties used when passing credentials during authentication.

The mechanism used for credential authentication.

The authentication mechanism.

The cryptography certificate used for the Rsa and EcdheEcdsa authentication mechanisms.

The cryptography certificate.

The user name, if any, and password used for authentication.

A user name/password combination.

The period of time before provided credentials expire.

The expiration time.

Contains information about a request for credentials in order to authenticate to a peer.

The number of times the credential request has been tried.

The number of retries.

The authentication credentials to be filled in by the app.

Object containing certificate and logon credentials.

The unique bus name of the remote app that provided the requested credentials.

The unique bus name.

A user name value used by mechanisms that accept a user name/password pair.

The user name.

Allows JavaScript UWP app to handle the verification of provided of credentials asynchronously.

The credential request deferral.

Used to allow the application to indicate whether the credentials provided by a peer are valid.

The mechanism used to authenticate credentials.

The authentication mechanism.

The cryptography certificate provided for authentication.

The cryptography certificate.

A list of errors that occurred during authentication of the provided cryptography certificate.

A list of credential errors.

The category of an errors encountered authenticating the cryptography certificate.

The severity of the error.

Retrieves the intermediate certificates sent during authentication.

A list of the intermediate certificates.

The unique bus name of the remote app being authenticated.

A unique bus name.

Calling this method indicates that the credentials provided for authentication are valid.

Conducts verification of provided of credentials asynchronously.

The verification deferral.

Exposes information about the sender of a message being processed.

Generates an AllJoynMessageInfo object that contains the unique name of the sender that sent the message being processed.

The unique name of the sender.

The unique bus name of the message sender.

The unique bus name.

Contains status information that indicates why a Producer app was stopped.

Generates an object containing status information for the stopped Producer app.

An AllJoyn status code that indicates why the Producer was stopped.

Returns an AllJoyn status code that indicates why the Producer was stopped. Common values are defined by AllJoynStatus.

The AllJoyn status code.

Exposes unique name and transport information for an advertising app.

Generates an AllJoynServiceInfo object that represents an advertising app. This object provides the unique bus name, object path and transport information.

The unique bus name. The object path. The port for this session.

The path to the service object. This path is used to match communications with service objects connected to the session.

The service object path.

The port used to connect to the session.

The connection port number.

The unique bus name associated with the advertising app.

The unique name.

Converts a DeviceInformation ID acquired by a device enumeration into an AllJoynServiceInfo object.

The acquired DeviceInformation ID. The AllJoynServiceInfo object corresponding to the ID. This object can be used to establish sessions with remote endpoints and to retrieve About data from them.

Contains information that identifies an advertising app that is no longer available.

Generates an object containing information about an advertising app that is no longer available.

The unique app name.

The unique bus name of the advertising app that is no longer available.

The unique bus name.

Represents an AllJoyn session created with a provider to consume the services available from that provider.

Gets the unique ID of the session.

The ID.

Gets the current status of the session.

Value representing the status of the session.

Event triggered when an AllJoynSession has been lost. More information about the event can be found in the associated AllJoynSessionLostEventArgs.

Event triggered when a member has been added to an AllJoynSession.

Event triggered when a member has been removed from an AllJoynSession.

Gets a session with the producer based on the specified service info.

The service info to acquire the correct session. An AllJoyn object for the AllJoyn session based off the service info.

Gets a session with the producer based on the specified service info and bus attachment.

The service info to acquire the correct session. The bus attachment to identify the AllJoyn session. If not specified, it is set to the result of AllJoynBusAttachment.GetDefault. An AllJoyn object for the AllJoyn session based off the service info.

Removes the member specified by the input String from the session.

Name of member to be removed from the session. An AllJoyn status code.

Contains information that identifies a session that has been joined.

Creates an AllJoynSessionJoinedEventArgs object with the specified session information.

The session that has been joined.

Gets the session that has been joined.

The joined session.

Contains information that identifies the reason for a lost session.

Generates an AllJoynSessionLostEventArgs object containing information that identifies the reason for the lost session.

The reason the session was lost.

Retrieves a value that indicates the reason for a lost session.

The reason the session was lost. Possible values are defined by AllJoynSessionLostReason.

Defines values used by AllJoynSessionLostEventArgs to indicate the reason for a lost session.

The connection supporting the session timed out.

No reason indicated.

The session was lost due to any other reason.

The Producer closed the session unexpectedly.

The Producer left the session.

The Consumer was removed from the session by the Producer.

Contains information about a peer that was added to a session.

Generates an object that contains information about the remote app added to the session.

The unique Consumer name.

The unique bus name of the remote app new to the session.

The unique bus name.

Contains information about a remote app removed from a session.

Generates an object containing information about a remote app removed from a session.

The unique bus name of the remote app removed from the session.

The unique bus name of the remote app removed from the session.

The unique bus name.

Defines a collection of properties used to convey meaning for AllJoyn status codes. For possible status values, refer to the AllJoyn standard documentation.

Indicates that authentication could not be completed.

The relevant AllJoyn status code.

Authentication was rejected by the advertising app.

The relevant AllJoyn status code.

The connection to the session was refused.

The relevant AllJoyn status code.

The operation has failed.

The relevant AllJoyn status code.

Insufficient security provided for session connections.

The relevant AllJoyn status code.

Function call argument 1 is invalid.

The relevant AllJoyn status code.

Function call argument 2 is invalid.

The relevant AllJoyn status code.

Function call argument 3 is invalid.

The relevant AllJoyn status code.

Function call argument 4 is invalid.

The relevant AllJoyn status code.

Function call argument 5 is invalid.

The relevant AllJoyn status code.

Function call argument 6 is invalid.

The relevant AllJoyn status code.

Function call argument 7 is invalid.

The relevant AllJoyn status code.

Function call argument 8 is invalid.

The relevant AllJoyn status code.

Operation successful.

The relevant AllJoyn status code.

The operation timed out.

The relevant AllJoyn status code.

The Producer end of the session connection was closed.

The relevant AllJoyn status code.

The SSL connection has failed.

The relevant AllJoyn status code.

The SSL verification failed. Review provided SSL credentials.

The relevant AllJoyn status code.

Defines values used to indicate the type of data carried in session traffic.

Message traffic.

Session carries a reliable byte stream.

Unreliable (lossy) byte stream.

Traffic type currently unknown.

Contains information about the stopped session watcher object.

Generates an AllJoynWatcherStoppedEventArgs object that contains status information that identifies the reason the watcher object was stopped.

The AllJoyn status code.

Returns a status code that was returned when the watcher object is stopped. This value is represented by AllJoynStatus.

The AllJoyn status code.

Use this interface to accept requests from peers to join a session.

Accept an incoming request to join the session.

Represents an AllJoyn producer to be used with AllJoynBusObject.

Sets the specified bus object to be used when the producer is added.

The desired bus object.

Used to provide the DeviceInformation.ID, expected duration, and arguments given by the app that triggered the background servicing task.

Gets the arguments string provided by the app when it called RequestAsync on the DeviceServicingTrigger. This allows the app to easily pass parameters to the task when it invokes it.

The *arguments* parameter value from the originating RequestAsync call.

Gets the DeviceInformation.ID of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call UsbDevice.FromIdAsync in the Windows.Devices.Usb namespace to open a USB device.

The *deviceId* parameter value from the originating RequestAsync call.

Gets the estimated duration provided by the app when it called RequestAsync on the DeviceServicingTrigger.

The *expectedDuration* parameter value from the originating RequestAsync call.

Used to provide the DeviceInformation.ID and arguments given by the app that triggered the background sync task.

Gets the arguments string provided by the app when it called RequestAsync on the DeviceUseTrigger. This allows the app to easily pass parameters to the task when it invokes it.

The *arguments* parameter value from the originating RequestAsync call.

Gets the DeviceInformation.ID of the device the task is targeting. The background task can provide this to the `FromIdAsync` method of the appropriate device access class to open the device. For example, call UsbDevice.FromIdAsync in the Windows.Devices.Usb namespace to open a USB device.

The *deviceId* parameter value from the originating RequestAsync call.

Represents a Bluetooth adapter.

Gets or sets a value indicating whether Secure Connections are supported for classic paired Bluetooth devices.

Indicates whether Secure Connections are supported for classic paired Bluetooth devices.

Gets or sets a value indicating whether Secure Connections are supported for paired Bluetooth LE devices.

Indicates whether Secure Connections are supported for classic paired Bluetooth devices.

Gets the device address.

The device address.

Gets the device ID.

The ID of the device.

Gets a boolean indicating if the adapter supports advertisement offload.

Gets a boolean indicating if the adapter supports advertisement offload.

Gets a boolean indicating if the adapater supports LowEnergy central role.

Gets a boolean indicating if the adapater supports LowEnergy central role.

Gets a boolean indicating if the adapter supports the Bluetooth Classic transport type.

Gets a boolean indicating if the adapter supports the Bluetooth Classic transport type.

Indicates whether the adapter supports the 5.0 Extended Advertising format.

Indicates whether extended advertisements are supported on this adapter.

Gets a boolean indicating if the adapater supports LowEnergy Bluetooth Transport type.

Gets a boolean indicating if the adapater supports LowEnergy Bluetooth Transport type.

Gets a boolean indicating if the adapater supports LowEnergy peripheral role.

Gets a boolean indicating if the adapater supports LowEnergy peripheral role.

Indicates the maximum length of an advertisement that can be published by this adapter.

The maximum advertisement length of this adapter.

Gets a BluetoothAdapter object identified by the given DeviceId.

The DeviceId value that identifies the BluetoothAdapter instance. This is a composite string combining registry information that includes the MatchingDeviceId, the MAC address, and a GUID representing a device class. This is different than Windows.Devices.Enumeration.DeviceInformation.Id. However, both contain the MAC address of the Bluetooth radio device embedded within the identifier string. After the asynchronous operation completes, returns the BluetoothAdapter object identified by the given DeviceId.

Gets the default BluetoothAdapter.

An asynchronous operation that completes with a BluetoothAdapter.

Gets an Advanced Query Syntax (AQS) string for identifying instances of this adapter. This string is passed to the FindAllAsync or CreateWatcher method.

Returns an AQS string.

Gets the radio represented by this Bluetooth adapter.

Returns an asynchronous operation that completes with the Radio.

Describes the Bluetooth address type.

Public address.

Random address.

Unspecified address.

Indicates whether applicable Bluetooth API methods should operate on values cached in the system, or whether they should retrieve those values from the Bluetooth device. See **Remarks**.

Use values cached in the system.

Retrieve values from the Bluetooth device.

Provides functionality to determine the Bluetooth Class Of Device (Bluetooth COD) information for a device.

Gets the Major Class code of the Bluetooth device.

One of the enumeration values that specifies the device's Major Class code.

Gets the Minor Class code of the device.

One of the enumeration values that specifies the device's Minor Class code.

Gets the Bluetooth Class Of Device information, represented as an integer value.

The Bluetooth Class Of Device information, represented as a raw integer value.

Gets the service capabilities of the device.

One of the enumeration values that specifies the service capabilities of the device.

Creates a BluetoothClassOfDevice object by supplying values for BluetoothMajorClass, BluetoothMinorClass and BluetoothClassOfDevice.

One of the enumeration values that specifies the device's main function. One of the enumeration values that specifies the minor class value to be used. One of the enumeration values that specifies the service the device supports. A BluetoothClassOfDevice object.

Creates a BluetoothClassOfDevice object from a raw integer value representing the Major Class, Minor Class and Service Capabilities of the device.

The raw integer value from which to create the BluetoothClassOfDevice object. A BluetoothClassOfDevice object.

Indicates the connection status of the device.

The device is connected.

The device is disconnected.

Represents a Bluetooth device.

Gets the device address.

The device address.

Gets the bluetooth device ID.

The bluetooth device ID.

Gets the Bluetooth Class Of Device information of the device.

The Bluetooth Class Of Device information of the device.

Gets the connection status of the device.

One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device.

The current **DeviceAccessInformation** object for the device. Used to check and monitor access changes to the device.

The current **DeviceAccessInformation** object for the device.

Gets the device ID that came from the Windows.Devices.Enumeration.DeviceInformation.Id

The ID of the device.

Gets the DeviceInformation object for the Bluetooth device.

The device information.

Gets the HostName of the device.

The HostName of the device.

Gets the Name of the device.

The name of the device.

Gets the read-only list of RFCOMM services supported by the device.

The read-only list of RFCOMM services supported by the device.

Gets the read-only list of Service Discovery Protocol (SDP) records for the device.

The read-only list of Service Discovery Protocol (SDP) records for the device.

Gets a boolean indicating whether the BluetoothDevice was paired using a Secure Connection.

A boolean indicating whether the BluetoothDevice was paired using a Secure Connection.

Occurs when the connection status of the device has changed.

Occurs when the name of the device has changed.

Occurs when the list SDP records for the device has changed.

Closes the Bluetooth device.

Returns a BluetoothDevice object for the given BluetoothAddress.

The address of the Bluetooth device. After the asynchronous operation completes, returns the BluetoothDevice object with the given BluetoothAddress or null if the address does not resolve to a valid device.

Returns a BluetoothDevice object identified by the given HostName.

The HostName that identifies the BluetoothDevice instance. After the asynchronous operation completes, returns the BluetoothDevice object identified by the given HostName.

Returns a BluetoothDevice object identified by the given DeviceId.

The DeviceId value that identifies the BluetoothDevice instance. After the asynchronous operation completes, returns the BluetoothDevice object identified by the given DeviceId.

Gets an Advanced Query Syntax (AQS) string for identifying instances of this device. This string is passed to the FindAllAsync or CreateWatcher method.

The device selector for this device.

Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth device. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.

A 64-bit Bluetooth device address used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string from a BluetoothClassOfDevice object. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.

The class of device used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices with the indicated BluetoothConnectionStatus. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects with the indicated Bluetooth connection status.

The connection status used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth device name. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects containing the specified Bluetooth device name.

The Bluetooth device name used for constructing the AQS string. An AQS string that is passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices that are either paired or unpaired. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.

The current pairing state for Bluetooth devices used for constructing the AQS string. Bluetooth devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. An AQS string that can be passed as a parameter to the CreateWatcher method.

Retrieves all Rfcomm Services on the remote Bluetooth Device.

After the asynchronous operation completes, returns a RfcommDeviceServicesResult object.

Retrieves all cached Rfcomm Services on the remote Bluetooth Device.

The cache mode. After the asynchronous operation completes, returns a RfcommDeviceServicesResult object.

Retrieves all Rfcomm Services on the Remote Bluetooth Device matching the specified RfcommServiceId.

The Rfcomm service id. After the asynchronous operation completes, returns an RfcommDeviceServicesResult object.

Retrieves all cached Rfcomm Services on the Remote Bluetooth Device matching the specified RfcommServiceId.

The Rfcomm service id. The cache mode. After the asynchronous operation completes, returns an RfcommDeviceServicesResult object.

Used to request explicit access to the Bluetooth device. This invokes Device Consent and must be called on the UI thread.

After the asynchronous operation completes, returns a DeviceAccessStatus enumeration value.

Represents a bluetooth device ID.

Gets the bluetooth device ID.

Gets the bluetooth device ID.

Gets a boolean indicating if this is a classic device.

Gets a boolean indicating if this is a classic device.

Gets a boolean indicating if this is a LowEnergy device.

Gets a boolean indicating if this is a LowEnergy device.

Creates a BluetoothDeviceId object from the device ID.

The device ID.

Specifies common Bluetooth error cases.

The operation requires consent.

The operation cannot be completed because the remote device is not connected.

The operation is disabled by policy.

The operation is disabled by the user.

The operation is not supported on the current Bluetooth radio hardware.

An unexpected error has occurred.

The Bluetooth radio was not available. This error occurs when the Bluetooth radio has been turned off.

The operation cannot be serviced because the necessary resources are currently in use.

The operation was successfully completed or serviced.

The transport is not supported.

Provides functionality to determine the Bluetooth Low Energy (LE) Appearance information for a device. To get an instance of this class, call the BluetoothLEAppearance.FromRawValue method or the BluetoothLEAppearance.FromParts method.

Gets the appearance category value of the Bluetooth LE device.

The appearance category of the Bluetooth LE device. For more info see BluetoothLEAppearanceCategories

Gets the appearance raw value of the Bluetooth LE device.

The appearance raw value of the Bluetooth LE device.

Gets the appearance subcategory value of the Bluetooth LE device.

The appearance subcategory of the Bluetooth LE device. For more info, see BluetoothLEAppearanceSubcategories

Creates a BluetoothLEAppearance object by supplying values for Category (see BluetoothLEAppearanceCategories ) and Subcategory (see BluetoothLEAppearanceSubcategories ) of the Bluetooth LE device.

The Bluetooth LE appearance category. See BluetoothLEAppearanceCategories. The Bluetooth LE appearance subcategory. See BluetoothLEAppearanceSubcategories. The Bluetooth LE appearance object that was created from the appearance category and subcategory.

Creates a BluetoothLEAppearance object by supplying for raw integer values representing the Category and Subcategory of the Bluetooth LE device.

The raw integer value representing the appearance category and subcategory. The Bluetooth LE appearance object that was created from the appearance category and subcategory.

Indicates the appearance category code of the Bluetooth LE device.

Gets the barcode scanner appearance category code.

The appearance category code for a barcode scanner Bluetooth LE device.

Gets the blood pressure appearance category code.

The appearance category code for a blood pressure Bluetooth LE device.

Gets the clock appearance category code.

The appearance category code for a clock Bluetooth LE device.

Gets the computer appearance category code.

The appearance category code for a computer Bluetooth LE device.

Gets the cycling appearance category code.

The appearance category code for a cycling Bluetooth LE device.

Gets the display appearance category code.

The appearance category code for a display Bluetooth LE device.

Gets the eye glasses appearance category code.

The appearance category code for an eye glasses Bluetooth LE device.

Gets the glucose meter appearance category code.

The appearance category code for a glucose meter Bluetooth LE device.

Gets the heart rate appearance category code.

The appearance category code for a heart rate Bluetooth LE device.

Gets the human interface device appearance category code.

The appearance category code for a human interface device Bluetooth LE device.

Gets the key ring appearance category code.

The appearance category code for a key ring Bluetooth LE device.

Gets the media player appearance category code.

The appearance category code for a media player Bluetooth LE device.

Gets the outdoor sport activity appearance category code.

The appearance category code for an outdoor sport activity Bluetooth LE device.

Gets the phone appearance category code.

The appearance category code for a phone Bluetooth LE device.

Gets the pulse oximeter appearance category code.

The appearance category code for a pulse oximeter Bluetooth LE device.

Gets the remote control appearance category code.

The appearance category code for a remote control Bluetooth LE device.

Gets the running or walking appearance category code.

The appearance category code for a running or walking Bluetooth LE device.

Gets the tag appearance category code.

The appearance category code for a tag Bluetooth LE device.

Gets the thermometer appearance category code.

The appearance category code for a thermometer Bluetooth LE device.

Gets the uncategorized appearance category code.

The appearance category code for an uncategorized Bluetooth LE device.

Gets the watch appearance category code.

The appearance category code for a watch Bluetooth LE device.

Gets the weight scale appearance category code.

The appearance category code for a weight scale Bluetooth LE device.

Indicates the appearance subcategory code of the Bluetooth LE device. For more info on how sub categories map to categories, see the Bluetooth Specification.

Gets the pulse barcode scanner appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a barcode scanner Bluetooth LE device.

Gets the blood pressure arm appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.BloodPressure appearance category.

The appearance subcategory code for a blood pressure arm Bluetooth LE device.

Gets the blood pressure wrist appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.BloodPressure appearance category.

The appearance subcategory code for a blood pressure wrist Bluetooth LE device.

Gets the card reader appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a card reader Bluetooth LE device.

Gets the cycling cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.Cycling appearance category.

The appearance subcategory code for a cycling cadence sensor Bluetooth LE device.

Gets the cycling computer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.Cycling appearance category.

The appearance subcategory code for a cycling computer Bluetooth LE device.

Gets the cycling power sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.Cycling appearance category.

The appearance subcategory code for a cycling power sensor Bluetooth LE device.

Gets the cycling speed cadence sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.Cycling appearance category.

The appearance subcategory code for a cycling speed cadence sensor Bluetooth LE device.

Gets the cycling speed sensor appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.Cycling appearance category.

The appearance subcategory code for a cycling speed sensor Bluetooth LE device.

Gets the digital pen appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a digital pen Bluetooth LE device.

Gets the digitizer tablet appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a digitizer tablet Bluetooth LE device.

Gets the gamepad appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a gamepad Bluetooth LE device.

Gets the generic appearance subcategory code.

The appearance subcategory code for a generic Bluetooth LE device.

Gets the heart rate belt appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HeartRate appearance category.

The appearance subcategory code for a heart rate belt Bluetooth LE device.

Gets the joystick appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a joystick Bluetooth LE device.

Gets the keyboard appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a keyboard Bluetooth LE device.

Gets the location display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.OutdoorSportActivity appearance category.

The appearance subcategory code for a location display Bluetooth LE device.

Gets the location navigation display appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.OutdoorSportActivity appearance category.

The appearance subcategory code for a location navigation display Bluetooth LE device.

Gets the location navigation pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.OutdoorSportActivity appearance category.

The appearance subcategory code for a location navigation pod Bluetooth LE device.

Gets the location pod appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.OutdoorSportActivity appearance category.

The appearance subcategory code for a location pod Bluetooth LE device.

Gets the mouse appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.HumanInterfaceDevice appearance category.

The appearance subcategory code for a mouse Bluetooth LE device.

Gets the oximeter fingertip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.PulseOximeter appearance category.

The appearance subcategory code for a oximeter fingertip Bluetooth LE device.

Gets the oximeter wrist worn appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.PulseOximeter appearance category.

The appearance subcategory code for a oximeter wrist worn Bluetooth LE device.

Gets the running or walking in shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.RunningWalking appearance category.

The appearance subcategory code for a running or walking in shoe Bluetooth LE device.

Gets the running or walking on hip appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.RunningWalking appearance category.

The appearance subcategory code for a running or walking on hip Bluetooth LE device.

Gets the running or walking on shoe appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.RunningWalking appearance category.

The appearance subcategory code for a running or walking on shoe Bluetooth LE device.

Gets the sports watch appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.RunningWalking appearance category.

The appearance subcategory code for a sports watch Bluetooth LE device.

Gets the ear thermometer appearance subcategory code. This is only applicable for Bluetooth LE devices that are part of the BluetoothLEAppearanceCategories.RunningWalking appearance category.

The appearance subcategory code for a ear thermometer Bluetooth LE device.

Represents a Bluetooth LE device.

Gets the BluetoothLEAppearance object for the Bluetooth LE device.

The appearance for the Bluetooth LE device.

Gets the device address.

The address of the device.

Gets the address type for the Bluetooth LE device.

The address type.

Gets the bluetooth device ID.

The bluetooth device ID.

Gets the connection status of the device.

One of the BluetoothConnectionStatus enumeration values that specifies the connection status of the device.

Gets the DeviceAccessInformation.

Gets the DeviceAccessInformation.

Gets the device Id.

The Id of the device.

Gets the device information for the Bluetooth LE device.

A DeviceInformation object representing the device information.

Gets the read-only list of GATT services supported by the device.

The read-only list of GATT services supported by this Bluetooth LE device.

Gets the name of the Bluetooth LE device.

The name of the Bluetooth LE device.

Gets a boolean indicating whether the BluetoothLEDevice was paired using a Secure Connection.

A boolean indicating whether the BluetoothLEDevice was paired using a Secure Connection.

Occurs when the connection status for the device has changed.

Occurs when the list of GATT services supported by the device has changed.

Occurs when the name of the device has changed.

Closes this Bluetooth LE device. This may close the connection to the device if this is the only app with a connection.

Returns a BluetoothLEDevice object representing the peer Bluetooth LE device with the given address. See **Remarks**.

A BluetoothAddress value containing the 64-bit address of the peer Bluetooth LE device. Returns an object representing an asynchronous operation. When that object completes, it contains a BluetoothLEDevice object representing the peer Bluetooth LE device with the given address.

Returns a BluetoothLEDevice object representing the peer device with the given address and address type. See **Remarks**.

A BluetoothAddress value containing the 64-bit address of the peer Bluetooth LE device. A BluetoothAddressType value containing the address type of the peer Bluetooth LE device. Returns an object representing an asynchronous operation. When that object completes, it contains a BluetoothLEDevice object representing the peer device with the given address and address type.

Returns a BluetoothLEDevice object for the given Id. See **Remarks**.

The Id of the Bluetooth LE device. After the asynchronous operation completes, returns the BluetoothLEDevice object with the given Id.

Gets an Advanced Query Syntax (AQS) string for identifying all Bluetooth Low Energy (LE) devices. This string is passed to the FindAllAsync or CreateWatcher method in order to get a list of Bluetooth LE devices.

The device selector for this device.

Creates an Advanced Query Syntax (AQS) filter string from a BluetoothLEAppearance object. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects with the specified appearance.

The Bluetooth LE appearance used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address that represents a Bluetooth LE device. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.

A 64-bit Bluetooth LE device address used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string from a 64-bit address and address type that represents a Bluetooth LE device. The AQS string is passed into the CreateWatcher method.

A 64-bit Bluetooth LE device address used for constructing the AQS string. The Bluetooth LE device address type. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices with the indicated BluetoothConnectionStatus. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects with the indicated Bluetooth connection status.

The connection status used for constructing the AQS string. An AQS string that can be passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for the Bluetooth LE device name. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects containing the specified Bluetooth LE device name.

The Bluetooth LE device name used for constructing the AQS string. An AQS string that is passed as a parameter to the CreateWatcher method.

Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth LE devices that are either paired or unpaired. The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.

The current pairing state for Bluetooth LE devices used for constructing the AQS string. Bluetooth LE devices can be either paired (true) or unpaired (false). The AQS Filter string will request scanning to be performed when the pairingState is false. An AQS string that can be passed as a parameter to the CreateWatcher method.

Returns the GATT service with the given service Id.

Use GetGattServicesForUuidAsync instead of GetGattService. For more information, see MSDN. The service Id of the GATT service. The GATT service represented by the given service Id.

Gets the GattDeviceServices for this Bluetooth LowEnergy device.

Returns an asynchronous operation that completes with a GattDeviceServicesResult.

Returns the GattDeviceServices for this Bluetooth LowEnergy device with the specified cache mode.

The cache mode. Returns an asynchronous operation that completes with a GattDeviceServicesResult.

Returns the GattDeviceServices for the Bluetooth LowEnergy device with the specified UUID.

The service UUID.

Returns the GattDeviceServices for the Bluetooth LowEnergy device with the specified UUID.

The service UUID. The cache mode. Returns an asynchronous operation that completes with a GattDeviceServicesResult.

Requests access to the Bluetooth LowEnergy device.

Returns an asynchronous operation that completes with a DeviceAccessStatus.

Indicates the Major Class code of the device, which is the general family of device with which the device is associated.

An audio or video device. Example devices are headset, speaker, stereo, video display and VCR.

A computer. Example devices are desktop, notebook, PDA and organizer.

A health device. An example is a heart rate monitor.

An imaging device. Examples are printer, scanner, camera and display.

Used when a more specific Major Class code is not suitable.

A LAN or network Access Point.

A peripheral device. Examples are mouse, joystick and keyboard.

A phone. Example devices are cellular, cordless, pay phone and modem.

A toy.

A wearable device.

Indicates the Minor Class code of the device. These are interpreted in the context of the Major Class codes.

A camcorder.

A car audio device.

A gaming console or toy.

A hands-free device.

Headphones.

A HiFi audio device.

A loudspeaker.

A microphone.

Portable audio device.

A set-top box.

A VCR.

A video camera.

A video conferencing device.

A video display and loudspeaker.

A video monitor.

A wearable headset device.

A computer desktop.

A handheld PC/PDA.

A laptop computer.

A palm-sized PC/PDA.

A computer server.

A tablet computer.

A wearable, watch-sized, computer.

An ankle prosthesis.

A blood pressure monitor.

A body composition analyzer.

A generic health manager.

A glucose meter.

A health data display.

A heart rate or pulse monitor.

A knee prosthesis.

A medication monitor.

A peak flow monitor.

A personal mobility device.

A pulse oximeter.

A step counter.

A thermometer.

A weighing scale.

Fully available.

Network service is not available.

1% to 17% utilized.

17% to 33% utilized.

335 to 50% utilized.

50% to 67% utilized.

67% to 83% utilized.

83% to 99% utilized.

A card reader.

A digital pen.

A digitizer tablet.

A gamepad.

A handheld gesture input device, such as a "wand" form factor device.

A handheld scanner for bar codes, RFID, etc

A joystick.

A remote control.

A sensing device.

A cell phone.

A cordless phone.

Common ISDN access.

A smartphone.

A wired modem or voice gateway.

A controller.

A doll or action figure.

A game.

A robot.

A vehicle.

Use when a Minor Class code has not been assigned.

Glasses.

A helmet.

A jacket.

A pager.

A wristwatch.

Indicates the service capabilities of a device.

Audio, for example, speaker, microphone, headset service.

Capturing, for example, scanner, microphone.

Information, for example, web server, WAP server.

Limited Discoverable Mode.

Networking, for example, LAN, Ad hoc.

None.

Object Transfer, for example, v-Inbox, v-folder.

Positioning or location identification.

Rendering, for example, printer, speakers.

Telephony, for example cordless, modem, headset service.

Groups parameters used to configure received signal strength indicator (RSSI)-based filtering.

Create a new BluetoothSignalStrengthFilter object.

The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be propagated or considered in range if the previous events were considered out of range.

The minimum RSSI value in dBm on which RSSI events will be propagated or considered in range.

The minimum received signal strength indicator (RSSI) value in dBm on which RSSI events will be considered out of range.

The minimum RSSI value in dBm on which RSSI events will be considered out of range.

The timeout for a received signal strength indicator (RSSI) event to be considered out of range.

The timeout for an RSSI event to be considered out of range.

The interval at which received signal strength indicator (RSSI) events are sampled.

The interval at which RSSI events are sampled.

A helper class that provides methods to convert between bluetooth device UUID and short ID.

Returns the bluetooth device UUID from a short ID.

The short ID. Returns the UUID.

Attempts to get the short bluetooth device ID from a UUID.

The UUID. Returns the short ID.

A representation of a Bluetooth LE advertisement payload.

Creates a new BluetoothLEAdvertisement object.

Gets the list of raw data sections.

The list of raw data sections.

Bluetooth LE advertisement flags.

Bluetooth LE advertisement flags.

The local name contained within the advertisement.

The local name contained within the advertisement. This property can be either the shortened or complete local name defined by the Bluetooth LE specifications.

Gets the list of manufacturer-specific data sections in a BluetoothLEAdvertisement.

The list of manufacturer-specific data sections.

Gets the list of service UUIDs (in 128-bit GUID format) in a BluetoothLEAdvertisement.

An IVector of GUID, representing the list of service UUIDs in 128-bit GUID format. This property aggregates all the 16-bit, 32-bit, and 128-bit service UUIDs into a single list.

Return a list of all manufacturer data sections in the BluetoothLEAdvertisement payload matching the specified company ID.

The company identifier code defined by the Bluetooth Special Interest Group (SIG). A vector of BluetoothLEManufacturerData contained within the payload.

Return a list of advertisement data sections that matches a given advertisement section type in a BluetoothLEAdvertisement.

The advertisement section type A vector of all the BluetoothLEAdvertisementDataSection matching the given advertisement type. This method returns an empty list if no such sections are found in the payload.

A Bluetooth LE advertisement byte pattern for filters to match.

Create a new BluetoothLEAdvertisementBytePattern object.

Create a new BluetoothLEAdvertisementBytePattern object with an advertisement data type to match, the advertisement data byte pattern to match, and the offset of the byte pattern from the beginning of the advertisement data section.

The Bluetooth LE advertisement data type to match. The offset of byte pattern from beginning of advertisement data section. The Bluetooth LE advertisement data byte pattern to match.

The Bluetooth LE advertisement data byte pattern to match.

The Bluetooth LE advertisement data byte pattern to match.

The Bluetooth LE advertisement data type defined by the Bluetooth Special Interest Group (SIG) to match.

The Bluetooth LE advertisement data type to match.

The offset of byte pattern from beginning of advertisement data section.

The offset of byte pattern from beginning of advertisement data section.

A Bluetooth LE advertisement section. A Bluetooth LE advertisement packet can contain multiple instances of these BluetoothLEAdvertisementDataSection objects.

Creates a new BluetoothLEAdvertisementDataSection object.

Creates a new BluetoothLEAdvertisementDataSection object with the Bluetooth LE advertisement data type and the payload.

The Bluetooth LE advertisement data type as defined by the Bluetooth Special Interest Group (SIG). The Bluetooth LE advertisement data payload.

The Bluetooth LE advertisement data payload.

The Bluetooth LE advertisement data payload.

Gets or sets the Bluetooth LE advertisement data type, as defined by the Bluetooth Special Interest Group (SIG). See Assigned numbers and GAP.

The Bluetooth LE advertisement data type.

Some of the Bluetooth LE advertisement types defined in the Generic Access Profile (GAP) by the Bluetooth Special Interest Group (SIG).

Section data type for the Bluetooth LE advertising interval.

The Bluetooth LE advertising interval.

Section data type for the Bluetooth LE advertising appearance.

The Bluetooth LE advertising appearance.

Section data type for the Bluetooth LE complete local name.

The Bluetooth LE complete local name.

Section data type for the complete list of 128-bit Bluetooth LE service UUIDs

The complete list of 128-bit Bluetooth LE service UUIDs

Section data type for the complete list of 16-bit Bluetooth LE service UUIDs

The complete list of 16-bit Bluetooth LE service UUIDs

Section data type for the complete list of 32-bit Bluetooth LE service UUIDs

The complete list of 32-bit Bluetooth LE service UUIDs

Section data type for a set of flags for internal use.

A set of flags for internal use.

Section data type for an incomplete list of 128-bit Bluetooth LE service UUIDs.

An incomplete list of 128-bit Bluetooth LE service UUIDs.

Section data type for an incomplete list of 16-bit Bluetooth LE service UUIDs.

An incomplete list of 16-bit Bluetooth LE service UUIDs.

Section data type for an incomplete list of 32-bit Bluetooth LE service UUIDs.

An incomplete list of 32-bit Bluetooth LE service UUIDs.

Section data type for manufacturer-specific data for a Bluetooth LE advertisements.

Manufacturer-specific data for a Bluetooth LE advertisements.

Section data type for a list of public Bluetooth LE target addresses.

A list of public Bluetooth LE target addresses.

Section data type for a list of random Bluetooth LE target addresses.

A list of random Bluetooth LE target addresses.

Section data type for service data for 128-bit Bluetooth LE UUIDs.

Service data for 128-bit Bluetooth LE UUIDs.

Section data type for service data for 16-bit Bluetooth LE UUIDs.

Service data for 16-bit Bluetooth LE UUIDs.

Section data type for service data for 32-bit Bluetooth LE UUIDs..

Service data for 32-bit Bluetooth LE UUIDs.

Section data type for a list of 128-bit Bluetooth LE service solicitation UUIDs.

A list of 128-bit Bluetooth LE service solicitation UUIDs.

Section data type for a list of 16-bit Bluetooth LE service solicitation UUIDs.

A list of 16-bit Bluetooth LE service solicitation UUIDs.

Section data type for a list of 32-bit Bluetooth LE service solicitation UUIDs.

A list of 32-bit Bluetooth LE service solicitation UUIDs.

Section data type for a shortened local name.

A shortened local name.

Section data type for the slave connection interval range.

The slave connection interval range.

Section data type for the Bluetooth LE transmit power level.

The Bluetooth LE transmit power level.

Groups parameters used to configure payload-based filtering of received Bluetooth LE advertisements.

Creates a new BluetoothLEAdvertisementFilter object.

A BluetoothLEAdvertisement object that can be applied as filters to received Bluetooth LE advertisements.

A BluetoothLEAdvertisement object that can be applied as filters to received Bluetooth LE advertisements.

Gets a vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement.

A vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement.

Defines constants that specify flags used to match flags contained inside a Bluetooth LE advertisement payload.

Specifies Bluetooth BR/EDR not supported.

Specifies simultaneous Bluetooth LE and BR/EDR to same device capable (controller).

Specifies simultaneous Bluetooth LE and BR/EDR to same device capable (host)

Specifies Bluetooth LE General Discoverable Mode.

Specifies Bluetooth LE Limited Discoverable Mode.

Specifies no flag.

An object to send Bluetooth Low Energy (LE) advertisements.

Creates a new BluetoothLEAdvertisementPublisher object.

Creates a new BluetoothLEAdvertisementPublisher object with the Bluetooth LE advertisement to publish.

The Bluetooth LE advertisement to publish.

Gets a copy of the Bluetooth LE advertisement to publish.

A copy of the Bluetooth LE advertisement to publish.

Specifies whether the transmit power level is included in the advertisement header. Defaults to False.

Indicates whether the transmit power level is included. The default value is False.

Specifies whether or not the device address is included in the advertisement header. By default, the address is included.

Indicates whether the device address is hidden. The default value is False, indicating that the address is included.

If specified, requests that the radio use the indicated transmit power level for the advertisement. Defaults to Null.

The requested power level for the radio transmission. The default is Null.

Gets the current status of the BluetoothLEAdvertisementPublisher.

The current status of the BluetoothLEAdvertisementPublisher.

Specifies that the advertisement publisher should use the Extended Advertising format.

Indicates whether or not the Extended Advertising format should be used. The default value is False.

Notification that the status of the BluetoothLEAdvertisementPublisher has changed.

Start advertising a Bluetooth LE advertisement payload.

Stop the publisher and stop advertising a Bluetooth LE advertisement payload.

Represents the possible states of the BluetoothLEAdvertisementPublisher.

The publisher is aborted due to an error.

The initial status of the publisher.

The publisher is being serviced and has started advertising.

The publisher has stopped advertising.

The publisher was issued a stop command.

The publisher is waiting to get service time.

Provides data for a StatusChanged event on a BluetoothLEAdvertisementPublisher.

Gets the error status for a StatusChanged event on a BluetoothLEAdvertisementPublisher.

The error status for a StatusChanged event on a BluetoothLEAdvertisementPublisher.

Represents the current transmit power selected by the Bluetooth adapter for the advertisement.

The current transmit power selected. If the Extended Advertisement format is not supported by the adapter, this instead represents the adapter's default transmit power level.

Gets the new status of the BluetoothLEAdvertisementPublisher.

The new status of the BluetoothLEAdvertisementPublisher.

Provides data for a Received event on a BluetoothLEAdvertisementWatcher. A BluetoothLEAdvertisementReceivedEventArgs instance is created when the Received event occurs on a BluetoothLEAdvertisementWatcher object.

Gets the Bluetooth LE advertisement payload data received.

The Bluetooth LE advertisement payload data received.

Gets the type of the received Bluetooth LE advertisement packet.

the type of the received Bluetooth LE advertisement packet.

Gets the Bluetooth address of the device sending the Bluetooth LE advertisement.

the Bluetooth address of the device sending the Bluetooth LE advertisement.

Retrieves the Bluetooth Address Type of the received advertisement.

The Bluetooth Address Type of the advertisement. If the advertisement is anonymous, the type returned is `Unspecified`.

Indicates whether a Bluetooth Address was omitted from the received advertisement.

Indicates whether the advertisement was sent anonymously.

Indicates whether the received advertisement is connectable.

Indicates whether the advertisement is connectable. Returns True if it is, otherwise, returns False.

Indicates whether the received advertisement is directed.

Indicates whether the advertisement is directed. Returns True if it is, otherwise, returns False.

Indicates whether the received advertisement is scannable.

Indicates whether the advertisement is scannable. Returns True if it is, otherwise, returns False.

Indicates whether the received advertisement is a scan response.

Indicates whether the advertisement is a scan response. Returns True if it is, otherwise, returns False.

Gets the received signal strength indicator (RSSI) value, in dBm, for this received Bluetooth LE advertisement event. This value could be the raw RSSI or a filtered RSSI depending on filtering settings configured through BluetoothSignalStrengthFilter.

The received signal strength indicator (RSSI) value, in dBm, for this event.

Gets the timestamp when the Received event occurred.

The timestamp when the Received event occurred.

Represents the received transmit power of the advertisement.

The received transmit power of the advertisement. Ranges from -127 dBm to 20dBM.

Specifies the different types of Bluetooth LE advertisement payloads.

The advertisement is directed and indicates that the device is connectable but not scannable. This advertisement type cannot carry data.

The advertisement is undirected and indicates that the device is connectable and scannable. This advertisement type can carry data.

This advertisement is a 5.0 extended advertisement. This advertisement type may have different properties, and is not necessarily directed, connected, scannable, nor a scan response.

The advertisement is undirected and indicates that the device is not connectable nor scannable. This advertisement type can carry data.

The advertisement is undirected and indicates that the device is scannable but not connectable. This advertisement type can carry data.

This advertisement is a scan response to a scan request issued for a scannable advertisement. This advertisement type can carry data.

An object to receive Bluetooth Low Energy (LE) advertisements.

Creates a new BluetoothLEAdvertisementWatcher object.

Creates a new BluetoothLEAdvertisementWatcher object with an advertisement filter to initialize the watcher.

The advertisement filter to initialize the watcher.

Gets or sets a BluetoothLEAdvertisementFilter object used for configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering.

Configuration of Bluetooth LE advertisement filtering that uses payload section-based filtering.

Enables reception of advertisements using the Extended Advertising format. Defaults to False.

Indicates whether advertisements of the Extended Advertising format can be received. The default value is False.

Gets the maximum out of range timeout.

The maximum out of range timeout.

Gets the maximum sampling interval.

The maximum sampling interval.

Gets the minimum out of range timeout.

The minimum out of range timeout.

Gets the minimum sampling interval.

The minimum sampling interval.

Gets or sets the Bluetooth LE scanning mode.

The Bluetooth LE scanning mode.

Gets or sets a BluetoothSignalStrengthFilter object used for configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

Configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

Gets the current status of the BluetoothLEAdvertisementWatcher.

The current status of the BluetoothLEAdvertisementWatcher.

Notification for new Bluetooth LE advertisement events received.

Notification to the app that the Bluetooth LE scanning for advertisements has been cancelled or aborted either by the app or due to an error.

Start the BluetoothLEAdvertisementWatcher to scan for Bluetooth LE advertisements.

Stop the BluetoothLEAdvertisementWatcher and disable the scanning for Bluetooth LE advertisements.

Represents the possible states of the BluetoothLEAdvertisementWatcher.

An error occurred during transition or scanning that stopped the watcher due to an error.

The initial status of the watcher.

The watcher is started.

The watcher is stopped.

The watcher stop command was issued.

Provides data for a Stopped event on a BluetoothLEAdvertisementWatcher. A BluetoothLEAdvertisementWatcherStoppedEventArgs instance is created when the Stopped event occurs on a BluetoothLEAdvertisementWatcher object.

Gets the error status for Stopped event.

The error status for Stopped event.

A Bluetooth LE manufacturer-specific data section (one particular type of LE advertisement section). A Bluetooth LE advertisement packet can contain multiple instances of these BluetoothLEManufacturerData objects.

Creates a new BluetoothLEManufacturerData object.

Creates a new BluetoothLEManufacturerData object with a company identifier code and manufacterer-specific section data.

The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG). Bluetooth LE manufacturer-specific section data.

The Bluetooth LE company identifier code as defined by the Bluetooth Special Interest Group (SIG).

The Bluetooth LE company identifier code.

Bluetooth LE manufacturer-specific section data.

Bluetooth LE manufacturer-specific section data.

Defines constants that specify a Bluetooth LE scanning mode.

Specifies an active scanning mode. This indicates that scan request packets will be sent from the platform to actively query for more advertisement data of type BluetoothLEAdvertisementType.ScanResponse.

Specifies no scanning mode. The watcher will provide advertisements as the system receives them, but will not initiate its own scanning.

Specifies a passive scanning mode. This is the default scanning mode.

This enumeration represents a Bluetooth background event triggering mode.

The triggering mode is batch.

The triggering mode is keep latest.

The triggering method is serial.

Provides information about a BluetoothLEAdvertisementPublisher trigger. You can obtain an instance of this class through a BluetoothLEAdvertisementPublisher trigger.

Gets the error status for the trigger.

The error status for the trigger.

Represents the current transmit power selected by the Bluetooth adapter for the advertisement.

The current transmit power selected. If the Extended Advertisement format is not supported by the adapter, this instead represents the adapter's default transmit power level.

Gets the current status of the BluetoothLEAdvertisementPublisher.

The current status of the BluetoothLEAdvertisementPublisher.

Provides information about a BluetoothLEAdvertisementWatcher trigger. You can obtain an instance of this class through a BluetoothLEAdvertisementWatcher trigger.

Gets a collection of Bluetooth LE advertisements.

A collection of Bluetooth LE advertisements.

Gets the error status for the trigger.

The error status for the trigger.

Gets the parameters used to configure received signal strength indicator (RSSI)-based filtering.

The parameters used to configure received signal strength indicator (RSSI)-based filtering.

Provides information about the Bluetooth LE device that caused this trigger to fire.

Gets the GATT characteristic that changed.

The GATT characteristic that changed.

Gets the error status for the trigger.

Gets the error status for the trigger.

Gets the event trigger mode.

Gets the event trigger mode.

Gets a byte stream containing the new value of the characteristic.

A byte stream containing the new value of the characteristic.

Gets the value changes events for this trigger.

Gets the value changes events for this trigger.

This class represents a gatt service provider connection.

Gets all the services.

Gets all the services.

Gets the local GATT service.

Gets the local GATT service.

Gets GATT service connection trigger ID.

Gets GATT service connection trigger ID.

Starts a GATT service provider connection.

Provides information about the Bluetooth device that caused this trigger to fire.

Gets the connection that triggered the event.

Gets the connection that triggered the event.

Provides information about the Bluetooth device that caused this trigger to fire.

Gets whether this is an incoming connection.

True if the trigger was fired for an incoming connection; otherwise, false.

Gets the BluetoothDevice object that represents the remote device.

The BluetoothDevice object that represents the remote device.

Gets a reference to the underlying StreamSocket of this connection.

A reference to the underlying StreamSocket of this connection.

Provides information about incoming RFCOMM connections. If an app wants the system to listen for incoming connections on behalf of an RfcommConnectionTrigger, the app must create this object and attach it to the RfcommConnectionTrigger.

Gets or sets the service UUID that will be advertised in the SDP record.

The service UUID that will be advertised in the SDP record.

Gets or sets the Bluetooth SDP record that the system will advertise on behalf of the app.

The Bluetooth SDP record that the system will advertise on behalf of the app.

Gets or sets the service capabilities that will be advertised.

One of the BluetoothServiceCapabilities enumeration values that specifies the service capabilities to be advertised.

Provides information for RFCOMM outbound connections. If an app wants the system to create outbound connections on its behalf, the app must create this object and attach it to the RfcommConnectionTrigger.

Gets or sets the service UUID of the remote service to which the system will connect on behalf of the app.

The service UUID of the remote service to which the system will connect on behalf of the app. This value must be set. When the system creates outgoing connections for the app, it will connect to any remote service that lists the specified UUID in its ServiceClassIDList.

Represents a Characteristic of a GATT service. The GattCharacteristic object represents a GATT Characteristic of a particular service, and is obtained from the Characteristics property of the GattDeviceService object.

Gets the handle used to uniquely identify GATT-based characteristic attributes as declared on the Bluetooth LE device.

Handle that uniquely identifies GATT-based characteristic attributes.

Gets the GATT characteristic properties, as defined by the GATT profile.

The GATT characteristic properties, as defined by the GATT profile.

Gets the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor.

An array of GattPresentationFormat objects that contain the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor.

Gets or sets the desired GATT security options for over the air communication with the device.

The desired GATT security options for over the air communication with the device.

Gets the GattDeviceService of which this characteristic is a member.

The GattDeviceService of which this characteristic is a member.

Get the user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string.

The user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string.

Gets the GATT Characteristic UUID for this GattCharacteristic.

The GATT Characteristic UUID for this GattCharacteristic.

An App can register an event handler in order to receive events when notification or indications are received from a device, after setting the Client Characteristic Configuration Descriptor.

Converts a Bluetooth SIG defined short Id to a full GATT UUID.

Use BluetoothUuidHelper instead of ConvertShortIdToUuid. For more information, see MSDN. A 16-bit Bluetooth GATT Service UUID. The corresponding 128-bit GATT Characteristic UUID, that uniquely identifies this characteristic.

Gets the collection of all descriptors belonging to this GattCharacteristic instance.

Use GetDescriptorsAsync instead of GetAllDescriptors. For more information, see MSDN. The collection of all descriptors belonging to this GattCharacteristic instance.

Returns a vector of descriptors, that are identified by the specified UUID, and belong to this GattCharacteristic instance.

Use GetDescriptorsForUuidAsync instead of GetDescriptors. For more information, see MSDN. The UUID for the descriptors to be retrieved. A vector of descriptors whose UUIDs match descriptorUuid.

Returns the descriptors for this GattCharacteristic instance.

An asynchronous operation that completes with the descriptors for this GattCharacteristic instance.

Returns the descriptors with the specified cache mode for this GattCharacteristic instance.

The cache mode. An asynchronous operation that completes with the descriptors.

Returns the descriptors whose UUIDs match descriptorUuid.

The UUID for the descriptors to be retrieved. An asynchronous operation that completes with the descriptors whose UUIDs match descriptorUuid.

Returns the descriptors whose UUIDs match descriptorUuid with the specified cacheMode.

The UUID for the descriptors to be retrieved. The cache mode. Returns an asynchronous operation that completes with the descriptors for the descriptorUuid.

Reads the current value of the ClientCharacteristicConfigurationDescriptor.

The object that manages the asynchronous operation. Upon completion of the asynchronous method, the IAsyncOperation(GattReadClientCharacteristicConfigurationDescriptorResult) contains the result of the read operation, which contains the status of completed operation. The Status property on the GattReadClientCharacteristicConfigurationDescriptorResult returned indicates if the result of the operation was successful.

Performs a Characteristic Value read from the value cache maintained by Windows.

The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device.

Performs a Characteristic Value read either from the value cache maintained by Windows, or directly from the device.

Specifies whether to read the value directly from the device or from a value cache maintained by Windows. The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device.

Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device.

Specifies a new value for the ClientCharacteristicConfigurationDescriptor of this Characteristic object. The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed.

Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device.

Specifies a new value for the ClientCharacteristicConfigurationDescriptor of this Characteristic object. Returns an asynchronous operation that completes with a GattWriteResult object.

Performs a Characteristic Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed.

Performs a Characteristic Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. Specifies what type of GATT write should be performed. The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed.

Performs a Characteristic Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. An asynchronous operation that completes with a GattWriteResult object.

Performs a Characteristic Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. Specifies what type of GATT write should be performed. An asynchronous operation that completes with a GattWriteResult object.

Specifies the values for the GATT characteristic properties as well as the GATT Extended Characteristic Properties Descriptor.

The characteristic supports signed writes

The characteristic supports broadcasting

The ExtendedProperties Descriptor is present

The characteristic is indicatable

The characteristic doesn’t have any properties that apply.

The characteristic is notifiable

The characteristic is readable

The characteristic supports reliable writes

The characteristic has writable auxiliaries

The characteristic is writable

The characteristic supports Write Without Response

Contains the result of GetCharacteristicsForUuidAsync and GetCharacteristicsAsync

Gets the characterisitics.

The characteristics.

Gets the protocol error, if there is one.

The protocol error.

Gets the status.

The status.

Represents an enumeration of the most well known Characteristic UUID values, and provides convenience methods for working with GATT characteristic UUIDs, and static properties providing characteristic UUIDs for common GATT characteristics.

Gets the Bluetooth SIG-defined AlertCategoryId characteristic UUID.

The Bluetooth SIG-defined AlertCategoryId characteristic UUID.

Gets the Bluetooth SIG-Defined AlertCategoryIdBitMask characteristic UUID. To view a list of all Bluetooth SIG-defined characteristic UUIDs, see Bluetooth SIG-defined Characteristic UUIDs.

The Bluetooth SIG-defined AlertCategoryIdBitMask characteristic UUID.

Gets the Bluetooth SIG-defined AlertLevel characteristic UUID.

The Bluetooth SIG-defined AlertLevel characteristic UUID.

Gets the Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID.

The Bluetooth SIG-defined AlertNotificationControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined AlertStatus characteristic UUID.

The Bluetooth SIG-defined AllertStatus characteristic UUID.

Gets the Bluetooth SIG-defined Battery Level Characteristic UUID.

The Bluetooth SIG-defined Battery Level Characteristic UUID.

Gets the Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID.

The Bluetooth SIG-defined Blood Pressure Feature Characteristic UUID.

Gets the Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID.

The Bluetooth SIG-defined Blood Pressure Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined Body Sensor Location Characteristic UUID.

The Bluetooth SIG-defined Body Sensor Location Characteristic UUID.

Gets the Bluetooth SIG-defined BootKeyboardInputReport characteristic UUID.

The Bluetooth SIG-defined BootKayboardInputReport characteristic UUID.

Gets the Bluetooth SIG-defined BootKeyboardOutputReport characteristic UUID.

The Bluetooth SIG-defined characteristic UUID.

Gets the Bluetooth SIG-defined BootMouseInputReport characteristic UUID.

The Bluetooth SIG-defined BootMouseInputReport characteristic UUID.

Gets the Bluetooth SIG-defined Csc Feature Characteristic UUID.

The Bluetooth SIG-defined Csc Feature Characteristic UUID.

Gets the Bluetooth SIG-defined Csc Measurement Characteristic UUID.

The Bluetooth SIG-defined Csc Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined CurrentTime characteristic UUID.

The Bluetooth SIG-defined CurrentTime characteristic UUID.

Gets the Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID.

The Bluetooth SIG-defined CyclingPowerControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined CyclingPowerFeature characteristic UUID.

The Bluetooth SIG-defined CyclingPowerFeature characterisitc UUID.

Gets the Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID.

The Bluetooth SIG-defined CyclingPowerMeasurement characteristic UUID.

Gets the Bluetooth SIG-defined CyclingPowerVector characteristic UUID.

The Bluetooth SIG-defined CyclingPowerVector characteristic UUID.

Gets the Bluetooth SIG-defined DateTime characteristic UUID.

The Bluetooth SIG-defined DateTime characteristic UUID.

Gets the Bluetooth SIG-defined DayDateTime characteristic UUID.

The Bluetooth SIG-defined DayDateTime characteristic UUID.

Gets the Bluetooth SIG-defined DayOfWeek characteristic UUID.

The Bluetooth SIG-defined DayOfWeek characteristic UUID.

Gets the Bluetooth SIG-defined DstOffset characteristic UUID.

The Bluetooth SIG-defined DstOffset characteristic UUID.

Gets the Bluetooth SIG-defined ExactTime256 characteristic UUID.

The Bluetooth SIG-defined ExactTime256 characteristic UUID.

Gets the Bluetooth SIG-defined FirmwareRevisionString characteristic UUID.

The Bluetooth SIG-defined FirmwareRevisionString characteristic UUID.

Gets the Bluetooth SIG-defined GapAppearance characteristic UUID.

The Bluetooth SIG-defined GapAppearance characteristic UUID.

Gets the Bluetooth SIG-defined GapDeviceName characteristic UUID.

The Bluetooth SIG-defined GapDeviceName characteristic UUID.

Gets the Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID.

The Bluetooth SIG-defined GapPeripheralPreferredConnectionParameters characteristic UUID.

Gets the Bluetooth GapPeripheralPrivacyFlag characterisitc UUID.

The Bluetooth GapPeripheralPrivacyFlag characteristic UUID.

Gets the Bluetooth SIG-defined GapReconnectionAddress characteristic UUID.

The Bluetooth SIG-defined GapReconnectionAddress characteristic UUID.

Gets the Bluetooth SIG-defined GattServiceChanged characteristic UUID.

The Bluetooth SIG-defined GattServiceChanged characteristic UUID.

Gets the Bluetooth SIG-defined Glucose Feature Characteristic UUID.

The Bluetooth SIG-defined Glucose Feature Characteristic UUID.

Gets the Bluetooth SIG-defined Glucose Measurement Characteristic UUID.

The Bluetooth SIG-defined Glucose Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID.

The Bluetooth SIG-defined Glucose Measurement Context Characteristic UUID.

Gets the Bluetooth SIG-defined HardwareRevisionString characterisitc UUID.

The Bluetooth SIG-defined HardwareRevisionString characteristic UUID.

Gets the Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID.

The Bluetooth SIG-defined Heart Rate Control Point Characteristic UUID.

Gets the Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID.

The Bluetooth SIG-defined Heart Rate Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined HidControlPoint characteristic UUID.

The Bluetooth SIG-defined HidControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined HidInformation characteristic UUID.

The Bluetooth SIG-defined HidInformation characteristic UUID.

Gets the Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID.

The Bluetooth SIG-defined Ieee1107320601RegulatoryCertificationDataList characteristic UUID.

Gets the Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID.

The Bluetooth SIG-defined Intermediate Cuff Pressure Characteristic UUID.

Gets the Bluetooth SIG-defined Intermediate Temperature Characteristic UUID.

The Bluetooth SIG-defined Intermediate Temperature Characteristic UUID.

Gets the Bluetooth SIG-defined LnControlPoint characteristic UUID.

The Bluetooth SIG-defined LnControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined LnFeature characteristic UUID.

The Bluetooth SIG-defined LnFeature characteristic UUID.

Gets the Bluetooth SIG-defined LocalTimeInformation characteristic UUID.

The Bluetooth SIG-defined LocalTimeInformation characteristic UUID.

Gets the Bluetooth SIG-defined LocationAndSpeed characteristic UUID.

The Bluetooth SIG-defined LocationAndSpeed characteristic UUID.

Gets the Bluetooth SIG-defined ManufacturerNameString characteristic UUID.

The Bluetooth SIG-defined ManufacturerNameString characteristic UUID.

Gets the Bluetooth SIG-defined Measurement Interval Characteristic UUID.

The Bluetooth SIG-defined Measurement Interval Characteristic UUID.

Gets the Bluetooth SIG-defined ModelNumberString UUID.

The Bluetooth SIG-defined ModelNumberString UUID.

Gets the Bluetooth SIG-defined Navigation characteristic UUID.

The Bluetooth SIG-defined Navigation characteristic UUID.

Gets the Bluetooth SIG-defined NewAlert characteristic UUID.

The Bluetooth SIG-defined NewAlert characteristic UUID.

Gets the Bluetooth SIG-defined PnpId characteristic UUID.

The Bluetooth SIG-defined PnpId characteristic UUID.

Gets the Bluetooth SIG-defined PositionQuality characteristic UUID.

The Bluetooth SIG-defined PositionQuality characteristic UUID.

Gets the Bluetooth SIG-defined ProtocolMode characteristic UUID.

The Bluetooth SIG-defined ProtocolMode characteristic UUID.

Gets the Bluetooth SIG-defined Record Access Control Point Characteristic UUID.

The Bluetooth SIG-defined Record Access Control Point Characteristic UUID.

Gets the Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID.

The Bluetooth SIG-defined ReferenceTimeInformation characteristic UUID.

Gets the Bluetooth SIG-defined Report characteristic UUID.

The Bluetooth SIG-defined Report characteristic UUID.

Gets the Bluetooth SIG-defined ReportMap characteristic UUID.

The Bluetooth SIG-defined ReportMap characteristic UUID.

Gets the Bluetooth SIG-defined RingerControlPoint characteristic UUID.

The Bluetooth SIG-defined RingerControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined RingerSetting characteristic UUID.

The Bluetooth SIG-defined RingerSetting characteristic UUID.

Gets the Bluetooth SIG-defined Rsc Feature Characteristic UUID.

The Bluetooth SIG-defined Rsc Feature Characteristic UUID.

Gets the Bluetooth SIG-defined Rsc Measurement Characteristic UUID.

The Bluetooth SIG-defined Rsc Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined ScanIntervalWindow characteristic UUID.

The Bluetooth SIG-defined ScanIntervalWindow characteristic UUID.

Gets the Bluetooth SIG-defined ScanRefresh characteristic UUID.

The Bluetooth SIG-defined ScanRefresh characteristic UUID.

Gets the Bluetooth SIG-defined SC Control Point Characteristic UUID.

The Bluetooth SIG-defined SC Control Point Characteristic UUID.

Gets the Bluetooth SIG-defined Sensor Location Characteristic UUID.

The Bluetooth SIG-defined Sensor Location Characteristic UUID.

Gets the Bluetooth SIG-defined SerialNumberString characteristic UUID.

The Bluetooth SIG-defined SerialNumberString characteristic UUID.

Gets the Bluetooth SIG-defined SoftwareRevisionString characteristic UUID.

The Bluetooth SIG-defined SoftwareRevisionString characteristic UUID.

Gets the Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID.

The Bluetooth SIG-defined SupportedNewAlertCategory characteristic UUID.

Gets the Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID.

The Bluetooth SIG-defined SupportUnreadAlertCategory characteristic UUID.

Gets the Bluetooth SIG-defined SystemId characteristic UUID.

The Bluetooth SIG-defined SystemId characteristic UUID.

Gets the Bluetooth SIG-defined Temperature Measurement Characteristic UUID.

The Bluetooth SIG-defined Temperature Measurement Characteristic UUID.

Gets the Bluetooth SIG-defined Temperature Type Characteristic UUID.

The Bluetooth SIG-defined Temperature Type Characteristic UUID.

Gets the Bluetooth SIG-defined TimeAccuracy characteristic UUID.

The Bluetooth SIG-defined TimeAccuracy characteristic UUID.

Gets the Bluetooth SIG-defined TimeSource characteristic UUID.

The Bluetooth SIG-defined TimeSource characteristic UUID.

Gets the Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID.

The Bluetooth SIG-defined TimeUpdateControlPoint characteristic UUID.

Gets the Bluetooth SIG-defined TimeUpdateState characteristic UUID.

The Bluetooth SIG-defined TimeUpdateState characteristic UUID.

Gets the Bluetooth SIG-defined TimeWithDst characteristic UUID.

The Bluetooth SIG-defined TimeWithDst characteristic UUID.

Gets the Bluetooth SIG-defined TimeZone characteristic UUID.

The Bluetooth SIG-defined TimeZone characteristic UUID.

Gets the Bluetooth SIG-defined TxPowerLevel characteristic UUID.

The Bluetooth SIG-defined TxPowerLevel characteristic UUID.

Gets the Bluetooth SIG-defined UnreadAlertStatus characteristic UUID.

The Bluetooth SIG-defined UnreadAlertStatus characteristic UUID.

Represents the value of the GATT ClientCharacteristicConfigurationDescriptor.

Characteristic indications are enabled.

Neither notification nor indications are enabled.

Characteristic notifications are enabled.

The result of NotifyValueAsync

Gets the bytes that were sent.

The bytes that were sent.

Gets the protocol error.

The protocol error.

Gets the GATT communication status.

The GATT communication status.

Gets the subscribed client.

The subscribed client.

Represents the return status of a WinRT GATT API related Async operation.

Access is denied.

There was a GATT communication protocol error.

The operation completed successfully.

No communication can be performed with the device, at this time.

Represents a Descriptor of a GATT Characteristic. The GattDescriptor object represents a GATT Descriptor of a particular characteristic, and is obtained from the Descriptors property of the GattCharacteristic object.

Gets the GATT Attribute handle used to uniquely identify this attribute on the GATT Server Device.

Handle that uniquely identifies this attribute on the GATT Server Device.

Gets or sets the desired GATT security options for over the air communication with the device.

The desired GATT security options for over the air communication with the device.

Gets the GATT Descriptor UUID for this GattDescriptor.

The GATT Descriptor UUID for this GattDescriptor.

Converts a Bluetooth SIG defined short Id to a full GATT UUID.

Use BluetoothUuidHelper instead of ConvertShortIdToUuid. For more information, see MSDN. A 16-bit Bluetooth GATT Descriptor UUID. The corresponding 128-bit GATT Descriptor UUID, that uniquely identifies this descriptor.

Performs a Descriptor Value read from a value cache maintained by Windows.

The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device.

Performs a Descriptor Value read either from the value cache maintained by Windows, or directly from the device.

Specifies whether to read the value directly from the device or from a value cache maintained by Windows. The object required to manage the asynchronous operation, which, upon completion, returns a GattReadResult object, which in turn contains the completion status of the asynchronous operation and, if successful, the data read from the device.

Performs a Descriptor Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. The object that manages the asynchronous operation, which, upon completion, returns the status with which the operation completed.

Performs a Descriptor Value write to a Bluetooth LE device.

A Windows.Storage.Streams.IBuffer object which contains the data to be written to the Bluetooth LE device. An asynchronous operation that completes with the result.

The result of descriptor operations like GattCharacteristic.GetDescriptorsAsync

Gets a vector of the GATT descriptors.

A vector of the GATT descriptors.

Gets the GATT protocol error.

The GATT protocol error.

Gets the status of the operation.

The status of the operation.

Represents an enumeration of the most well known Descriptor UUID values, and provides convenience methods for working with GATT descriptor UUIDs, and static properties providing descriptor UUIDs for common GATT descriptors.

Gets the Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID.

The Bluetooth SIG-defined Characteristic Aggregate Format Descriptor UUID.

Gets the Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID.

The Bluetooth SIG-defined Characteristic Extended Properties Descriptor UUID.

Gets the Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID.

The Bluetooth SIG-defined Characteristic Presentation Format Descriptor UUID.

Gets the Bluetooth SIG-defined Characteristic User Description Descriptor UUID.

The Bluetooth SIG-defined Characteristic User Description Descriptor UUID.

Gets the Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID.

The Bluetooth SIG-defined Client Characteristic Configuration Descriptor UUID.

Gets the Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID.

The Bluetooth SIG-defined Server Characteristic Configuration Descriptor UUID.

Represents a GATT Primary Service on a Bluetooth device. The GattDeviceService class represents a GATT service on a Bluetooth LE device. It is instantiated by using a device service instance path, obtained by finding a device using the Windows.Devices.Enumeration API.

Gets the handle used to uniquely identify GATT-based service attributes as declared on the Bluetooth LE device.

Handle to uniquely identify GATT-based service attributes.

Gets the BluetoothLEDevice object describing the device associated with the current GattDeviceService object.

The BluetoothLEDevice object describing the device associated with the current GattDeviceService object.

Gets the device access information associated with the current GattDeviceService object.

The device access information associated with the current GattDeviceService object.

Get the string that represents the GATT service instance path used to instantiate the GattDeviceService.

String that represents the GATT service instance path used to instantiate the GattDeviceService.

Gets the read-only list of parent services for this service.

A read-only list of parent services from which this object is derived, if this GattDeviceService is an included service; Otherwise, null.

Gets the session for this GATT device service instance.

The session for this GATT device service instance.

Gets the sharing mode for this GATT device service instance.

The sharing mode for this GATT device service instance.

Gets the GATT Service UUID associated with this **GattDeviceService**.

**A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.**

Releases the resources associated with the GattDeviceService class. This allows other apps to access the resources of the GattDeviceService in question. A GattDeviceService object should not be used after Close is invoked, instead a new GattDeviceService object should be instantiated using the FromIdAsync method.

Converts a Bluetooth SIG defined short Id to a full GATT UUID.

Use BluetoothUuidHelper instead of ConvertShortIdToUuid. For more information, see MSDN. A 16-bit Bluetooth GATT Service UUID. The corresponding 128-bit GATT Service UUID, that uniquely identifies this service.

Instantiates a new GattDeviceService from the device ID.

The GATT device ID. The object for managing the asynchronous operation, which, upon completion, returns the newly instantiated GattDeviceService.

Instantiates a new GattDeviceService object from the device ID.

The GATT device ID. The sharing mode of the GATT device. An asynchronous operation that completes with a GattDeviceService object.

Gets the collection of all characteristics belonging to this GattDeviceService instance.

Use GetCharacteristicsAsync instead of GetAllCharacteristics. For more information, see MSDN. The collection of all characteristics belonging to this GattDeviceService instance.

Gets the collection of all included services belonging to this GattDeviceService instance.

Use GetIncludedServicesAsync instead of GetAllIncludedServices. For more information, see MSDN. The collection of all included services belonging to this GattDeviceService instance.

Returns a vector of characteristics, that are identified by the specified UUID and belong to this GattDeviceService instance.

Use GetCharacteristicsForUuidAsync instead of GetCharacteristics. For more information, see MSDN. The UUID for the characteristics to be retrieved. A vector of GattCharacteristic objects whose UUIDs match characteristicUuid.

Gets the characterisitics that are part of this GattDeviceService instance.

An asynchronous operation that completes with a GattCharacteristicsResult object.

Gets the characterisitics that are part of this GattDeviceService instance.

The cache mode. An asynchronous operation that completes with a GattCharacteristicsResult object.

Gets the characterisitics that are part of this GattDeviceService instance and associated with the characteristicUuid.

The UUID for the characteristics to be retrieved. An asynchronous operation that completes with a GattCharacteristicsResult object.

Gets the characterisitics that are part of this GattDeviceService instance and associated with the characteristicUuid.

The UUID for the characteristics to be retrieved. The cache mode. An asynchronous operation that completes with a GattCharacteristicsResult object.

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a BluetoothDeviceId.

The bluetooth device ID. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a BluetoothDeviceId.

The bluetooth device ID. The cache mode. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a BluetoothDeviceId and serviceUuid.

The bluetooth device ID. The GATT service ID. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a BluetoothDeviceId and serviceUuid.

The bluetooth device ID. The GATT service ID. The cache mode. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a 16-bit Bluetooth GATT Service UUID.

Use GetDeviceSelectorFromUuid instead of GetDeviceSelectorFromShortId. For more information, see MSDN. A 16-bit Bluetooth GATT Service UUID. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path

Creates a suitable AQS Filter string for use with the CreateWatcher method, from a Bluetooth service UUID.

A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. A suitable AQS Selector String which can be passed as a parameter to the CreateWatcher method, in order to retrieve a GATT service instance path.

Returns a vector of included services, that are identified by the specified UUID and belong to this GattDeviceService instance.

Use GetIncludedServicesForUuidAsync instead of GetIncludedServices. For more information, see MSDN. The UUID for the included services to be retrieved. A vector of included services whose UUIDs match serviceUuid.

Gets the included services that are associated with this GattDeviceService instance.

An asynchronous operation that completes with a GattDeviceServicesResult object.

Gets the included services that are associated with this GattDeviceService instance.

The cache mode. An asynchronous operation that completes with a GattDeviceServicesResult object.

Gets the included services from the serviceUuid that is associated with this GattDeviceService instance.

A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. An asynchronous operation that completes with a GattDeviceServicesResult object.

Gets the included services from the serviceUuid that is associated with this GattDeviceService instance.

A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object. The cache mode. An asynchronous operation that completes with a GattDeviceServicesResult object.

Opens the GATT device service with the specified sharingMode.

The sharing mode. An asynchronous operation that completes with a GattOpenStatus object.

Requests access to the GattDeviceService.

An asynchronous operation that completes with a DeviceAccessStatus object.

The status of GetIncludedServicesForUuidAsync and GetIncludedServicesForUuidAsync

Gets the protocol error.

The protocol error.

Gets the services.

The services.

Gets the communication status of the operation.

The communication status of the operation.

This class represents a local characteristic.

Gets the local characteristic properties.

The local characteristic properties.

Gets a vector list of all the descriptors for this local characteristic.

A vector list of all the descriptors for this local characteristic.

Gets the presentation formats for this local characteristic.

The presentation formats for this local characteristic.

Gets the read protection level of this local characteristic.

The read protection level of this local characteristic.

Gets the static value for this local GATT characteristic.

The static value for this local GATT characteristic.

Gets a vector list of all clients that are subscribed to this local characteristic.

A vector list of all clients that are subscribed to this local characteristic.

Gets the user-friendly description for this local characteristic.

The user-friendly description for this local characteristic.

Gets the BluetoothSIG-defined UUID for this local characteristic.

The BluetoothSIG-defined UUID for this local characteristic.

Gets the write protection level of this local characteristic.

The write protection level of this local characteristic.

An event that is triggered when a GATT client requests a read operation.

An event that triggers when the clients subscribed to this local characteristic changes.

This is an event that is triggered when a write was requested.

Creates descriptor for this local characteristic.

The descriptor UUID. The parameters for the descriptor. An asynchronous operation that completes with a GattLocalDescriptorResult object.

Send and notifies all subscribed clients a GattSubscribedClient of a value.

The buffer that contains the value to send to the GattSubscribedClient. An asynchronous operation that completes with a vector list of all the GattClientNotificationResult for each subscribed client.

Sends and notifies a GattSubscribedClient of a value.

The buffer that contains the value to send to the GattSubscribedClient. The subscribed client notify the value. An asynchronous operation that completes with a GattClientNotificationResult object.

This class contains the local characteristic descriptor parameters.

Creates a new GattLocalCharacteristicParameters object.

Gets the properties.

The properties.

Gets or sets the presentation formats.

The presentation formats.

Gets or sets the read protection level.

The read protection level.

Gets or sets the static value.

The static value.

Gets or sets the user-friendly description.

The user-friendly description.

Gets and sets the write protection level.

The write protection level.

A result of CreateCharacteristicAsync.

Gets the characteristic of the GATT service.

The characteristic of the GATT service.

Gets the error.

The error.

This class defines a descriptor of a local characteristic.

Gets the read protection level of this local characteristic descriptor.

The read protection level of this local characteristic descriptor.

Gets the static value for this local characteristic descriptor.

The static value for this local characteristic descriptor.

Gets the Bluetooth SIG-defined UUID for this local characteristic descriptor.

The Bluetooth SIG-defined UUID for this local characteristic descriptor.

Gets the write protection level.

The write protection level.

An event that is triggered when a read has been requested.

An event that is triggered when a write has been requested.

This class defines the parameters of a descriptor.

Creates a new GattLocalDescriptorParameters object.

Gets or sets the read protection level.

The read protection level.

Gets or sets the static value.

The static value.

Gets or sets the write protection level.

The write protection level.

The result of local characteristic descriptor operations like CreateDescriptorAsync.

Gets the descriptor.

The descriptor.

Gets the error.

The error.

This class represents a GATT local service.

Gets a vector list of the characteristics available for this local service.

A vector list of the characteristics available for this local service.

Gets the local service UUID.

The local service UUID.

Creates a characteristic for this local service.

The characteristic UUID. The characteristic parameters. An asynchronous operation

The status of GattDeviceService.OpenAsync.

Access is denied.

The GATT device service is already opened.

The GATT device service was not found.

There was a sharing violation.

The GATT device service was successfully opened.

Unspecified error.

Represents the value of a single Presentation Format GATT Descriptor.

Gets the value of the Bluetooth SIG Assigned Numbers Namespace.

The value of the Bluetooth SIG Assigned Numbers Namespace.

Gets the Description of the GattPresentationFormat object.

The Description of the GattPresentationFormat object.

Gets the Exponent of the GattPresentationFormat object.

The Exponent of the GattPresentationFormat object.

Gets the Format Type of the GattPresentationFormat object.

The Format Type of the GattPresentationFormat object.

Gets the Namespace of the GattPresentationFormat object.

The Namespace of the GattPresentationFormat object.

Gets the Unit of the GattPresentationFormat object.

The Unit of the GattPresentationFormat object.

Creates a GattPresentationFormat object from parts.

The Format Type. The exponent. The unit. The namespace ID. The description. An instance of GattPresentationFormat.

Represents the different well-known values that the GattPresentationFormat.FormatType property can take.

Gets the value of the Bit2 Format Type.

The value of the Bit2 Format Type.

Gets the value of the Boolean Format Type.

The value of the Boolean Format Type.

Gets the value of the DUInt16 Format Type.

The value of the DUInt16 Format Type.

Gets the value of the Float Format Type.

The value of the Float Format Type.

Gets the value of the Float32 Format Type.

The value of the Float32 Format Type.

Gets the value of the Float64 Format Type.

The value of the Float64 Format Type.

Gets the value of the Nibble Format Type.

The value of the Nibble Format Type.

Gets the value of the SFloat Format Type.

The value of the SFloat Format Type.

Gets the value of the SInt12 Format Type.

The value of the SInt12 Format Type.

Gets the value of the SInt128 Format Type.

The value of the SInt128 Format Type.

Gets the value of the SInt16 Format Type.

The value of the SInt16 Format Type.

Gets the value of the SInt24 Format Type.

The value of the SInt24 Format Type.

Gets the value of the SInt32 Format Type.

The value of the SInt32 Format Type.

Gets the value of the SInt48 Format Type.

The value of the SInt48 Format Type.

Gets the value of the SInt64 Format Type.

The value of the SInt64 Format Type.

Gets the value of the SInt8 Format Type.

The value of the SInt8 Format Type.

Gets the value of the Struct Format Type.

The value of the Struct Format Type.

Gets the value of the UInt12 Format Type.

The value of the UInt12 Format Type.

Gets the value of the UInt128 Format Type.

The value of the UInt128 Format Type.

Gets the value of the UInt16 Format Type.

The value of the UInt16 Format Type.

Gets the value of the UInt24 Format Type.

The value of the UInt24 Format Type.

Gets the value of the UInt32 Format Type.

The value of the UInt32 Format Type.

Gets the value of the UInt48 Format Type.

The value of the UInt48 Format Type.

Gets the value of the UInt64 Format Type.

The value of the UInt64 Format Type.

Gets the value of the UInt8 Format Type.

The value of the UInt8 Format Type.

Gets the value of the Utf16 Format Type.

The value of the Utf16 Format Type.

Gets the value of the Utf8 Format Type.

The value of the Utf8 Format Type.

Represents the desired security level.

Require the link to be authenticated.

Require the link to be encrypted and authenticated.

Require the link to be encrypted.

Uses the default protection level.

This class contains byte values for GATT protocol errors.

Gets the byte value for an attribute not found error.

The byte value for an attribute not found error.

Gets the byte value for an attribute not long error.

The byte value for an attribute not long error.

Gets the byte value for an insufficient authentication error.

The byte value for an insufficient authentication error.

Gets the byte value for an insufficient authorization error.

The byte value for an insufficient authorization error.

Gets the byte value for an insufficient encryption error.

The byte value for an insufficient encryption error.

Gets the byte value for an insufficient encryption key size error.

The byte value for an insufficient encryption key size error.

Gets the byte value for an insufficient resources error.

The byte value for an insufficient resources error.

Gets the byte value for an invalid attribute value length error.

The byte value for an invalid attribute value length error.

Gets the byte value for an invalid handle error.

The byte value for an invalid handle error.

Gets the byte value for an invalid offset error.

The byte value for an invalid offset error.

Gets the byte value for an invalid PDU error.

The byte value for an invalid PDU error.

Gets the byte value for a prepare queue full error.

The byte value for a prepare queue full error.

Gets the byte value for a read not permitted error.

The byte value for a read not permitted error.

Gets the byte value for a request not supported error.

The byte value for a request not supported error.

Gets the byte value for an unlikely error.

The byte value for an unsupported group type error.

Gets the byte value for an unsupported group type error.

The byte value for an unsupported group type error.

Gets the byte value for a write not permitted error.

The byte value for a write not permitted error.

Represents the result of reading a GATT Client CharacteristicConfigurationClientDescriptor value.

Gets the result of an asynchronous read operation.

The result of the asynchronous read operation.

Gets the protocol error.

The protocol error.

Gets the status of an asynchronous operation.

The status of the asynchronous operation.

This class represents a Bluetooth GATT read request.

Gets the buffer length of the read request.

The buffer length of the read request.

Gets the read request offset.

The read request offset.

Gets the read request state.

The read request state.

This is an event that is triggered when the read request state was changed.

Responds to the read request with a protocol error.

The protocol error to send. A list of errors with the byte values can be found in GattProtocolError.

Responds to a read request with a value.

The value to respond with.

This class contains the arguments for the StateChanged event.

Gets the session.

The session.

Gets a deferral.

Returns a deferral object.

Gets the GATT read request.

An asynchronous operation that completes with a GattReadRequest object.

Represents the result of an asynchronous read operation of a GATT Characteristic or Descriptor value.

Gets the protocol error.

The protocol error.

Gets the status of an asynchronous operation.

The status of the asynchronous operation.

Gets the value read from the device.

The value read from the device.

Performs GATT reliable writes on the Bluetooth LE device, in the form of a transaction write operation.

Creates a new GattReliableWriteTransaction object.

Performs all the queued writes, in sequence, writing the data to the device. Once a transaction object has been committed, no further operations are possible on the GattReliableWriteTransaction object.

The object used to manage the asynchronous operation, which, upon completion, will return the status of the asynchronous operation.

Performs all the queued writes, in sequence, writing the data to the device. Once a transaction object has been committed, no further operations are possible on the GattReliableWriteTransaction object.

An asynchronous operation that completes with a GattWriteResult object.

Adds a new write operation to the transaction object.

The GattCharacteristic object on which to perform the write operation. The Characteristic Value to be written to characteristic.

This enumeration defines a GATT request state.

The request is canceled.

The request if completed.

The request is pending.

This class defines arguments of StateChanged.

Gets the Bluetooth error.

The Bluetooth error.

Gets the state of the read request.

The state of the read request.

This class is used to advertise a GATT service.

Gets the advertisement status of this GATT service.

The advertisement service.

Gets the GATT service.

The GATT service.

An event that is triggered when the advertisement status has changed.

Creates a new GATT service with the specified serviceUuid

The service UUID. An asynchronous operation that completes with a GattServiceProviderResult object.

Start advertising the GATT service.

Start advertising the GATT service.

The advertising parameters.

Stop advertising the GATT service.

This enumeration defines the advertisement status of a GattServiceProvider.

The GATT service was aborted.

The GATT service was created.

The GATT service advertising has started.

Indicates that the system was successfully able to issue the advertisement request, but not all of the requested data could be included in the advertisement.

The GATT service is not advertising.

The event args for the GattServiceProvider.

Gets the error of the GATT service.

The error of the GATT service.

Gets the status of the GATT service.

The status of the GATT service.

This class is used to define a GATT service advertisement parameters.

Creates a new GattServiceProviderAdvertisingParameters object.

Gets or sets a boolean that indicates if the GATT service is connectable.

A boolean that indicates if the GATT service is connectable.

Gets or sets a boolean indicating that the GATT service is discoverable.

A boolean indicating that the GATT service is discoverable.

For Bluetooth Low Energy, this parameter adds an additional **ServiceData** section to the advertisement payload for the service's service UUID if space is available. If the service data is added to the advertisement, then the service UUID will also be included in the same section in the advertisement.

The service data included in a Bluetooth Low Energy advertising payload.

This class is the result of the CreateAsync operation.

Gets the error.

The error.

Gets the service provider.

The service provider.

Represents an enumeration of the most well known Service UUID values, and provides convenience methods for working with GATT service UUIDs, and static properties providing service UUIDs for common GATT services. To view a list of all Bluetooth SIG-defined service UUIDs, see Bluetooth SIG-defined Service UUIDs.

Gets the Bluetooth SIG-defined AlertNotification Service UUID.

The Bluetooth SIG-defined AlertNotification Service UUID.

Gets the Bluetooth SIG-defined Battery Service UUID.

The Bluetooth SIG-defined Battery Service UUID.

Gets the Bluetooth SIG-defined Blood Pressure Service UUID.

The Bluetooth SIG-defined Blood Pressure Service UUID.

Gets the Bluetooth SIG-defined CurrentTime service UUID.

The Bluetooth SIG-defined CurrentTime service UUID.

Gets the Bluetooth SIG-defined CyclingPower service UUID.

The Bluetooth SIG-defined CyclingPower service UUID.

Gets the Bluetooth SIG-defined Cycling Speed And Cadence Service UUID.

The Bluetooth SIG-defined Cycling Speed And Cadence Service UUID.

Gets the Bluetooth SIG-defined DeviceInformation service UUID.

The Bluetooth SIG-defined DeviceInformation UUID.

Gets the Bluetooth SIG-defined UUID for the Generic Access Service.

The Bluetooth SIG-defined UUID for the Generic Access Service.

Gets the Bluetooth SIG-defined UUID for the Generic Attribute Service.

The Bluetooth SIG-defined UUID for the Generic Attribute Service.

Gets the Bluetooth SIG-defined Glucose Service UUID.

The Bluetooth SIG-defined Glucose Service UUID.

Gets the Bluetooth SIG-defined Health Thermometer Service UUID.

The Bluetooth SIG-defined Health Thermometer Service UUID.

Gets the Bluetooth SIG-defined Heart Rate Service UUID.

The Bluetooth SIG-defined Heart Rate Service UUID.

Gets the Bluetooth SIG-defined HumanInterfaceDevice service UUID.

The Bluetooth SIG-defined HumanInterfaceDevice service UUID.

Gets the Bluetooth SIG-defined ImmediateAlert service UUID.

The Bluetooth SIG-defined ImmediateAlert service UUID.

Gets the Bluetooth SIG-defined LinkLoss service UUID.

The Bluetooth SIG-defined LinkLoss service UUID.

Gets the Bluetooth SIG-defined LocationAndNavigation service UUID.

The Bluetooth SIG-defined LocationAndNavigation service UUID.

Gets the Bluetooth SIG-defined NextDstChange service UUID.

The Bluetooth SIG-defined NextDstChange service UUID.

Gets the Bluetooth SIG-defined PhoneAlertStatus service UUID.

The Bluetooth SIG-defined PhoneAlertStatus service UUID.

Gets the Bluetooth SIG-defined ReferenceTimeUpdate service UUID.

The Bluetooth SIG-defined ReferenceTimeUpdate service UUID.

Gets the Bluetooth SIG-defined Running Speed And Cadence Service UUID.

The Bluetooth SIG-defined Running Speed And Cadence Service UUID.

Gets the Bluetooth SIG-defined ScanParameters service UUID.

The Bluetooth SIG-defined ScanParameters service UUID.

Gets the Bluetooth SIG-defined TxPower service UUID.

The Bluetooth SIG-defined TxPower service UUID.

Represents a Generic Attribute Profile (GATT) session.

Gets a Boolean value that indicates whether the connection can be maintained.

`true` if the connection can be maintained, otherwise `false`.

Gets the device ID.

The device ID.

Gets or sets a Boolean value that indicates whether the connection should be maintained.

`true` if the connection should be maintained, otherwise `false`.

Gets the max PDU size.

The max PDU size.

Gets the session status.

The session status.

An event that is triggered when the max PDU size changes.

An event that is triggered when the GATT session status has changed.

Closes the GattSession.

Creates a new GattSession object from the specified deviceId.

The deviceId. An asynchronous operation that completes with a new GattSession object.

This enumeration defines a GattSession status.

The GATT session is active.

The GATT session is closed.

This class represents the SessionStatusChanged event args.

Gets the error of the GATT session.

The error of the GATT session.

Gets the status of the GATT session.

The status of the GATT session.

This enumeration represents the GATT sharing mode.

The sharing mode is exclusive.

The sharing mode is read and write.

The sharing mode is read only.

The sharing mode is unspecified.

This class represents a subscribed client of a GATT session.

Gets the max notification size.

The max notification size.

Gets the session of the subscribed client.

The session of the subscribed client.

An event that is triggered when the max notification size has changed.

Represents the arguments received by a GattCharacteristic.ValueChanged event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device.

Gets the new Characteristic Value.

The new Characteristic Value.

Gets the time at which the system was notified of the Characteristic Value change.

The time at which the system was notified of the Characteristic Value change.

Indicates what type of write operation is to be performed.

The Write Without Response procedure shall be used.

The default GATT write procedure shall be used.

This class represents a GATT write request.

Gets the offset.

The offset.

Gets the write request option.

The write request option.

Gets the state of the write request.

The state of the write request.

Gets the buffer value of the write request.

The buffer value of the write request.

An event that is triggered when the state of the write request has changed.

Responds to the write request.

Responds with a protocol error.

The GATT protocol error.

This class represents the event args for WriteRequested.

Gets the session.

The session.

Gets a deferral.

An asynchronous operation that completes with the deferral.

Gets the write request.

An asynchronous operation that completes with the write request.

Contains the result of GATT write operations like WriteValueWithResultAsync.

Gets the protocol error.

The protocol error.

Gets the status of the write result.

The status of the write result.

Represents an instance of a service on a Bluetooth BR device.

Gets the connection host name of the RFCOMM service instance, which is used to connect to the remote device.

The HostName object of the RFCOMM service instance.

Gets the connection service name of the RFCOMM service instance, which is used to connect to the remote device.

The ServiceName object of the RFCOMM service instance.

Gets the BluetoothDevice object describing the device associated with the current RfcommDeviceService object.

The BluetoothDevice object describing the device associated with the current RfcommDeviceService object.

The device access information. Used to check and monitor access.

Gets the current DeviceAccessInformation for the service.

Gets the maximum SocketProtectionLevel supported by this RFCOMM service instance.

The maximum SocketProtectionLevel of the RFCOMM service instance. This level can be passed to StreamSocket.ConnectAsync to upgrade the RFCOMM link protection level.

Gets the current SocketProtectionLevel of the RFCOMM service instance.

The current SocketProtectionLevel of the remote RFCOMM service instance.

Gets the RfcommServiceId of this RFCOMM service instance.

The RfcommServiceId of the RFCOMM service instance.

Closes the RFCOMM device.

Gets an RfcommDeviceService object from a DeviceInformation Id for an RFCOMM service instance.

The DeviceInformation Id that identifies the RFCOMM service instance. This id can be retrieved from Windows.Devices.Enumeration. The RfcommDeviceService object that represents the RFCOMM service instance.

Gets an Advanced Query Syntax (AQS) string for identifying instances of an RFCOMM service. This string is passed to the CreateWatcher method.

The service id for which to query. An AQS string for identifying RFCOMM service instances.

Gets an Advanced Query Syntax (AQS) string for identifying instances of all Rfcomm services on a remote Bluetooth device.

The remote bluetooth device. The AQS string for identifying instances of all Rfcomm services on a remote Bluetooth device.

Gets an Advanced Query Syntax (AQS) string for identifying cached instances of all Rfcomm services on a remote Bluetooth device.

The remote Bluetooth device. The cache mode. The AQS string for identifying cached instances of all Rfcomm services on a remote Bluetooth device.

Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device.

The remote Bluetooth device. The service ID. The AQS string for identifying instances of Rfcomm services.

Gets an Advanced Query Syntax (AQS) string for identifying instances of Rfcomm services on a remote Bluetooth device.

The remote bluetooth device. The service ID. The cache mode. The AQS string for identifying instances of Rfcomm services.

Gets the cached SDP attributes of the RFCOMM service instance.

The SDP attributes of the RFCOMM service instance.

Gets the SDP attributes of the RFCOMM service instance.

Indicates whether SDP attributes should be retrieved from the cache or from the device. The SDP attributes of the RFCOMM service instance.

Used to request explicit access to the Rfcomm service. This invokes Device Consent and must be called on the UI thread. By default, unpaired devices do not require consent, while paired devices do. FromIdAsync will only display a consent prompt when called for a paired device. RequestAccessAsync allows the app to make the access request explicit in the event where the device may become paired in the future through other uses of the device.

After the async operation completes, returns a DeviceAccessStatus object.

The result of an Rfcomm device service request.

Indicates that an error occurred.

Gets the error property.

The RfcommDeviceService object.

Gets the RfcommDeviceService object.

Represents an RFCOMM service ID.

Creates a RfcommServiceId object corresponding to the service id for the standardized Generic File Transfer service (with short id 0x1202).

The RfcommServiceId object that represents the service id for the Generic File Transfer service.

Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX File Transfer service (with short id 0x1106).

The RfcommServiceId object that represents the service id for the Obex File Transfer service.

Creates a RfcommServiceId object corresponding to the service id for the standardized OBEX Object Push service (with short id 0x1105).

The RfcommServiceId object that represents the service id for the OBEX Object Push service.

Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PCE) service (with short id 0x112E).

The RfcommServiceId object that represents the service id for the Phone Book Access (PCE) service.

Creates a RfcommServiceId object corresponding to the service id for the standardized Phone Book Access (PSE) service (with short id 0x112F).

The RfcommServiceId object that represents the service id for the Phone Book Access (PSE) service.

Creates a RfcommServiceId object corresponding to the service id for the standardized Serial Port service (with short id 0x1101).

The RfcommServiceId object that represents the service id for the Serial Port service.

Retrieves the 128-bit service id.

The 128-bit service id.

Converts the RfcommServiceId to a 32-bit service id if possible.

Returns the 32-bit service id if the RfcommServiceId represents a standardized service.

Converts the RfcommServiceId to a string.

Returns the string representation of the 128-bit service id.

Creates a RfcommServiceId object from a 32-bit service id.

The 32-bit service id. The RfcommServiceId object.

Creates a RfcommServiceId object from a 128-bit service id.

The 128-bit service id. The RfcommServiceId object.

Represents an instance of a local RFCOMM service.

Gets a collection of SDP attributes for advertising.

The collection of SDP attributes for advertising.

Gets the RfcommServiceId of this local RFCOMM service instance.

The RfcommServiceId of the local RFCOMM service instance.

Gets a RfcommServiceProvider object from a DeviceInformation Id for a RFCOMM service instance.

The RfcommServiceId to be hosted locally. The RfcommServiceProvider object that represents the local RFCOMM service instance.

Begins advertising the SDP attributes.

The StreamSocketListener that is listening for incoming connections.

Begins advertising the SDP attributes.

The StreamSocketListener that is listening for incoming connections. Indicates whether the radio is discoverable (true) or not (false).

Stops advertising the SDP attributes.

Provides information about a display monitor device connected to the system.

Gets the chromaticity blue primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides).

The chromaticity blue primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides) if known, otherwise `null`.

Gets a value representing the abstract method in which the display is connected (not specific to a physical protocol).

A value representing the abstract method in which the display is connected.

Gets the device identifier.

The device identifier if known, otherwise `null`.

Gets the device identifier of the display adapter to which the monitor is connected. Note that the display adapter may not be the most suitable device for rendering.

The device identifier for the display adapter to which the monitor is connected if known, otherwise `null`.

Gets the locally unique identifier (LUID) of the display adapter to which the monitor is connected. Note that the display adapter to which the monitor is connected may not be the most suitable one for rendering.

A DisplayAdapterId containing the numeric locally unique ID (LUID) of the display adapter to which the monitor is connected if known, otherwise `null`.

Gets an opaque ID used by the display adapter to identify which connector the monitor is attached to. This target ID can be used with DisplayConfig APIs.

An opaque ID used by the display adapter to identify which connector the monitor is attached to.

Gets a friendly name for the device suitable for display to a user.

A friendly name for the device suitable for display to a user if known, otherwise `null`.

Gets the chromaticity green primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides).

The chromaticity green primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides) if known, otherwise `null`.

Gets a value that indicates whether the monitor's metadata has specified that it treats high dynamic range (HDR) as a special *Dolby Vision* mode. This API is intended to be used by the Dolby audio decoder running within media to play specially certified content.

`true` if the monitor's metadata has specified that it treats high dynamic range (HDR) as a special *Dolby Vision* mode, otherwise `false`.

Gets the monitor's maximum average full-frame luminance in nits.

The monitor's maximum average full-frame luminance in nits.

Gets the monitor's maximum luminance in nits.

The monitor's maximum luminance in nits.

Gets the monitor's minimum luminance in nits.

The monitor's minimum luminance in nits.

Gets the monitor's native resolution in raw pixels.

The monitor's native resolution in raw pixels.

Gets a value representing the physical connector standard used to connect the display.

A value representing the physical connector standard used to connect the display.

Gets the monitor's physical diagonal size in inches.

The monitor's physical diagonal size in inches if known, otherwise `null`.

Gets the physical horizontal DPI of the monitor (based on the monitor’s native resolution and physical size).

The physical horizontal DPI of the monitor (based on the monitor’s native resolution and physical size).

Gets the physical vertical DPI of the monitor (based on the monitor’s native resolution and physical size).

The physical vertical DPI of the monitor (based on the monitor’s native resolution and physical size).

Gets the chromaticity red primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides).

The chromaticity red primary point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides) if known, otherwise `null`.

Gets a value representing the use to which the display is being put.

A value representing the use to which the display is being put.

Gets the chromaticity white point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides).

The chromaticity white point (calculated from the monitor's Extended Display Identification Data, or EDID, and any driver overrides) if known, otherwise `null`.

Asynchronously creates a DisplayMonitor object for the specified device identifier (a string containing a PnP device instance path). See the code example below.

The monitor device identifier. See DeviceInformation.Id. An asynchronous create operation.

Asynchronously creates a DisplayMonitor object for the specified monitor interface identifier (a string containing a PnP device interface path). See the code example below.

The monitor interface identifier An asynchronous create operation.

Retrieves a hardware descriptor of the kind specified.

The kind of descriptor to retrieve. A byte array containing a hardware descriptor of the kind specified.

Returns an Advanced Query Syntax (AQS) device interface selector string for the purpose of retrieving device *interfaces* (rather than devices).

An Advanced Query Syntax (AQS) device interface selector string.

Defines constants that specify an abstract method in which a display is connected (not specific to a physical protocol).

Indicates that the display is connected internally.

Indicates that the display is connected virtually.

Indicates that the display is connected wired.

Indicates that the display is connected wirelessly.

Defines constants that specify various kinds of display monitor hardware descriptor.

Indicates that the descriptor contains the monitor's DisplayID data (a superset of EDID).

Indicates that the descriptor contains the monitor's Extended Display Identification Data (EDID).

Defines constants that specify a physical connector standard used to connect a display.

Indicates that the physical connector standard is that of an analog television (also known as component video).

Indicates that the physical connector standard is DisplayPort.

Indicates that the physical connector standard is Digital Visual Interface (DVI).

Indicates that the physical connector standard is HD15 (also known as a VGA connector).

Indicates that the physical connector standard is High-Definition Multimedia Interface (HDMI).

Indicates that the physical connector standard is low-voltage differential signaling (LVDS).

Indicates that the physical connector standard is serial digital interface (SDI).

Indicates that the physical connector standard is not known.

Defines constants that specify the use to which the display is being put.

Indicates that the display is being used as a head-mounted display.

Indicates that the display is not to be used as part of the Windows desktop, and is designed to be driven by a specific third-party application.

Indicates that the display is being used as a standard monitor.

Represents a hardware display controller. This is typically a GPU (graphics processing unit).

Gets the PnP device interface path for this adapter.

A string containing a PnP device interface path.

Gets a numeric locally unique ID (LUID) that refers to the runtime instance of the display adapter. This ID changes if the adapter's PnP device is stopped/started, or if the system reboots.

A DisplayAdapterId containing a locally unique numeric ID (LUID) value.

Gets the PCI device ID of the adapter.

A value containing the PCI device ID of the adapter.

Gets the PCI revision number of the adapter.

A value containing the PCI revision number of the adapter.

Gets the PCI subsystem ID of the adapter.

A value containing the PCI subsystem ID of the adapter.

Gets the PCI vendor ID of the adapter.

A value containing the PCI vendor ID of the adapter.

Gets a collection containing the properties of the display adapter.

An IMapView, keyed by **Guid**, of objects representing properties.

Gets the number (the count) of hardware sources exposed by the display driver. This is typically the maximum number of simultaneous paths allowed by the adapter.

A value containing the number (the count) of hardware sources exposed by the display driver.

Retrieves a DisplayAdapter for the given display adapter ID, if the adapter still exists on the system. This method throws an exception if the specified adapter cannot be found, or if it is no longer present on the system.

The DisplayAdapterId identifying the display adapter to retrieve. The identifier is a locally unique numeric ID (LUID) value. A DisplayAdapter object representing the specified adapter.

Defines constants that specify a number of bits per channel, as flags.

Indicates 10 bits per channel.

Indicates 12 bits per channel.

Indicates 14 bits per channel.

Indicates 16 bits per channel.

Indicates 6 bits per channel.

Indicates 8 bits per channel.

Indicates no specific number of bits per channel.

Represents a context for creating and presenting content directly to the display driver. A **DisplayDevice** is analogous to a Direct3D device in the Direct3D API.

Creates a DisplayFence object that is automatically signaled by the system with an incrementing value at a certain time every vertical refresh cycle.

The DisplayTarget (which must be currently active) whose vertical refresh cycle will be used by the periodic fence. A time offset from the display controller's V-blank interrupt to signal the fence every vertical refresh cycle. A DisplayFence object.

Creates a primary surface (or just "primary") for use with the display controller. The resulting primary surface is compatible with a DisplayScanout, which is used for presenting content directly to the screen.

An active DisplayTarget, which is used to determine which source the primary will be optimized for. A description of the primary surface to create, such as width, height, and pixel format. A DisplaySurface value.

Creates a DisplaySource object, which provides the ability to directly scan out/present to the DisplayTarget object or objects currently connected to this source.

An active DisplayTarget for which to create a display source. A DisplaySource value.

Creates a DisplayScanout object, which can be used to present a full-screen surface directly to the screen.

A DisplaySource to present full-screen content to. A full-screen primary surface. A DisplayScanout value.

Creates a DisplayTaskPool, which can create and execute DisplayTask objects on this DisplayDevice.

A DisplayTaskPool value.

Retrieves a Boolean value indicating whether or not a given capability is supported by this DisplayDevice.

The DisplayDeviceCapability to query about. `true` if the capability is supported, otherwise `false`.

Synchronously waits for the next V-blank interrupt to be fired by the primary DisplayTarget for a given DisplaySource.

The DisplaySource whose primary display target's V-blank interrupt to wait for.

Defines constants that specify a capability of a DisplayDevice.

Indicates that presenting content with a sync interval of zero cancels any pending flips, and instead schedules the content to be flipped on the next V-blank interrupt.

Represents a fence object that can be used to synchronize rendering commands between Direct3D devices and a DisplayDevice object.

Manages the ownership of a DisplayTarget object or objects, and provides methods to create DisplayState objects.

An event that is raised when system display hardware is added, removed, or modified. This can occur whenever the enumerations of DisplayAdapter objects and DisplayTarget objects are different, so we recommended that you subscribe to this event and call GetCurrentAdapters and/or GetCurrentTargets to determine what has changed.

An event raised whenever the current session's display stack is disabled, and when DisplayManager.Stop is called. You can disable the session display stack in several cases, such as switching Terminal Services sessions, or to recover from driver failures. We recommend that subscribers attempt to clean up when **Disabled** is invoked. Most display APIs will fail while the session display stack is disabled.

An event raised whenever the current session's display stack is enabled, and when DisplayManager.Start is called. You can re-enable the session display stack in several cases, such as switching Terminal Services sessions, or to recover from driver failures. We recommend that subscribers re-enumerate all targets and state in this call, since the system display stack could be left in any state before this event is raised.

An event that is raised whenever a display path is failed or invalidated asynchronously by the system. This can be due to changing hardware bandwidth requirements, or due to driver failures.

Revokes ownership of all DisplayTarget objects owned by this DisplayManager instance.

Creates a DisplayManager instance with the specified options.

A DisplayManager value.

Creates a DisplayDevice object for the given adapter. The **DisplayDevice** can be used to create and present full-screen content to targets on the given adapter.

The DisplayAdapter to create a DisplayDevice for. A DisplayDevice value.

Enumerates the set of display adapters currently present on the system.

A collection of DisplayAdapter values.

Enumerates the set of display targets currently present on the system.

A collection of DisplayTarget values.

Releases ownership of the specified display target, allowing other components on the system to acquire ownership.

The DisplayTarget to release ownership of.

Starts listening for all DisplayManager events atomically. DisplayManager events are not raised until you call **Start**.

Stops listening to all DisplayManager events atomically, and triggers Disabled synchronously.

Attempts to acquire exclusive ownership of a DisplayTarget.

The DisplayTarget to try to acquire exclusive ownership of. A DisplayManagerResult value detailing the success or failure of acquiring the target.

Attempts to acquire exclusive ownership of a collection of DisplayTarget objects, and creates an empty modifiable DisplayState object, which supports connecting paths to these targets.

A collection of DisplayTarget objects whose ownership will be attempted to be acquired. A DisplayManagerResultWithState value.

Attempts to acquire exclusive ownership of a collection of DisplayTarget objects, and carves out a subset of a given DisplayState for only the targets passed to this method. The resulting state can be modified and applied.

An existing DisplayState object to carve out a subset of paths to create the new DisplayState result. A collection of DisplayTarget objects whose ownership will be attempted to be acquired. A DisplayManagerResultWithState value.

Attempts to acquire exclusive ownership of a collection of DisplayTarget objects, and creates a modifiable DisplayState populated with the current state of the supplied targets.

A collection of DisplayTarget objects whose ownership will be attempted to be acquired. A DisplayManagerResultWithState value.

Creates a read-only DisplayState object populated with the entire system display state for all targets.

A DisplayManagerResultWithState value.

Represents arguments for the Changed event.

Gets and sets a value indicating whether the Changed event has been handled.

`true` if the Changed event has been handled, otherwise `false`.

A Deferral object representing the deferral.

Represents arguments for the Disabled event.

Gets and sets a value indicating whether the Disabled event has been handled.

`true` if the Disabled event has been handled, otherwise `false`.

A Deferral object representing the deferral.

Represents arguments for the Enabled event.

Gets and sets a value indicating whether the Enabled event has been handled.

`true` if the Enabled event has been handled, otherwise `false`.

A Deferral object representing the deferral.

Defines constants that specify options for the DisplayManager.

Restricts scan out to devices created by this DisplayManager object, or to DisplaySource objects created using a shared handle provided by a path owned by this **DisplayManager**.

Specifies no options.

Represents arguments for the PathsFailedOrInvalidated event.

Gets and sets a value indicating whether the PathsFailedOrInvalidated event has been handled.

`true` if the PathsFailedOrInvalidated event has been handled, otherwise `false`.

A Deferral object representing the deferral.

Defines constants that specify the result of a DisplayManager operation.

Indicates that the operation failed because the current session is currently in an unsupported remote desktop session that does not allow access to the display stack.

Indicates that the operation succeeded.

Indicates that the operation failed becaused a specified target could not be acquired, either due to another component currently owning it, or due to target ownership restrictions.

Indicates that the operation failed because a specified target is stale and should be re-enumerated.

Indicates that the operation failed for an unknown reason.

Contains the status of a DisplayManager operation, and a resulting DisplayState if the operation was successful.

Gets a value indicating the success or error status of the operation.

A DisplayManagerResult value.

Gets an HRESULT value indicating how the operation succeeded or failed.

An HRESULT value.

Gets the DisplayState object that resulted from the operation, if successful.

A DisplayState value.

Describes valid combinations of properties for a DisplayPath. The property values on this object can be set on a **DisplayPath** using the ApplyPropertiesFromMode method. Note that this object refers to a range of valid wire formats, not just one specific wire format.

Gets a value indicating whether the DisplayModeInfo is interlaced.

`true` if this is an interlaced DisplayModeInfo, otherwise `false`.

Gets a value indicating whether the DisplayModeInfo is stereoscopic 3D.

`true` if this is a stereoscopic 3D DisplayModeInfo, otherwise `false`.

Gets the presentation rate of the DisplayModeInfo.

A DisplayPresentationRate value.

Gets a collection containing the properties of the DisplayModeInfo.

An IMapView, keyed by **Guid**, of objects representing properties.

Gets or sets the pixel format of the surfaces that will be allowed to present to this DisplayModeInfo.

A DirectXPixelFormat value.

Gets or sets an optional value for the size of the pixel buffer used for scanout, before it is transformed to fit into the target resolution.

A value indicating the size of the pixel buffer used for scanout.

Gets or sets an optional value for the size of the frame provided to the target's monitor. This can differ from the size of the "source" frame buffer, in which case the display pipeline transforms the content using the Rotation and Scaling properties.

A value indicating the size of the frame provided to the target's monitor.

Retrieves a value containing zero or more display bits-per-channel flags (logically OR-ed together) that are valid for the DisplayModeInfo, for a supplied display wire format pixel encoding.

The desired DisplayWireFormatPixelEncoding for determining which bits-per-channel settings are valid. A DisplayBitsPerChannel value containing zero or more display bits-per-channel flags (logically OR-ed together).

Retrieves a Boolean value indicating whether the DisplayModeInfo supports the specified format.

A DisplayWireFormat. `true` if the format is supported, otherwise `false`.

Defines constants that specify options for a mode query operation.

Indicates no options.

Indicates that only return modes whose source resolution and target resolution exactly match the connected monitor's native mode should be returned.

Represents a display pipeline path from a logical "source" to a DisplayTarget. A logical source provides a frame buffer, in a format described by the source properties. The display pipeline composes the source content and transforms it into the format described by the target properties.

Gets or sets an optional value for whether the target mode for this path is interlaced.

`true` if the target mode for this path is interlaced, otherwise `false`.

Gets or sets whether the target mode for this path is in 3D stereoscopic mode.

`true` if the target mode for this path is in 3D stereoscopic mode, otherwise `false`.

Gets or sets an optional value for the refresh rate, also known as the vertical sync rate, of this path's target mode.

A DisplayPresentationRate value.

Reserved for future use.

Reserved for future use.

Gets or sets how the display pipeline rotates the source frame buffer before scanning out to the target.

A DisplayRotation value.

Gets or sets how the display pipeline scales the source frame buffer before scanning out to the target.

A DisplayPathScaling value.

Gets or sets the pixel format of the surfaces that will be allowed to present to this DisplayPath.

A DirectXPixelFormat value.

Gets or sets an optional value for the size of the pixel buffer used for scanout, before it is transformed to fit into the target resolution.

A value indicating the size of the pixel buffer used for scanout.

Gets the last status of the path in the system, captured when the DisplayState was last created or applied.

A DisplayPathStatus value.

The DisplayTarget that this path connects to.

A DisplayTarget value.

Gets or sets an optional value for the size of the frame provided to the target's monitor. This can differ from the size of the "source" frame buffer, in which case the display pipeline transforms the content using the Rotation and Scaling properties.

A value indicating the size of the frame provided to the target's monitor.

Gets the logical view that this path is connected from. All paths residing in the same DisplayView are logically cloned together.

A DisplayView value.

Gets or sets an optional value for the exact hardware representation used to scan out; such as the pixel encoding, bits per channel, color space, and HDR metadata format.

A DisplayWireFormat value.

Sets on this DisplayPath object all properties reflected in a supplied DisplayModeInfo. Note that the wire format is not set by this method, since a **DisplayModeInfo** object refers to a range of valid wire formats.

A DisplayModeInfo reflecting the properties to set.

Queries the driver to determine the valid mode combinations that can be applied to this DisplayPath. Any properties that have already been set on this path are used as constraints to limit the set of modes returned.

A DisplayModeQueryOptions value containing extended options for filtering the resulting modes. A collection containing zero or more modes that the driver reports could be successfully applied to this path. If the collection is empty, then either the driver doesn't support applying the DisplayState, or the supplied options are too constraining.

Defines constants that specify how to scale content from a frame buffer to a target.

Indicates that content should be stretched to fit within the target resolution, but without changing the source aspect ratio. Any unoccupied space is rendered as black pixels.

Indicates that content should be centered within the target resolution, with no scaling. Any unoccupied space is rendered as black pixels.

Reserved for future use.

Indicates that the driver should determine how to scale the content.

Indicates that content should not be stretched at all. This is only applicable if the source and target resolutions are identical.

Indicates that content should be stretched to the exact target resolution.

Defines constants that specify the last status of the path in the system, captured when the DisplayState was last created or applied.

Indicates that a path failed synchronously during a TryApply or TryFunctionalize call.

Indicates that the display hardware has asynchronously failed the path, either due to changing bandwidth allocations, or due to driver errors during another mode change. This path should be re-evaluated and re-applied by the owner.

Indicates that the path is likely still valid in hardware, but requires applying a mode again in order to reset pending software state. A path in this state typically shows a black screen on the output.

Indicates that the last apply operation was completed successfully, but the driver has indicated that it is still applying the path to the hardware asynchronously.

Indicates that the path has been successfully applied, and was currently active when the DisplayState was last created or applied.

Used for newly created paths that have not been applied.

Describes an overall presentation rate composed of a rational refresh rate and a divider.

The refresh rate, also known as vertical sync rate, which controls how often the display pipeline scans out to a target. This rate is represented in Hertz (Hz) and stored as a two-part rational number.

Specifies an integer divider to scale down the rate of full-screen presentations as a fraction of vertical syncs. For example, if **VerticalSyncsPerPresentation** is set to 2, then one full-screen presentation will last for 2 vertical syncs before the next presentation can occur. Support for values other than 1 requires hardware support.

Describes a set of properties that are used for allocating DisplaySurface objects using CreatePrimary.

Creates a primary description with the specified standard properties.

Gets the DXGI-compatible color space of a surface.

A DirectXColorSpace value.

Gets the DXGI-compatible format of a surface.

A DirectXPixelFormat value.

Gets the height of a surface.

A value containing the height of a surface.

Gets a value indicating whether the description is of a stereoscopic 3D surface.

`true` if the description is of a stereoscopic 3D surface, otherwise `false`.

Gets the multisampling properties of a surface.

A Direct3DMultisampleDescription value specifying the multisampling properties of a surface.

Reserved for future use.

Gets the width of a surface.

A value containing the width of a surface.

Creates a primary description with the specified standard properties, as well as extra properties.

Reserved for future use.

Defines constants that specify how to rotate content from a frame buffer to a target.

Specifies a rotation of 180 degrees clockwise.

Specifies a rotation of 270 degrees clockwise.

Specifies a rotation of 90 degrees clockwise.

Specifies no rotation.

Represents a set of validated parameters to scan out content to a source. A **DisplayScanout** can be assigned to a DisplayTask and executed on a DisplayTaskPool.

Provides ownership of a source, allowing the owner to present frames.

Gets the adapter ID associated with this DisplaySource.

A DisplayAdapterId containing the adapter ID associated with this source.

Gets an adapter-relative identifier for this source.

An adapter-relative identifier for this source.

Retrieves dynamic metadata from the source.

An IBuffer.

Represents a slice in time of display pipeline state for a subset of the system's display targets. If IsReadOnly is `false`, then this object can be modified by connecting targets that are owned by the caller's DisplayManager, or by modifying path properties. Modifying a **DisplayState** object, or its child objects, does not directly modify the system's display state until you call TryApply.

Gets a value indicating whether this DisplayState and its child views and paths can be modified.

`true` if this DisplayState and its child views and paths cannot be modified, otherwise `false`.

Gets a value indicating whether the system display state has changed since this DisplayState was created.

`true` if the system display state has changed since this DisplayState was created, otherwise `false`.

Reserved for future use.

Returns the set of DisplayTarget objects used to create this DisplayState object.

Gets a collection containing the views of the DisplayState.

An IVectorView of DisplayView objects.

Creates a copy of this **DisplayState** object, including copies of all views and paths.

Connects the specified target to an existing logical clone group and returns the resulting path.

Attempts to atomically apply this DisplayState to the relevant hardware. Implicitly, this involves "functionalizing" all paths to determine the best modes matching all DisplayPath and DisplayView properties.

The DisplayStateApplyOptions to use. A DisplayStateOperationResult value detailing the success or failure of the operation.

Attempts to "functionalize" this DisplayState by trying to evaluate the best modes on all paths given all specified DisplayPath properties as constraints. This method then (optionally, see **Remarks**) updates all **DisplayPath** and DisplayView properties with the results of the functionalization. In particular, all **DisplayPath** and **DisplayView** properties set to null will have their values computed and set.

The DisplayStateFunctionalizeOptions to use. A DisplayStateOperationResult value detailing the success or failure of the operation.

Defines constants that specify options for applying a DisplayState to the system.

Indicates that the apply operation should fail with SystemStateChanged if the system display state has changed since the DisplayState object was created. This is useful for improving reliability of an apply operation because, if it fails for this reason, then it's often better to just redo the entire operation in case the system state change resulted in different availability of modes or monitors.

Indicates that all mode list caches should be regenerated by the system.

Indicates that all modes should be re-applied to all display drivers, even if they haven't changed.

Indicates no option.

Defines constants that specify options for functionalizing a DisplayState with the system.

Indicates that the functionalize operation should fail with SystemStateChanged if the system display state has changed since the DisplayState object was created. This is useful for improving reliability of a functionalize operation because, if it fails for this reason, then it's often better to just redo the entire operation in case the system state change resulted in different availability of modes or monitors.

Indicates no option.

Indicates that the operation should validate whether functionalization will succeed, without updating any DisplayPath properties.

Contains the status of a DisplayState operation.

Gets the extended error code of the result.

An HResult value.

Gets the status of the result.

A DisplayStateOperationStatus value.

Defines constants that specify the result of a DisplayState operation.

Indicates that the operation failed because one or more modes specified by a DisplayPath are not supported in the present configuration.

Indicates that the operation failed, but some system state was modified.

Indicates that the operation failed because the current session is currently in an unsupported remote desktop session that does not allow access to the display stack.

Indicates that the operation succeeded.

Indicates that the operation failed because the system display state has changed since the relevant DisplayState object was created.

Indicates that the operation failed because target ownership has been lost.

Indicates that an involved adapter cannot support the number of paths requested.

Indicates that the operation failed for an unknown reason.

A 2D pixel buffer that was allocated to be compatible with scanning out to one or more DisplaySource objects.

Represents a slice in time of a logical "target" for the display pipeline. This is typically analogous to a physical connector on a GPU, such as an HDMI port, but it can be a virtual target representing daisy-chained DisplayPort targets.

Gets the adapter that enumerates this DisplayTarget.

The DisplayAdapter that enumerates this DisplayTarget.

Gets a driver-defined identifier for this target that uniquely identifies the connector across device starts and reboots. Note that this identifier is only unique within its adapter, and does not refer to the connected monitor at all.

The driver-defined identifier for this target.

Gets the PnP device interface of any monitor connected to the target when the object was created, or `null` if no monitor was connected.

The PnP device interface of any monitor connected to the target when the object was created, or `null` if no monitor was connected.

Gets a Boolean value indicating whether a monitor was connected to this DisplayTarget when it was created.

`true` if a monitor was connected to this DisplayTarget when it was created, otherwise `false`.

Gets a value indicating whether the system display state has changed since this DisplayTarget was created.

`true` if the system display state has changed since this DisplayTarget was created, otherwise `false`.

Returns a Boolean value indicating whether this target supports virtual modes.

`true` if this target supports virtual modes, otherwise `false`.

Returns a Boolean value indicating whether this target supports virtual/software clone.

`true` if this target supports virtual/software clone, otherwise `false`.

Gets a value representing how a monitor connected to the target is virtually persisted when the hardware no longer reports any connected monitor.

A DisplayTargetPersistence value.

Reserved for future use.

Gets a value representing a stable monitor identifier.

A string containing the identifier.

Gets a value representing the usage kind.

A DisplayMonitorUsageKind value.

Determines whether all properties of the target are equivalent to another target, indicating that there has been no change to the target.

Determines whether this target object refers to the same underlying hardware target as another target object, by comparing the **Adapter** and the **AdapterRelativeId** properties. Since new DisplayTarget objects are created on each call to GetCurrentTargets, this method can be used to match previously discovered targets to newly created targets.

Tries to retrieve an object describing the monitor currently connected to this DisplayTarget. This method can fail or return a different monitor than the properties on the **DisplayTarget** describe if monitors have been plugged or unplugged from the **DisplayTarget** since the **DisplayTarget** object was created. **IsStale** returns true if the monitor has changed since the **DisplayTarget** was created.

Defines constants that specify how a monitor connected to a target should be virtually persisted when the hardware no longer reports any connected monitor.

Specifies persistence until reboot.

Specifies no persistence.

Specifies persistence via a path.

Specifies temporary persistence.

Represents a set of operations that can be queued and executed atomically by display hardware.

Sets this DisplayTask to present content to a source using the parameters specified by a DisplayScanout when executed.

Sets the operations for this DisplayTask to occur once the specified GPU fence is signaled with the specified value.

A DisplayFence object representing the GPU fence to wait on before performing this task's operations. The value of the GPU fence to wait on.

Provides methods to allocate and execute tasks on a DisplayDevice.

Creates a DisplayTask object.

A DisplayTask value.

Queues a DisplayTask for execution on the device. Tasks are executed asynchronously, so this method returns immediately.

Defines constants that specify a signal kind.

Specifies a signal that flips away on *Present*.

Represents a group of DisplayPath objects that are logically cloned together.

The logical content resolution of this group of cloned DisplayPath objects. For a DisplayView in hardware clone, this will be the same value as each path's SourceResolution property.

Gets the set of paths making up this DisplayView.

A collection containing the paths making up this DisplayView.

Reserved for future use.

Sets a path in this view to be the "primary clone path" in the view, which causes clone-unaware apps to see the refresh rate and target properties of this path by default.

A path that is already present in this DisplayView.

Specifies an exact hardware representation used to scan out; such as the pixel encoding, bits per channel, color space, and HDR metadata format.

Constructs a DisplayWireFormat object from the supplied property values.

Describes how pixels are encoded by the display pipeline, including chroma subsampling. The number of bits used for each channel, without regard for chroma subsampling. Describes the color space. Specifies the electro-optical transfer function (EOTF) that pixels are encoded for. Specifies the format for static or dynamic HDR mastering metadata.

Gets the number of bits used for each channel, without regard for chroma subsampling.

A value containing the number of bits used for each channel, without regard for chroma subsampling.

Gets the color format.

A DisplayWireFormatColorSpace value.

Specifies the electro-optical transfer function (EOTF) that pixels are encoded for.

Specifies the format for static or dynamic HDR mastering metadata.

Describes how pixels are encoded by the display pipeline, including chroma subsampling.

Reserved for future use.

Creates an instance of DisplayWireFormat with the extra properties provided.

Reserved for future use.

Defines constants that specify a color space, typically defined by combinations of three color primaries (red, green, and blue).

Indicates that pixels are encoded for the BT.2020 standard color primaries.

Indicates that pixels are encoded for the BT.709 standard color primaries.

Indicates that pixels are encoded for an exact color space defined in the currently applied color profile.

Defines constants that specify an electro-optical transfer function (EOTF) for encoded pixels. The EOTF defines how a pixel's encoded value is transformed to an optical brightness on a hardware display.

Indicates that pixels are encoded for the SMPTE ST 2084 transfer function, also known as Perceptual Quantizer (PQ).

Indicates that pixels are encoded for SDR brightness with a 2.2 gamma curve.

Defines constants that specify a format for HDR mastering metadata embedded in a pixel bitstream. HDR mastering metadata typically defines how a video stream should be adapted for playback on specific display hardware.

Indicates that Dolby Vision low-latency mastering metadata will be supported.

Indicates that HDR10 mastering metadata will be supported, standardized as SMPTE ST 2086.

Indicates that HDR10+ HDR mastering metadata will be supported, standardized as SMPTE ST 2094-40.

Indicates that no HDR mastering metadata will be supported.

Defines constants that specify the color model and chroma subsampling format used to encode pixel data.

Indicates a single grayscale channel and no chroma data.

Indicates RGB color channels with no chroma subsampling.

Indicates YCbCr color channels with 4:2:0 chroma subsampling.

Indicates YCbCr color channels with 4:2:2 chroma subsampling.

Indicates YCbCr color channels with no chroma subsampling.

Provides data for the AccessChanged event.

Gets the DeviceInformation ID of the device referenced by DeviceAccessChangedEventArgs.

The DeviceInformation ID for the device.

The new status of access to a device.

The new status of access to a device.

Contains the information about access to a device.

The current device access status.

The current device access status.

Raised when access to a device has changed.

Initializes a DeviceAccessInformation object based on a given DeviceClass.

Device class to get DeviceAccessInformation about. The DeviceAccessInformation object for the given DeviceClass.

Initializes a DeviceAccessInformation object based on a device class id.

Id of the device class to get DeviceAccessInformation about. The DeviceAccessInformation object for the given device class id.

Initializes a DeviceAccessInformation object based on a device id.

Id of the device to get DeviceAccessInformation about. The DeviceAccessInformation object for the given device id.

Indicates the status of the access to a device.

Access to the device is allowed.

Access to the device has been disallowed by the system.

Access to the device has been disallowed by the user.

The device access is not specified.

Indicates the type of devices that the user wants to enumerate.

Indicates that the user wants to enumerate all devices.

Indicates that the user wants to enumerate all audio capture devices.

Indicates that the user wants to enumerate all audio rendering devices.

Indicates that the user wants to enumerate all scanning devices.

Indicates that the user wants to enumerate all location aware devices.

Indicates that the user wants to enumerate all portable storage devices.

Indicates that the user wants to enumerate all video capture devices.

Provides information about the device that caused this trigger to fire.

Gets the device Id of the device that caused this trigger to fire.

The device id of the device that caused this trigger to fire.

Provides data for the DisconnectButtonClicked event on the DevicePicker object.

The device that the user clicked the disconnect button for.

The device to disconnect.

Represents a device. This class allows access to well-known device properties as well as additional properties specified during device enumeration.

The physical location of the device in its enclosure. For example, it may describe the location of a webcam inside a laptop.

The object that describes the physical location of the device.

A string representing the identity of the device.

A string representing the identity of the device.

Indicates whether this device is the default device for the class.

Indicates whether this device is the default device for the class.

Indicates whether this device is enabled.

Indicates whether this device is enabled.

Gets the type of DeviceInformation represented by this object.

The type of information represented by this object.

The name of the device. This name is in the best available language for the app.

The name of the device. This name is in the best available language for the app.

Gets the information about the capabilities for this device to pair.

The pairing information for this device.

Property store containing well-known values as well as additional properties that can be specified during device enumeration.

The property store for the device.

Creates a DeviceInformation object from a DeviceInformation ID.

The device ID. An object for starting and managing the asynchronous creation of the DeviceInformation object.

Creates a DeviceInformation object from a DeviceInformation ID and a list of additional properties.

A string containing the DeviceInformation ID. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. An object for starting and managing the asynchronous creation of the DeviceInformation object.

Creates a DeviceInformation object from a DeviceInformation ID, a list of additional properties, and a DeviceInformationKind parameter.

A string containing the DeviceInformation ID. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. The type of DeviceInformation object you want to create. An object for starting and managing the asynchronous creation of the DeviceInformation object.

Creates a DeviceWatcher for all devices.

The created DeviceWatcher.

Creates a DeviceWatcher for devices matching the specified Advanced Query Syntax (AQS) string.

An AQS string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. The created DeviceWatcher.

Creates a DeviceWatcher for devices matching the specified Advanced Query Syntax (AQS) string and the specified collection of properties.

An AQS string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. The created DeviceWatcher.

Creates a DeviceWatcher for devices matching the specified Advanced Query Syntax (AQS) string, the specified collection of properties, and the kind of devices.

An AQS string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. The specific types of devices the DeviceWatcher is interested in. The created DeviceWatcher.

Creates a DeviceWatcher for devices matching the specified DeviceClass.

The class of device to enumerate using the DeviceWatcher. The created DeviceWatcher.

Enumerates all DeviceInformation objects.

The object for managing the asynchronous operation.

Enumerates DeviceInformation objects matching the specified Advanced Query Syntax (AQS) device interface selector string.

An AQS device interface selector string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. The object for managing the asynchronous operation.

Enumerates DeviceInformation objects matching the specified Advanced Query Syntax (AQS) device interface selector string and including the specified collection of properties.

An AQS device interface selector string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. The object for managing the asynchronous operation.

Enumerates DeviceInformation objects matching the specified Advanced Query Syntax (AQS) device interface selector string, the device kind, and including the specified collection of properties.

An AQS device interface selector string that filters the DeviceInformation objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, GetDeviceSelector retrieves the string for the StorageDevice class. An iterable list of additional properties to include in the Properties property of the DeviceInformation objects in the enumeration results. For more info on what the properties represent, see Device information properties. The specific type of device to find. The object for managing the asynchronous operation.

Enumerates DeviceInformation objects of the specified class.

The class of devices to enumerate. The object for managing the asynchronous operation.

Creates a filter to use to enumerate through a subset of device types.

The type of devices that you want to create a filter for. The Advanced Query Syntax (AQS) filter used to specifically enumerate through the device type specified by *deviceClass*.

Gets a glyph for the device.

The object for managing the asynchronous operation that will return a DeviceThumbnail

Returns a thumbnail image for the device.

The object for managing the asynchronous operation that will return a DeviceThumbnail.

Updates the properties of an existing DeviceInformation object.

Indicates the properties to update.

Represents a collection of DeviceInformation objects.

The number of DeviceInformation objects in the collection.

The number of DeviceInformation objects in the collection.

Gets an object that can iterate through the enumerated DeviceInformation objects, starting with the first.

An object that can iterate through the enumerated devices, starting with the first.

Gets the DeviceInformation object at the specified index.

The index. The DeviceInformation object at the specified index.

Gets a range of DeviceInformation objects.

The index at which to start retrieving DeviceInformation objects. The array of DeviceInformation objects starting at the index specified by *startIndex*. The number of DeviceInformation objects returned.

Returns the index of the specified DeviceInformation object in the collection.

The DeviceInformation object in the collection. The index. **true** if the method succeeded; otherwise, **false**.

Represents a custom pairing for a DeviceInformation object.

Raised when a pairing action is requested.

Attempts to pair the device.

The different pairing kinds supported by this DeviceInformation object. The result of the pairing action.

Attempts to pair a device using a minimum protection level.

The different pairing kinds supported by this DeviceInformation object. The minimum protection level this DeviceInformation object requires in order to pair. The result of the pairing action.

Attempts to pair a device using a minimum protection level and custom settings.

The different pairing kinds supported by this DeviceInformation object. The minimum protection level this DeviceInformation object requires in order to pair. The custom device pairing settings. The result of the pairing action.

Represents the kind of DeviceInformation object.

The DeviceInformation object represents a device association endpoint (AEP). AEPs usually represent a device discovered over a wireless or network protocol. Some of these endpoints can be used without needing to first pair the device. Use CanPair to determine if a device supports pairing and IsPaired to determine if a device is already paired with the system. Only *AssociationEndpoint* objects have a non-NULL value for Pairing.

The DeviceInformation object represents an association endpoint (AEP) container. An *AssociationEndpointContainer* object represents a single physical device that might have more than one *AssociationEndpoint* objects associated with it. For example, if a television supports two different network protocols, the *AssociationEndpointContainer* would be the television. It would also have two *AssociationEndpoint* objects to represent each protocol.

The DeviceInformation object represents an association endpoint (AEP) Service. An *AssociationEndpointService* object represents a functional service contract exposed by the device. Not all protocols support AEP services. An *AssociationEndpointService* can have a single parent *AssociationEndpointContainer* object.

The DeviceInformation object represents a device object. This could also be referred to as a devnode. These devices are objects that represent a piece of the device functionality and optionally have drivers loaded on them. When a physical device is paired with windows, multiple *Device* objects are created for it. A device contains 0 or more *DeviceInterface* objects, is a child to one *DeviceContainer* object, and is related to 0 or 1 *AssociationEndpoint* objects.

The DeviceInformation object represents a device container. *DeviceContainer* objects describe a collection of device objects that exist in the same physical device. For example, a multi-function printer may have several different devices included, but they would all exist as part of the parent *DeviceContainer* object.

The DeviceInformation object represents a PnP device interface. These are exposed by device drivers to enable an app to talk to the device, typically using device IOCTLS (input output controls).

The DeviceInformation object represents a device interface class. Every *DeviceInterface* object belongs to a certain *DeviceInterfaceClass*. This is similar to a contract definition. These contracts are represented with an id and properties, just like every other PnP object. *DeviceInterfaceClass* objects contain little more information than a unique identifier and possibly a name.

The DeviceInformation object represents a single physical face of a device enclosure.

The object is of an unknown type. This value is not used.

Contains information and enables pairing for a device.

Gets a value that indicates whether the device can be paired.

**True** if the device can be paired, otherwise **false**.

Gets the DeviceInformationCustomPairing object necessary for custom pairing.

The associated DeviceInformationCustomPairing object.

Gets a value that indicates whether the device is currently paired.

**True** if the device is currently paired, otherwise **false**.

Gets the level of protection used to pair the device.

The protection level.

Attempts to pair the device.

The result of the pairing action.

Attempts to pair the device using a provided level of protection.

The required level of protection to use for the pairing action. The result of the pairing action.

Attempts to pair a device object with a specified protection level and custom settings.

The required level of protection to use for the pairing action. The custom device pairing settings. The result of the pairing action.

Registers the application to handle all inbound pairing requests.

The pairing kinds your app supports. Whether or not the attempt was successful.

Registers the application to handle all inbound pairing requests with the specified minimum level of protection.

The pairing kinds your app supports. The required minimum level of protection to accept for the pairing requests. Whether or not the attempt was successful.

Attempts to unpair the device.

The result of the unpairing action.

Contains updated properties for a DeviceInformation object.

The DeviceInformation ID of the updated device.

The DeviceInformation ID of the updated device.

Gets the type of device for the updated device.

The type of device.

The changed properties in a update to a DeviceInformation object.

The changed properties.

Indicates the kinds of pairing supported by your application or requested by the system. As an input value, use this value to indicate what kinds of pairing your application supports. When this datatype is received as an output value, it indicates the kind of pairing requested by the system. In this case, your code will need to respond accordingly.

The application must confirm they wish to perform the pairing action. You can present an optional confirmation dialog to the user. With a value of **ConfirmOnly**, call Accept from the event args of the PairingRequested event handler if you want the pairing to complete.

The application must display the given PIN to the user and ask the user to confirm that the PIN matches the one show on the target device. With a value of **ConfirmPinMatch**, call Accept from the event args of the PairingRequested event handler if you want the pairing to complete.

The application must display the given PIN to the user. The user will then need to enter or confirm that PIN on the device that is being paired. With a value of **DisplayPin**, call Accept from the event args of the PairingRequested event handler if you want the pairing to complete. If your application cancels the pairing at this point, the device might still be paired. This is because the system and the target device don't need any confirmation for this DevicePairingKinds value.

No pairing is supported.

The application must request a user name and password from the user. With a value of **ProvidePasswordCredential**, call AcceptWithPasswordCredential from the event args of the PairingRequested event handler to accept the pairing. Pass in the PasswordCredential that encapsulates the user name and password as a parameter.

The application must request a PIN from the user. The PIN will typically be displayed on the target device. With a value of **ProvidePin**, call Accept from the event args of the PairingRequested event handler if you want the pairing to complete. Pass in the PIN as a parameter.

The level of protection for pairing.

The default value. This should not be used.

Pair the device using encryption.

Pair the device using encryption and authentication.

Pair the device using no levels of protection.

Provides data for the PairingRequested event.

Gets the DeviceInformation object associated with this pairing request.

The DeviceInformation object associated with this pairing request.

Gets the kind of pairing associated with this pairing event.

The kind of pairing used for this pairing request.

Gets the pin associated with a pairing request.

The pin associated with a pairing request.

Accepts a PairingRequested event and pairs the device with the application.

Accepts a PairingRequested event and pairs the device with the application. Requires a pin for pairing purposes.

The pin to use for attempting to pair a device.

Accepts a PairingRequested event and pairs the device with the application. Requires a user name and password for pairing purposes.

An object that encapsulates the user name and password for attempting to pair the device.

Requests a Deferral to support asynchronous operations.

The deferral necessary to support asynchronous actions.

Contains information about the result of attempting to pair a device.

Gets the level of protection used to pair the device.

The level of protection used when the device was paired.

Gets the paired status of the device after the pairing action completed.

The paired status of the device.

The result of the pairing action with an Association Endpoint (AEP) device object. For more information about AEP objects, see DeviceInformationKind.

Your application does not have the appropriate permissions level to pair the device object.

The device object has already been paired.

Authentication failed, so the device is not paired. Either the device object or the application rejected the authentication.

The authentication protocol is not supported, so the device is not paired.

The authentication process timed out before it could complete.

The device object rejected the connection.

An unknown failure occurred.

The device object indicated there was a hardware failure.

The ceremony data was incorrect.

There are no network profiles for this device object to use.

The device object is not currently paired.

The device object is not in a state where it can be paired.

The device object is already attempting to pair or unpair.

The device object is now paired.

The pairing action was canceled before completion.

The minimum level of protection is not supported by the device object or the application.

The application handler rejected the pairing.

The remove device already has an association.

Either the event handler wasn't registered or a required DevicePairingKinds was not supported.

The device object indicated it cannot accept any more incoming connections.

Represents a picker flyout that contains a list of devices for the user to choose from.

Creates a DevicePicker object.

Gets the colors of the picker.

The color of the picker.

Gets the filter used to choose what devices to show in the picker.

The filter.

Gets a collection of properties for the returned device information object.

The properties you want returned.

Indicates that the device picker was light dismissed by the user. Light dismiss happens when the user clicks somewhere other than the picker UI and the picker UI disappears.

Indicates that the user selected a device in the picker.

Indicates that the user clicked or tapped the disconnect button for a device in the picker.

Hides the picker.

Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the edge of the specified rectangle.

The rectangle from which you want the picker to fly out. The device selected by the user.

Shows the picker UI and returns the selected device; does not require you to register for an event. The picker flies out from the specified edge of the specified rectangle.

The rectangle from which you want the picker to fly out. The edge of the rectangle from which you want the picker to fly out. The device selected.

Updates the picker UI to reflect the provided status and display options for a specified device.

The device information. The status to display. The display options for the device.

Shows the picker UI. The picker flies out from the edge of the specified rectangle.

The rectangle from which you want the picker to fly out.

Shows the picker UI. The picker flies out from the specified edge of the specified rectangle.

The rectangle from which you want the picker to fly out. The edge of the rectangle from which you want the picker to fly out.

Represents the appearance of a device picker.

Gets and sets the accent color of the picker UI.

The accent color.

Gets and sets the background color of the picker UI.

The background color.

Gets and sets the foreground color of the picker UI.

The foreground color.

Gets and sets the accent color for a device that has been selected in the picker.

The accent color.

Gets and sets the background color for a device that is selected in the picker.

The color to use as the background of a selected device.

Gets and sets the foreground color for a device that is selected in the picker.

The foreground color.

Gets and sets the title for the picker UI.

The title of the picker UI.

Indicates what you'd like the device picker to show about a given device. Used with the SetDisplayStatus method on the DevicePicker object.

Picker should show nothing, or no changes.

Picker should display a disconnect button.

Picker should display progress.

Picker should display a retry button.

Represents the filter used to determine which devices to show in the device picker. The filter parameters are OR-ed together to build the resulting filter.

Gets a list of supported device classes to show in the picker. This defaults to an empty list (no filter). You can add device classes to this vector and filter the devices list to those that are in one or more of the provided classes.

The list of device classes.

Gets a list of AQS filter strings. This defaults to empty list (no filter). You can add one or more AQS filter strings to this vector and filter the devices list to those that meet one or more of the provided filters.

The list of AQS filters.

Provides data for the DeviceSelected event on the DevicePicker object.

The device selected by the user in the picker.

The selected device.

Represents the thumbnail image for a device.

Gets a value that indicates whether the stream can be read from.

True if the stream can be read from. Otherwise, false.

Gets a value that indicates whether the stream can be written to.

True if the stream can be written to. Otherwise, false.

Returns the content type of the thumbnail image.

The content type of the image.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the device thumbnail image.

The size of the device thumbnail image.

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

The new stream. The initial, internal position of the stream is 0.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Returns a pointer to an input stream starting at the specified location.

The position in the input stream. A pointer to an input stream.

Returns a pointer to an output stream starting at the specified location.

The position in the output stream. A pointer to an output stream.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read. Specifies the type of the asynchronous read operation. The asynchronous operation.

Sets the position of the stream to the specified value.

The new position of the stream.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Contains information about the result of attempting to unpair a device.

Gets the paired status of the device after the unpairing action completed.

The paired status of the device.

The result of the unpairing action.

The caller does not have sufficient permissions to unpair the device.

The device object was already unpaired.

An unknown failure occurred.

The device object is currently in the middle of either a pairing or unpairing action.

The device object is successfully unpaired.

Enumerates devices dynamically, so that the app receives notifications if devices are added, removed, or changed after the initial enumeration is complete.

The status of the DeviceWatcher.

The status of the DeviceWatcher.

Event that is raised when a device is added to the collection enumerated by the DeviceWatcher.

Event that is raised when the enumeration of devices completes.

Event that is raised when a device is removed from the collection of enumerated devices.

Event that is raised when the enumeration operation has been stopped.

Event that is raised when a device is updated in the collection of enumerated devices.

Gets a DeviceWatcherTrigger object monitoring for changes to the list of devices.

A list of the specific updates you want to monitor. The watcher trigger to monitor for the specified changes.

Starts a search for devices, and subscribes to device enumeration events.

Stop raising the events that add, update and remove enumeration results.

Triggered when the list of devices is updated after the initial enumeration is complete.

Gets the information for the device associated with the DeviceWatcherEvent.

The information for the added, removed, or updated device.

Gets updated information for a device updated by the DeviceWatcherEvent.

The updated information for the modified device.

Gets the type for the device indicated by the DeviceWatcherEvent.

The type of device added, removed, or updated.

The type of event.

The event is an add action.

The event is a remove action.

The event is an update action.

Describes the state of a DeviceWatcher object.

The watcher has aborted operation. No subsequent events will be raised.

This is the initial state of a Watcher object. During this state clients can register event handlers.

The watcher has completed enumerating the initial collection. Items can still be added, updated or removed from the collection.

The watcher transitions to the Started state once Start is called. The watcher is enumerating the initial collection. Note that during this enumeration phase it is possible to receive Updated and Removed notifications but only to items that have already been Added.

The client has called Stop and the watcher has completed all outstanding events. No further events will be raised.

The client has called Stop and the watcher is still in the process of stopping. Events may still be raised.

Provides details about the device updates that invoked the trigger.

Gets the events that activated the trigger.

The events that activated the watcher trigger.

Describes the physical location of a device in its enclosure.

Indicates whether the device is physically located in the docking station of the portable computer.

A value that is **True** if the device is physically located in the docking station, and **False** if it is not.

Indicates whether the device is physically located in the lid of the portable computer.

A value that is **True** if the device is physically located in the lid, and **False** if it is not.

Indicates which panel of the computer the device is physically located on.

One of the values of the Panel enumeration that indicates which panel of the computer the device is physically located on.

Gets the physical degree of rotation for a device in its enclosure.

The degrees of rotation for the device in its enclosure. This is in a clockwise direction.

Identifies a collection of settings for device pairing.

Indicates the location of a panel on a computer. This enumeration is used for indicating the physical location of a device.

The back panel of the computer.

The bottom panel of the computer.

The front panel of the computer.

The left panel of the computer.

The right panel of the computer.

The top panel of the computer.

The location of the panel is unknown.

Represents a PnP object. This class allows access to well-known properties of a PnP object as well as a property store of additional properties that are specified to be retrieved from the PnP object.

A string representing the identity of the PnpObject.

The identity string.

A property store containing well-known values as well as additional specified properties.

A pointer to the property store.

The type of the PnpObject.

The type of the object.

Creates a PnpObject object asynchronously from a previously saved DeviceInformation ID.

The type of the PnpObject. The string value identifying the PnpObject. An iterable list of additional properties to include in the Properties property of the PnpObject object to create. For more info on what the properties represent, see Device information properties. The PnpObject created from the previously saved DeviceInformation ID.

Returns a PnpObjectWatcher object that is used to enumerate the PnP objects in the collection using events.

The type of the PnpObject. An iterable list of additional properties to include in the Properties property of the PnpObject objects included in enumeration results. For more info on what the properties represent, see Device information properties. A PnpObjectWatcher object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications.

Returns a PnpObjectWatcher object that is used to enumerate a filtered collection of PnP objects using events.

The type of the PnpObject. An iterable list of additional properties to include in the Properties property of the PnpObject objects included in enumeration results. For more info on what the properties represent, see Device information properties. An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. A PnpObjectWatcher object used to enumerate the collection by registering event notification delegates and by issuing start and stop event notifications.

Returns all of the PnP objects of a specified type that match the specified criteria.

The type of the PnpObject. An iterable list of additional properties to include in the Properties property of the PnpObject objects included in enumeration results. For more info on what the properties represent, see Device information properties. An object that represents the asynchronous operation.

Returns all of the PnP objects of a specified type that match the specified filter.

The type of the PnpObject. An iterable list of additional properties to include in the Properties property of the PnpObject objects included in enumeration results. For more info on what the properties represent, see Device information properties. An AQS string that filters the PnP objects that will be returned. Typically, this string is retrieved from the method of a class that interacts with devices. An object that represents the asynchronous operation.

Updates the properties of an existing PnpObject by applying the changes described in a PnpObjectUpdate object.

Indicates the properties to update.

Represents an iterable collection of Pnp device objects.

Returns the number of items in the collection.

The number of items in the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the end of the collection if the collection is empty.

Returns the PnpObject located at the specified index.

The integer index for the value to retrieve. The PnpObject at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. True if an item with the specified value was found; otherwise, False.

Indicates the type of device represented by the PnpObject.

The PnpObject represents an association endpoint.

The PnpObject represents an association endpoint container.

The PnpObject represents an association endpoint service.

The PnpObject represents a device.

The PnpObject represents a device container.

The PnpObject represents a device interface.

The PnpObject represents a device interface class.

The PnpObject represents a device input panel.

The object is of an unknown type. This value is not used.

Contains the updated properties of a PnpObject.

The identifier of the PnpObject.

The identifier of the PnpObject.

The changed properties in an update to a PnpObject.

The changed properties.

The type of the PnpObject. One of the values of the PnpObjectType enumeration.

The type of the PnpObject.

Raises events to notify the client that a PnpObject has been added, updated, or removed from an enumerated collection of Pnp device objects in an incremental and asynchronous way.

The status associated with the asynchronous operation.

The status.

Occurs when a PnpObject is added to the collection enumerated by the PnpObjectWatcher.

Occurs when the enumeration of Pnp device objects has been completed.

Occurs when a PnpObject is removed from the collection enumerated by the PnpObjectWatcher.

Occurs when the PnpObjectWatcher has stopped monitoring changes to the collection of Pnp device objects.

Occurs when the properties of a PnpObject in the collection enumerated by the PnpObjectWatcher are updated.

Starts raising the events to inform the client that a PnpObject has been added, updated, or removed.

Stops raising the events to inform the client that a PnpObject has been added, updated, or removed.

Indicates the altitude reference system to be used in defining a geographic shape.

The altitude reference system is based on an ellipsoid which is a mathematical approximation of the shape of the Earth.

The altitude reference system is based on the distance above sea level.

The altitude reference system is based on the distance above the tallest surface structures, such as buildings, trees, roads, etc., above terrain or ground level.

The altitude reference system is based on distance above terrain or ground level.

The altitude reference system was not specified.

The basic information to describe a geographic position.

The altitude of the geographic position in meters.

The latitude of the geographic position. The valid range of latitude values is from -90.0 to 90.0 degrees.

The longitude of the geographic position. This can be any value. For values less than or equal to-180.0 or values greater than 180.0, the value may be wrapped and stored appropriately before it is used. For example, a longitude of 183.0 degrees would become -177.0 degrees.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Unsupported API.

Represents a rectangle that defines a geographic area.

Initializes a new instance of the GeoboundingBox class that has the specified corners.

The northwest corner to use for the new GeoboundingBox. For more info, see the NorthwestCorner property. The southeast corner to use for the new GeoboundingBox. For more info, see the SoutheastCorner property.

Initializes a new instance of the GeoboundingBox class that has the specified corners and uses the specified altitude reference system.

The northwest corner to use for the new GeoboundingBox. For more info, see the NorthwestCorner property. The southeast corner to use for the new GeoboundingBox. For more info, see the SoutheastCorner property. The altitude reference system to use for the new GeoboundingBox. For more info, see the AltitudeReferenceSystem property.

Initializes a new instance of the GeoboundingBox class that has the specified corners and uses the specified altitude reference system and spatial reference ID (SRID).

The northwest corner to use for the new GeoboundingBox. For more info, see the NorthwestCorner property. The southeast corner to use for the new GeoboundingBox. For more info, see the SoutheastCorner property. The altitude reference system to use for the new GeoboundingBox. For more info, see the AltitudeReferenceSystem property. The spatial reference ID (SRID) to use for the new GeoboundingBox. For more info, see the SpatialReferenceId property.

Gets the altitude reference system used by the GeoboundingBox.

The altitude reference system used by the GeoboundingBox.

Gets the center of the GeoboundingBox.

The center of the GeoboundingBox.

Gets the type of geographic shape represented by the GeoboundingBox.

The type of geographic shape represented by the GeoboundingBox.

Gets the altitude of the highest corner of the GeoboundingBox.

The altitude of the highest corner of the GeoboundingBox.

Gets the altitude of the lowest corner of the GeoboundingBox.

The altitude of the lowest corner of the GeoboundingBox.

Gets the northwest corner of the GeoboundingBox.

The northwest corner of the GeoboundingBox.

Gets the southeast corner of the GeoboundingBox.

The southeast corner of the GeoboundingBox.

Gets the spatial reference ID (SRID) used by the GeoboundingBox.

The spatial reference ID (SRID) used by the GeoboundingBox.

Calculates a GeoboundingBox that contains the specified set of geographic positions.

A collection of geographic positions to include inside the GeoboundingBox. The calculated rectangle that contains the specified set of geographic positions.

Calculates a GeoboundingBox that contains the specified set of geographic positions and uses the specified altitude reference system.

A collection of geographic positions to include inside the GeoboundingBox. The altitude reference system to use for the GeoboundingBox. For more info, see the AltitudeReferenceSystem property. The calculated rectangle that contains the specified set of geographic positions.

Calculates a GeoboundingBox that contains the specified set of geographic positions and uses the specified altitude reference system and spatial reference ID (SRID).

A collection of geographic positions to include inside the GeoboundingBox. The altitude reference system to use for the GeoboundingBox. For more info, see the AltitudeReferenceSystem property. The spatial reference ID (SRID) to use for the GeoboundingBox. For more info, see the SpatialReferenceId property. The calculated rectangle that contains the specified set of geographic positions.

Describes a geographic circle with a center point and a radius.

Create a geographic circle object for the given position and radius.

The geographic position of the new circle. The radius of the new circle, in meters.

Create a geographic circle object for the given position, radius and altitude reference system.

The geographic position of the new circle. The radius of the new circle, in meters. The altitude reference system of the new circle.

Create a geographic circle object for the given position, radius, altitude reference system, and spatial reference id.

The geographic position of the new circle. The radius of the new circle, in meters. The altitude reference system of the new circle. The spatial reference Id of the new circle.

The altitude reference system of the geographic circle.

The altitude reference system of the geographic circle.

The center point of a geographic circle.

The center point of a geographic circle.

The type of geographic shape.

The type of geographic shape.

The radius of a geographic circle in meters.

The radius of a geographic circle.

The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

The spatial reference identifier for the geographic circle, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

Contains the information for identifying a geographic location.

The accuracy of the location in meters.

The accuracy in meters.

The altitude of the location, in meters.

The altitude in meters.

The accuracy of the altitude, in meters.

The accuracy of the altitude.

The current heading in degrees relative to true north.

The current heading in degrees relative to true north.

The latitude in degrees.

The latitude in degrees. The valid range of values is from -90.0 to 90.0.

The longitude in degrees.

The longitude in degrees. The valid range of values is from -180.0 to 180.0.

The location of the Geocoordinate.

The location of the Geocoordinate.

Gets the source used to obtain a Geocoordinate.

Gets the source used to obtain a Geocoordinate.

Gets the time at which the associated Geocoordinate position was calculated.

The time at which the associated Geocoordinate position was calculated.

Gets information about the satellites used to obtain a Geocoordinate.

Gets information about the satellites used to obtain a Geocoordinate.

The speed in meters per second.

The speed in meters per second.

The system time at which the location was determined.

The system time at which the location was determined.

Provides additional information about a Geocoordinate. This information is only applicable to position estimates obtained using satellite signals.

Gets the horizontal dilution of precision (HDOP) of a Geocoordinate.

The horizontal dilution of precision (HDOP).

Gets the position dilution of precision (PDOP) of a Geocoordinate.

The position dilution of precision (PDOP).

Gets the vertical dilution of precision (VDOP) of a Geocoordinate.

The vertical dilution of precision (VDOP).

Indicates if your app has permission to access location data.

Permission to access location was granted.

Permission to access location was denied.

Permission to access location was not specified.

Provides access to the current geographic location.

Initializes a new Geolocator object.

Gets the location manually entered into the system by the user, to be utilized if no better options exist.

The location manually entered by the user.

The accuracy level at which the Geolocator provides location updates.

The accuracy level at which the Geolocator provides location updates.

Gets or sets the desired accuracy in meters for data returned from the location service.

The desired accuracy in meters for data returned from the location service.

Indicates whether the user should be prompted to set a default location manually.

**true** if the app would benefit from a manually-set location, **false** if a better option is available.

The status that indicates the ability of the Geolocator to provide location updates.

The status of the Geolocator.

The distance of movement, in meters, relative to the coordinate from the last PositionChanged event, that is required for the Geolocator to raise a PositionChanged event.

The distance of required movement, in meters, for location services to raise a PositionChanged event. The default value is 0.

The requested minimum time interval between location updates, in milliseconds. If your application requires updates infrequently, set this value so that location services can conserve power by calculating location only when needed.

The requested minimum time interval between location updates.

Raised when the location is updated.

Raised when the ability of the Geolocator to provide updated location changes.

Sets the Geolocator to use coarse location as a fallback option (see Remarks).

Starts an asynchronous operation to retrieve the current location of the device.

An asynchronous operation that, upon completion, returns a Geoposition marking the found location.

Starts an asynchronous operation to retrieve the current location of the device.

The maximum acceptable age of cached location data. A TimeSpan is a time period expressed in 100-nanosecond units. The timeout. A TimeSpan is a time period expressed in 100-nanosecond units. An asynchronous operation that, upon completion, returns a Geoposition marking the found location.

Starts an asynchronous operation to retrieve the location history of the device.

Represents the beginning of the time span for which positions are to be returned. Positions (of type Geoposition ) that were collected during the specified time span.

Starts an asynchronous operation to retrieve the location history of the device.

Represents the beginning of the time span for which positions are to be returned. Represents the length of time after *startTime* for which positions are to be returned. Positions (of type Geoposition ) that were collected during the specified time span.

Requests permission to access location data.

A GeolocationAccessStatus that indicates if permission to location data has been granted.

Represents an ordered series of geographic points.

Initializes a new instance of the Geopath class with the specified collection of positions.

The collection of positions to use to create the new Geopath. For more info, see the Positions property.

Initializes a new instance of the Geopath class with the specified collection of positions and with the specified altitude reference system.

The collection of positions to use to create the new Geopath. For more info, see the Positions property. The altitude reference system to use to create the new Geopath. For more info, see the AltitudeReferenceSystem property.

Initializes a new instance of the Geopath class with the specified collection of positions and with the specified altitude reference system and spatial reference ID (SRID).

The collection of positions to use to create the new Geopath. For more info, see the Positions property. The altitude reference system to use to create the new Geopath. For more info, see the AltitudeReferenceSystem property. The spatial reference ID (SRID) to use to create the new Geopath. For more info, see the SpatialReferenceId property.

Gets the altitude reference system used by the Geopath.

The altitude reference system used by the Geopath.

Gets the type of geographic shape represented by the Geopath.

The type of geographic shape represented by the Geopath.

Gets the collection of geographic points that define the Geopath.

The collection of geographic points that define the Geopath.

Gets the spatial reference ID (SRID) used by the Geopath.

The spatial reference ID (SRID) used by the Geopath.

Describes a geographic point.

Create a geographic point object for the given position.

Create a geographic point object for the given position.

Create a geographic point object for the given position and altitude reference system.

Create a geographic point object for the given position. The altitude reference system of the new point.

Create a geographic point object for the given position, altitude reference system, and spatial reference Id.

Create a geographic point object for the given position. The altitude reference system of the new point. The spatial reference Id of the new point.

The altitude reference system of the geographic point. GeoPoint will default to a value of unspecified when constructed without an altitude reference system. The behavior of an unspecified altitude reference system will depend on the API. A MapIcon will treat an unspecified reference system as Surface with an altitude value of 0 and the supplied value for altitude will be ignored.

The altitude reference system of the geographic point.

The type of geographic shape.

The type of geographic shape.

The position of a geographic point.

The position of a geographic point.

The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

The spatial reference identifier for the geographic point, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

Represents a location that may contain latitude and longitude data or venue data.

Unsupported API.

Unsupported API. This property always returns **null**.

The latitude and longitude associated with a geographic location.

The latitude and longitude associated with a geographic location.

Represents the venue associated with a geographic location.

A VenueData object that represents the venue associated with the geographic location.

Indicates the shape of a geographic region.

The geographic region is a rectangular region.

The geographic region is a circle with a center point and a radius.

The geographic region is an order series of points.

The geographic region is a point.

Represents a Visit-related state change. See Guidelines for using Visits tracking for information on how to use this feature.

Gets the location where this Visit-related state change took place.

The location of the Visit-related state change.

Gets the type of state change that this Geovisit instance represents.

A VisitStateChange value representing the type of change.

Gets the time that this Visit-related state change happened.

A DateTime instance representing the time the state change happened.

Handles the monitoring of a user's Visits when the app is in use (not in the background).

Initializes an instance of GeovisitMonitor.

Gets and the scope of Visits to monitor.

A VisitMonitoringScope value representing the desired scope of location changes to monitor.

Raised when the user's current Visit state has changed, provided this GeovisitMonitor is currently monitoring.

Retrieves the latest Visit-related event the user has completed.

An asynchronous operation with a Geovisit instance representing the user's latest Visit.

Begins monitoring for Visit-related events.

A VisitMonitoringScope value representing the desired scope of location changes to monitor.

Stops monitoring for Visit-related events.

Contains information about a VisitStateChanged event.

Gets the Visit-related event corresponding to a VisitStateChanged event that was raised.

A Geovisit instance representing the Visit-related event that denotes a change in state.

Manages the details of a trigger for a Visits-related background task.

Gets a list of Visit-related state changes that the user has logged since they were last queried.

An IVectorView of Geovisit instances representing the user's Visit-related state changes.

Interface to define a geographic shape.

The altitude reference system of the geographic shape.

The altitude reference system of the geographic shape.

The type of geographic shape.

The type of geographic shape.

The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

The spatial reference identifier for the geographic shape, corresponding to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping.

Indicates the requested accuracy level for the location data that the application uses.

Optimize for power, performance, and other cost considerations.

Deliver the most accurate report possible. This includes using services that might charge money, or consuming higher levels of battery power or connection bandwidth. An accuracy level of **High** may degrade system performance and should be used only when necessary.

Provides data for the PositionChanged event.

The location data associated with the PositionChanged event.

A Geoposition object containing geographic location data.

Indicates the source used to obtain a Geocoordinate.

The position was obtained from cellular network data.

(Starting with Windows 10, version 1607.) The position was obtained from the user's manually-set location.

(Starting with Windows 8.1.) The position was obtained from an IP address.

(Starting with Windows 10, version 1607.) The position was obtained via the coarse location feature and was therefore intentionally made inaccurate to a degree.

The position was obtained from satellite data.

(Starting with Windows 8.1.) The position was obtained from an unknown source.

The position was obtained from Wi-Fi network data.

Indicates the ability of the Geolocator object to provide location data.

Location settings are turned off. This status indicates that the user has not granted the application permission to access location.

Location services is initializing. This is the status if a GPS is the source of location data and the GPS receiver does not yet have the required number of satellites in view to obtain an accurate position.

No location data is available from any source. LocationStatus will have this value if the application calls GetGeopositionAsync or registers an event handler for the PositionChanged event, before data is available from a location sensor. Once data is available LocationStatus transitions to the **Ready** state.

Location services is not available on this version of Windows.

An operation to retrieve location has not yet been initialized. LocationStatus will have this value if the application has not yet called GetGeopositionAsync or registered an event handler for the PositionChanged event. LocationStatus may also have this value if your app doesn’t have permission to access location.

Location data is available.

Provides information for the StatusChanged event.

The updated status of the Geolocator object.

The updated status of the Geolocator object. The status indicates the ability of the Geolocator to provide location updates.

Represents the venue associated with a geographic location.

Gets the identifier (ID) of the venue.

The identifier (ID) of the venue.

Gets the identifier (ID) of the building level.

The identifier (ID) of the building level.

Contains values that describe the intended scope of location monitoring for use with the Visits feature.

Monitor only the Visit-related events that concern changes in city-sized areas.

Monitor all Visit-related events that concern changes in building-sized areas.

Contains values that describe a Visit-related state change.

The user arrived at a Visit.

The user departed from a Visit.

The user moved significantly since the last Visit.

The device is unable to track location at this time.

Contains the functionality to define a geofence (a geographical area of interest) to monitor.

Initializes a new Geofence object given the *id* and the shape of the geofence.

The Id of the geofence. The area that defines the geofence to monitor.

Initializes a new Geofence object given the *id*, the shape of the geofence, the states to monitor the geofence for, and the *singleUse* flag.

The Id of the geofence. The area that defines the geofence to monitor. The states to monitor the geofence for. True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses.

Initializes a new Geofence object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, and the *dwellTime* for the geofence.

The Id of the geofence. The area that defines the geofence to monitor. The states to monitor the geofence for. True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. The time that a position has to be in or out of the geofence in order for the notification to be triggered. This object must represent a positive value.

Initializes a new Geofence object given the *id*, the shape of the geofence, the states to monitor the geofence for, the *singleUse* flag, the *dwellTime* for the geofence, the time to start monitoring the geofence, and the *duration* of the geofence.

The Id of the geofence. The area that defines the geofence to monitor. The states to monitor the geofence for. True indicates the geofence should be monitored only for one use. False indicates the geofence should be monitored for multiple uses. The time that a position has to be in or out of the geofence in order for the notification to be triggered.This object must represent a positive value. The time to start monitoring the geofence. The duration of time to monitor the geofence for. The duration begins at the *startTime*. This object must represent a positive value.

Gets the time window, beginning after the StartTime, during which the Geofence is monitored.

The time window, beginning after the StartTime, during which the Geofence is monitored.

The minimum time that a position has to be inside or outside of the Geofence in order for the notification to be triggered.

The minimum time that a position has to be inside or outside of the geofence in order for the notification to be triggered.

The shape of the geofence region.

The shape of the geofence region.

The id of the Geofence.

The id of the geofence.

Indicates the states that the Geofence is being monitored for.

The states that the geofence is being monitored for.

Indicates whether the Geofence should be triggered once or multiple times.

**True** indicates the geofence should be monitored only for one use. **False** indicates the geofence should be monitored for multiple uses.

The time to start monitoring the Geofence.

The time to start monitoring the geofence. The default value is 0, which is the beginning of time, epoch.

Contains the information about the monitored Geofence objects.

Gets the GeofenceMonitor object which contains all of an app's Geofence information.

Gets the GeofenceMonitor object which contains all of an app's geofence information.

Returns a vector of the app's Geofence objects currently registered with the system-wide GeofenceMonitor.

A collection of the Geofence objects to monitor.

Last reading of the device's location.

Last reading of the device's location.

Indicates the current state of the GeofenceMonitor.

Indicates the current state of a GeofenceMonitor.

Raised when the state of one or more Geofence objects in the Geofences collection of the GeofenceMonitor has changed

Raised when the status of the GeofenceMonitor has changed.

Gets a collection of status changes to the Geofence objects in the Geofences collection of the GeofenceMonitor.

collection of status changes to the Geofence object(s) in GeofenceMonitor.

Indicates the current state of a GeofenceMonitor.

Access to location is denied.

The monitor is in the process of initializing.

There is no data on the status of the monitor.

The geofence monitor is not available.

The geofence monitor has not been initialized.

The monitor is ready and active.

Indicates the reason a Geofence was removed.

The duration of the geofence has expired.

The geofence event was triggered and the geofence was used.

Indicates the current state of a Geofence.

The device has entered the geofence area.

The device has left the geofence area.

No flag is set.

The geofence was removed.

Contains the information about the state changes for a Geofence.

The Geofence object whose state has changed.

The Geofence object whose state has changed.

The position of the Geofence object whose state has changed.

The position of the Geofence object whose state has changed.

The new state of the Geofence object whose state has changed.

The new state of the Geofence object whose state has changed.

Indicates the reason a Geofence was removed.

Indicates the reason a geofence was removed.

Indicates the state or states of the Geofences that are currently being monitored by the system.

The device has entered a geofence area.

The device has left a geofence area.

No flag is set.

The geofence has been removed.

Provides a set of well-known haptic waveform types (based on the Haptic Usage Page HID specification.

Gets a buzz waveform that is generated continuously without interruption until terminated.

An unsigned 16-bit waveform ID (0x1004/4100), based on the Haptic Usage Page HID specification.

Gets a click waveform.

An unsigned 16-bit waveform ID (0x1003/4099), based on the Haptic Usage Page HID specification.

Gets a press waveform.

An unsigned 16-bit waveform ID (0x1006/4102), based on the Haptic Usage Page HID specification.

Gets a release waveform.

An unsigned 16-bit waveform ID (0x1007/4103), based on the Haptic Usage Page HID specification.

Gets a rumble waveform that is generated continuously without interruption until terminated.

An unsigned 16-bit waveform ID (0x1005/4101), based on the Haptic Usage Page HID specification.

Provides access to a single haptic input device.

Gets the identifier for the haptic input device.

The Global Unique Identifier (GUID) used to identify a single input device.

Gets whether the haptic input device supports feedback intensity.

**true** if feedback intensity is supported. Otherwise, **false**.

Gets whether the haptic input device supports feedback counts.

**true** if feedback counts are supported. Otherwise, **false**.

Gets whether the haptic input device supports feedback duration.

**true** if duration is supported. Otherwise, **false**.

Gets whether the haptic input device supports pause intervals between feedback cycles.

**true** if intervals are supported. Otherwise, **false**.

Gets the types of feedback supported by the haptic input device.

The collection of feedback types supported, including behavior such as duration.

Start haptic feedback by the input device.

The type of haptic feedback.

Start haptic feedback by the input device with the specified intensity.

The type of haptic feedback. The strength of the haptic feedback based on the capability of the input device.

Start haptic feedback by the input device and continue for the specified amount of time.

The type of haptic feedback. The strength of the haptic feedback based on the capability of the input device. The time period expressed in 100-nanosecond units (1 = 100ns).

Start haptic feedback by the input device and repeat for the specified number of times.

The type of haptic feedback. The strength of the haptic feedback based on the capability of the input device. The number of times to repeat the haptic feedback. The time period between feedback cycles, expressed in 100-nanosecond units (1 = 100ns).

Terminates haptic feedback by the input device.

Provides access to the feedback behaviors supported by the haptic input device.

Gets the feedback duration for the haptic input device.

The time period, expressed in 100-nanosecond units.

Gets the haptic waveform type for the haptic input device.

An unsigned 16-bit waveform ID (based on the Haptic Usage Page HID specification.

Specifies the access rights to the vibration device.

Vibration enabled.

Vibration disabled for energy saving.

Vibration disabled by system.

Vibration disabled by user.

Provides access to a device that supports vibration notifications only.

Gets the identifier for the vibration device.

The Global Unique Identifier (GUID) used to identify a single input device.

Gets a reference to a SimpleHapticsController object to specify haptic feedback behavior.

The haptic input device.

Asynchronously retrieves all vibration devices detected.

The collection of VibrationDevices detected.

Asynchronously retrieves the vibration device specified.

The Global Unique Identifier (GUID) used to identify a single input device. The VibrationDevice from the specified identifier.

Asynchronously retrieves the default vibration device.

The default VibrationDevice.

Returns the class selection string that you can use to enumerate vibration devices.

The class selection string for vibration devices.

Asynchronously retrieves the access status of the vibration device.

The VibrationAccessStatus.

Represents a simple Boolean control on a HID device that returns on/off values. An example would be the LED light on a keyboard.

Gets a description of the given Boolean control.

A **HidBooleanControlDescription** object.

Gets the identifier for a given Boolean control.

The control identifier.

Gets a Boolean value indicating whether the given Boolean control is active.

True, if the control is active; otherwise, false.

Gets the usage identifier associated with the given Boolean control.

The usage identifier.

Gets the usage page for a given Boolean control.

The usage page.

Describes a Boolean control for a given HID device.

Gets the identifier for a given Boolean control.

The control identifier.

Gets a value indicating whether the given boolean control values are absolute or relative (change in value from that previously reported).

True if the values are absolute; false if the values are relative.

Gets the parent collection for a given Boolean control.

The control's parent collection.

Gets the report ID of the HID report that contains the usage or usage range for the given Boolean control.

The report identifier.

Gets the type of HID report associated with the given Boolean control.

One of the report types: HidFeatureReport, HidInputReport, or HidOutputReport.

Gets the usage identifier associated with the given Boolean control.

The usage identifier.

Gets the usage page associated with the given Boolean control.

The usage page.

Retrieves the collection information for a group of related controls.

Gets the identifier for a collection of HID controls.

The collection identifier.

Gets the collection type.

A **HidCollectionType** object.

Gets the usage identifier for the given control collection.

The usage identifier.

Gets the usage page for the given control collection.

The usage page.

Identifies the relationship that defines a grouping of controls on the device.

The controls are related by intended application.

The controls are logically related.

The controls are related by a named array.

The control relationship is not described by a defined category.

The controls are related by physical source.

The controls are related by report type.

The controls are related by a usage modifier.

The controls are related by a usage switch.

Represents a top-level collection and the corresponding device.

Gets the product identifier for the given HID device.

The product identifier.

Gets the usage identifier for the given HID device.

The usage identifier.

Gets the usage page of the top-level collection.

The usage page.

Gets the vendor identifier for the given HID device.

The vendor identifier.

Gets the version, or revision, number for the given HID device.

The version number.

Establishes an event listener to handle input reports issued by the device when either GetInputReportAsync() or GetInputReportAsync(System.UInt16 reportId) is called.

Closes the connection between the host and the given HID device.

Creates the only, or default, feature report that the host will send to the device.

A **HidFeatureReport** object.

Creates a feature report, identified by the *reportId* parameter, that the host will send to the device.

Identifies the report being created. A **HidFeatureReport** object.

Creates the only, or default, output report that the host will send to the device.

A **HidOutputReport** object.

Creates an output report, identified by the *reportId* parameter, that the host will send to the device.

Identifies the report being created. A **HidOutputReport** object.

Opens a handle to the device identified by the *deviceId* parameter. The access type is specified by the *accessMode* parameter.

The DeviceInformation ID that identifies the HID device. Specifies the access mode. The supported access modes are Read and ReadWrite. A **HidDevice** object.

Retrieves the descriptions of the boolean controls for the given HID device.

Specifies the type of report for which the control descriptions are requested. Identifies the usage page associated with the controls. Identifies the usage associated with the controls. A vector of HidBooleanControlDescription objects.

Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage* and *usageId*.

Specifies the usage page of the top-level collection for the given HID device. Specifies the usage identifier of the top-level collection for the given HID device. An Advanced Query Syntax (AQS) string that represents a device selector.

Retrieves an Advanced Query Syntax (AQS) string based on the given *usagePage*, *usageId*, *vendorId*, and *productId*.

Specifies the usage page of the top-level collection for the given HID device. Specifies the usage identifier of the top-level collection for the given HID device. Identifies the device vendor. Identifies the product. An Advanced Query Syntax (AQS) string that represents a device selector.

Asynchronously retrieves the first, or default, feature report from the given HID device.

A **HidFeatureReport** object.

Asynchronously retrieves a feature report, identified by the *reportId* parameter, for the given HID device.

Identifies the requested feature report. A **HidFeatureReport** object.

Asynchronously retrieves the default, or first, input report from the given HID device.

A **HidInputReport** object.

Asynchronously retrieves an input report, identified by the *reportId* parameter, from the given HID device.

Identifies the requested input report. A **HidInputReport** object.

Retrieves the descriptions of the numeric controls for the given HID device.

Specifies the type of report for which the control descriptions are requested. Identifies the usage page associated with the controls. Identifies the usage associated with the controls. A vector of HidNumericControlDescription objects.

Sends an feature report asynchronously from the host to the device.

The feature report which the host sends to the device. The result of the asynchronous operation.

Sends an output report asynchronously from the host to the device.

The output report which the host sends to the device. Specifies the count of bytes written to the device.

Represents a HID Feature Report.

Gets or sets the data associated with a given feature report.

The feature-report data.

Gets the identifier associated with a given feature report.

The feature report identifier.

Retrieves the Boolean control associated with the usagePage and *usageId* parameter and found in the given feature report.

The usage page of the top-level collection for the given HID device. The usage identifier of the top-level collection for the given HID device. A **HidBooleanControl** object.

Retrieves the Boolean control described by the *controlDescription* parameter and found in the given feature report.

A **HidBooleanControlDescription** object. A **HidBooleanControl** object.

Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given feature report.

The usage page of the top-level collection for the given HID device. The usage identifier of the top-level collection for the given HID device. A **HidNumericControl** object.

Retrieves the numeric control described by the *controlDescription* parameter and found in the given feature report.

A **HidNumericControlDescription** object. A **HidNumericControl** object.

Represents a HID Input Report.

Gets the currently activated Boolean controls for the given HID device.

A collection of Boolean controls.

Gets the data associated with a given input report.

The input-report data.

Gets the identifier associated with a given input report.

The input report identifier.

Gets the recently transitioned Boolean controls for the given HID device.

A collection of Boolean controls.

Retrieves the Boolean control associated with the *usagePage* and *usageId* parameter and found in the given input report.

The usage page of the top-level collection for the given HID device. The usage identifier of the top-level collection for the given HID device. A **HidBooleanControl** object.

Retrieves the Boolean control described by the *controlDescription* parameter and found in the given input report.

A **HidBooleanControlDescription** object. A **HidBooleanControl** object.

Retrieves the numeric control associated with the *usagePage* and *usageId* parameters and found in the given input report.

The usage page of the top-level collection for the given HID device. The usage identifier of the top-level collection for the given HID device. A **HidNumericControl** object.

Retrieves the numeric control described by the *controlDescription* parameter and found in the given input report.

A **HidNumericControlDescription** object. A **HidNumericControl** object.

Represents the arguments which the HID API sends as part of an input-report event.

Gets the input report.

A **HidInputReport** object.

Represents a numeric control on a HID device that returns a range of values. An example would be the volume control on a speaker.

Gets a control description for the given numeric control.

A **HidNumericControlDescription** object.

Gets the identifier for the given numeric control.

The control identifier.

Gets a Boolean value that indicates whether the given numeric control is grouped with other, related controls.

True, if grouped; otherwise, false.

Gets or sets a scaled numeric-value for the given control.

The scaled value.

Gets the usage identifier for the given numeric control.

The usage identifier.

Gets the usage page for the given numeric control.

The usage page.

Gets or sets the numeric value for a given control.

The control value.

Describes a numeric control for a given HID device.

Gets a Boolean value which indicates whether the control supports a null, or out-of-range, value.

True, if the control supports a null value; otherwise, false.

Gets the identifier for a given numeric control.

Identifies the control.

Gets a value indicating whether the given numeric control values are absolute or relative (change in value from that previously reported).

True, if the values are absolute; false if the values are relative.

Gets the highest possible value for the given control.

The signed upper bound.

Gets the lowest possible value for the given control.

The signed lower bound.

Gets the parent collections for a given numeric control.

A vector of **HidCollection** objects.

Gets the highest possible value for the given control after scaling is applied to the LogicalMaximum value.

The signed upper bound.

Gets the lowest possible value for the given control after scaling is applied to the LogicalMinimum value.

The signed lower bound.

Gets the number of reports associated with the given control.

The number of reports.

Gets the report ID of the HID report that contains the usage or usage range for the given numeric control.

The report identifier.

Gets the size of the data field for the usage in a report.

The data field size (in bits).

Gets the type of HID report associated with the given numeric control.

One of the report types: HidFeatureReport, HidInputReport, or HidOutputReport.

Specifies the units of the usage, as described by the USB HID Standard.

The usage unit.

Gets the unit exponent for the given numeric control.

The unit exponent.

Gets the usage identifier associated with the given numeric control.

The usage identifierl.

Gets the usage page associated with the given numeric control.

The usage page.

Represents a HID Output Report.

Gets or sets the data associated with a given output report.

The output report data.

Gets the identifier associated with a given output report.

The output report identifier.

Retrieves the boolean control associated with the given *usagePage* and *usageId*.

The usage page associated with the given control. The usage identifier associated with the given control. A **HidBooleanControl** object.

Retrieves the boolean control associated with the given *controlDescription*.

Describes the Boolean control. A **HidBooleanControl** object.

Retrieves the numeric control associated with the given *usagePage* and *usageId*.

The usage page associated with the given control. The usage identifier associated with the given control. A **HidNumericControl** l object.

Retrieves the numeric control associated with the given *controlDescription*.

Describes the numeric control. A **HidNumericControl** object.

Specifies a HID report type.

The report is a Feature Report.

The report is an Input Report.

The report is an Output Report.

Supports the ability to determine the capabilities of any connected hardware keyboards.

Initializes a new instance of the KeyboardCapabilities class.

Gets a value that indicates whether a device identifying itself as a keyboard is detected.

Returns 1 if a device identifying itself as a keyboard is detected. Otherwise, returns 0.

Supports the ability to determine the capabilities of any connected mouse devices.

Initializes a new instance of the MouseCapabilities class.

Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that tilts left and right (usually for horizontal scrolling).

The number of horizontal wheels detected. Typically 0 or 1.

Gets a value that indicates whether a mouse device is detected.

The number of mouse devices detected. Typically 0 or 1.

Gets a value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons.

A value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons.

Gets a value indicating whether any of the mice connected to the computer has swapped left and right buttons.

A value indicating whether any of the mice connected to the computer has swapped left and right buttons.

Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that rolls up and down (usually for vertical scrolling).

The number of vertical wheels detected. Typically 0 or 1.

Identifies the change in screen location of the mouse pointer, relative to the location of the last mouse event.

The x-coordinate of the mouse pointer, relative to the location of the last mouse event.

The y-coordinate of the mouse pointer, relative to the location of the last mouse event.

Supports the ability to identify and track connected mouse devices.

Occurs when the mouse pointer is moved.

Retrieves the mouse device that is associated with the current view.

The mouse device.

Contains event data for the MouseMoved event.

Gets a value that indicates the change in the screen location of the mouse pointer since the last mouse event.

The change in screen location of the mouse pointer, relative to the location of the last mouse event.

Provides access to button action event notifications from a connected pen device.

Occurs when the availability of pen button events changes (pen settings are changed by the user or system support changes).

Occurs when the user presses and releases (clicks) the button on the tail end of the pen.

Occurs when the user presses and releases (clicks) the button on the tail end of the pen twice in quick succession.

Occurs when the user presses and holds the button on the tail end of the pen.

Retrieves the default listener for pen button events.

An object that represents a listener for pen button events in the default context.

Retrieves whether pen button action event notifications are currently supported.

True, if currently supported. Otherwise, false.

Supports the ability to identify and track connected pen devices.

Gets the unique identifier of the digital pen represented by the PenDevice object.

A **Guid** that uniquely identifies the device.

Obtains a PenDevice object associated with the specified pointer, if available.

The unique pointer identifier associated with the pointer event. A PenDevice object.

Contains event data for the PenDockListener.Docked event.

Provides access to docking state event notifications from a connected pen device.

Occurs when the user docks a pen.

Occurs when the availability of pen docking event changes (pen settings are changed by the user or system support changes).

Occurs when the user undocks a pen.

Retrieves the default listener for pen dock events.

An object that represents a listener for pen dock events in the default context.

Retrieves whether pen docking state event notifications are currently supported.

True, if currently supported. Otherwise, false.

Contains event data for the PenButtonListener.TailButtonClicked event.

Contains event data for the PenButtonListener.TailButtonDoubleClicked event.

Contains event data for the PenButtonListener.TailButtonLongPressed event.

Contains event data for the PenDockListener.Undocked event.

Supports the ability to identify the connected pointer devices and determine their capabilities.

Gets a value indicating whether the pointer device is an integrated device. For example, a video display with an integrated touch digitizer compared to an external pen/stylus digitizer.

True if the pointer device is integrated; otherwise, false.

Gets a value indicating the maximum number of contacts supported by the input device.

The number of contacts.

Gets the maximum number of hover contacts supported by the input device.

The default value is 0.

Gets the coordinates of the bounding rectangle supported by the input device.

The bounding rectangle at 96 dots per inch (dpi).

Gets the pointer device type.

A pointer device type.

Gets the screen coordinates that are mapped to the bounding rectangle supported by the input device.

The screen coordinates, in device-independent pixel (DIP).

Gets a collection containing the supported pointer device usages.

A collection containing the supported pointer device usages.

Gets information about the pointer device associated with the specified input pointer ID.

The ID of the pointer input. The PointerDevice object that represents the associated pointer device.

Gets information about the pointer devices attached to the system.

The collection of PointerDevice objects that represent the pointer devices attached to the system.

Enumerates pointer device types.

Mouse

Pen

A touch-enabled device

Identifies the Human Interface Device (HID) usage details for the input device.

The maximum logical value for **Usage**.

The maximum physical value for **Usage**.

The minimum logical value for **Usage**.

The minimum physical value for **Usage**.

The multiplier used to convert the usage value reported by the device to a physical value in units of **Unit**. (Valid only for usages that indicate a static or dynamic value associated with a control, such as pressure or width and height of the touch contact.)

The Human Interface Device (HID) unit of measure.

The Human Interface Device (HID) pointer device usage ID that specifies a device or property in the **UsagePage**. For example, 0x04 indicates a touch screen device and 0x47 indicates touch confidence.

The Human Interface Device (HID) usage page of the pointer device. Human Interface Device (HID) usages are organized into usage pages that specify classes of related devices. For example, touch digitizers (0x0D) and generic input (0x01).

Supports the ability to determine the touch capabilities of any connected touch digitizers.

Initializes a new instance of the TouchCapabilities class.

Gets the minimum number of contacts supported by all the digitizers.

Gets the minimum number of contacts supported by all the digitizers.

Gets a value that indicates whether a touch digitizer is detected.

The number of touch digitizers detected. Typically 0 or 1.

Specifies the possible configuration states of an eye-tracking device.

The eye-tracker device is currently being configured.

The eye-tracker device is ready to start eye and head tracking.

The display device is not configured correctly. Calibration might resolve this state.

The eye-tracker device state is unknown. Calibration might resolve this state.

The eye-tracker device needs to be calibrated.

Supports the ability to identify and manage all connected eye-tracker devices.

Gets whether the eye-tracking device can detect and track the user's eyes.

True, if the device can track the user's eyes; otherwise, false.

Gets whether the eye-tracking device can detect and track the user's head.

True, if the device can track the user's head; otherwise, false.

Gets the configuration state of the eye-tracking device.

The congiguration state.

Gets a unique identifier for the eye-tracking device.

The unique identifier.

Retrieves the boolean control descriptions for the eye-tracking device.

The usage page for the eye-tracking device. The usage identifier for the eye-tracking device. A vector of HidNumericControlDescription objects.

Retrieves the numeric control description for the eye-tracking device.

The usage page for the eye-tracking device. The usage identifier for the eye-tracking device. A vector of HidNumericControlDescription objects.

Asynchronously requests the eye-tracking device start its calibration process.

True, if calibration completes successfully; otherwise, false.

Provides event data for the GazeDeviceWatcherPreview.Added event.

Gets a reference to the eye-tracker device being monitored through the GazeDeviceWatcherPreview object.

Dynamically detects and enumerates eye-tracking devices, and receives event notifications when a device is added, removed, or updated after the initial enumeration.

Occurs when a new eye-tracker device is detected.

Occurs when the GazeDeviceWatcherPreview finishes identifying the connected eye-tracker devices.

Occurs when an existing eye-tracker device is no longer detected.

Occurs when an update is made to an existing eye-tracker device, such as calibration.

Starts monitoring the state of an eye-tracker device.

Stops monitoring the state of an eye-tracker device.

Provides event data for the GazeDeviceWatcherPreview.Removed event.

Gets a reference to the eye-tracker device being monitored through the GazeDeviceWatcherPreview object.

Provides event data for the GazeDeviceWatcherPreview.Updated event.

Gets a reference to the eye-tracker device being monitored through the GazeDeviceWatcherPreview object.

Provides event data for the GazeEntered event.

Gets the gaze pointer data from the most recent GazeEntered event.

The gaze pointer data from the most recent GazeEntered event.

Gets or sets a value that indicates whether the GazeEntered has been handled.

Provides event data for the GazeExited event.

Gets the gaze pointer data from the most recent GazeExited event.

The gaze pointer data from the most recent GazeExited event.

Gets or sets a value that indicates whether the GazeExited has been handled.

Represents the eyes and head of the user identified by an eye-tracking device.

Occurs when the eye-tracking device detects that the gaze point has entered the bounding area of the element.

Occurs when the eye-tracking device detects that the gaze point has moved outside the bounding area of the element.

Occurs when the eye-tracking device detects eye movement and the gaze pointer remains within the bounding rectangle of the element.

Creates an object for monitoring the state of the eye-tracker device associated with the current view.

Retrieves a reference to the user identified by an eye-tracking device, bound to the active application.

A GazeInputSourcePreview object bound to the active application.

Provides event data for the GazeMoved event.

Gets the gaze pointer data from the most recent GazeMoved event.

A gaze pointer object.

Gets or sets a value that indicates whether the GazeMoved event has been handled.

**true** to mark the event handled. **false** to leave the event unhandled, which permits the event to potentially be acted on by other handlers. The default is **false**.

Retrieves the gaze point data for each gaze location logged since the most recent GazeMoved event, up to and including the current event.

A collection of gaze point objects.

Provides basic properties for the gaze input point associated with a single eye-tracking device.

Gets the location, derived from the position and orientation of the user's eyes, of the gaze point.

The screen coordinates of the gaze point are in device-independent pixels (DIP) relative to, and constrained by, the application view (or gaze-enabled element).

Gets the location, derived from the user's head position and orientation, of the gaze point.

The screen coordinates of the gaze point are in device-independent pixels (DIP) relative to, and constrained by, the application view (or gaze-enabled element).

Gets a Human Interface Device (HID) input report for the eye-tracking device.

A HidInputReport object.

Gets information about the eye-tracking device associated with the gaze input.

A reference to the eye-tracking device.

Gets the time of the gaze point input event.

The time, relative to the system boot time, in microseconds.

Represents a lamp device.

Gets or sets a value indicating the current brightness level of the lamp, where 0.0 is completely off and 1.0 is maximum brightness.

A value indicating the current brightness level of the lamp.

Gets or sets the color of the lamp.

The color of the lamp.

Gets the DeviceInformation Id for a lamp device.

The DeviceInformation Id for a lamp device.

Gets a value indicating whether you can set the Color property of the lamp device.

True if you can set the Color property of the lamp; otherwise, false.

Gets a value indicating whether the lamp device is enabled.

True if the lamp is enabled; otherwise, false.

Occurs when the availability of the lamp device changes.

Releases the lamp device.

Gets a Lamp object representing the lamp device with the specified ID.

The ID of the requested lamp device. An asynchronous operation that returns a Lamp object upon successful completion.

Gets a Lamp object representing the default lamp for the device.

An asynchronous operation that returns a Lamp object upon successful completion.

Returns the class selection string that you can use to enumerate lamp devices.

The class selection string for lamp devices.

Represents a LampArray device attached the system. Currently, only HID LampArrays are supported.

Gets the logical bounding box encompassing the LampArray.

The value of the bounding box.

Gets or sets the overall brightness of the LampArray, where 0.0 is completely off and 1.0 is maximum brightness.

The current brightness level of the LampArray. Default is 1.0.

Gets the plug and play (PnP) device identifier of the underlying LampArray device.

The plug and play (PnP) device identifier of the underlying LampArray device.

The hardware product Id of the underlying device.

The hardware product Id.

The hardware vendor Id of the underlying device.

The hardware vendor Id.

The hardware version of the underlying device.

The hardware version.

Gets a value indicating whether the LampArray device is connected to the system.

True if the LampArray is connected; otherwise, false.

Gets or sets the enabled state.

True if the device is enabled; otherwise false.

The LampArrayKind describing this device.

The LampArrayKind for the device.

The number of lamps part of this LampArray.

The number of lamps in the LampArray.

Minimal interval (required by the device) between the system sending two updates for any one lamp. This is comparable to the effective device refresh rate.

The time interval between updates for a lamp.

Boolean indicating whether any lamp is mapped to a virtual key.

Returns true if any lamp on the LampArray is mapped to a virtual key.

Retrieves a LampArray object asynchronously for the LampArray device that has the specified plug and play (PnP) device identifier/device instance path.

The device identifier/device instance path of the device. To obtain the value, get the DeviceInformation.Id property value retrieved from DeviceWatcher Returns an `IAsyncOperation(LampArray)` object that returns the results of the operation.

Retrieves an Advanced Query Syntax (AQS) string encompassing all LampArray devices on the system.

An AQS string encompassing all LampArray devices on the system.

Searches for all lamp indices that are bound to the specific VirtualKey

The VirtualKey. Array of all lamp indices that are bound to the specific VirtualKey. Array is empty if no lamp indices are found bound to the VirtualKey.

Searches for all lamp indices that are bound to the specified LampPurposes.

The LampPurposes. Array of all lamp indices that are bound to the specific LampPurposes. Array is empty if no lamp indices are found bound to the LampPurposes.

Fetches the LampInfo corresponding to the lamp index.

The index. Must be between 0 and LampCount - 1. The LampInfo corresponding to lampIndex.

Asynchronously retrieves an IBuffer representing the message identified by the message identifer argument.

The identifer of a message. An asynchronous object which, on completion, contains the requested message.

Asynchronously sends a message identified by the message identifer argument.

The identifer of a message. An IBuffer representing the message. An asynchronous object, which can be awaited.

Sets every lamp belonging to the LampArray to the desired color.

Desired color to set every lamp to.

Sets the lamp corresponding to the index to the desired color.

The lamp index. The desired color.

Sets the color for multiple lamps. Position within each array maps lamp index to desired color.

Array of desired colors. Array of corresponding lamp indexes to modify.

Sets the color for all lamps that map to the key. Multiple lamps can map to the same key.

The desired color. The VirtualKey.

Sets the color of multiple lamps, corresponding to mapped keys. Position within each array maps keys to desired color.

Array of desired colors. Array of corresponding VirtualKeys to modify.

Sets the color of multiple lamps, corresponding to LampPurposes.

Array of desired colors. Array of corresponding LampPurposes to modify.

Sets all lamps specified to the same color.

The desired color. Array of lamp indexes to set.

The type of physical device the LampArray is part of.

Is embedded in an artwork (for example, painting, sculpture).

Is part of an internal PC case component (for example, RAM-stick, motherboard, fan).

Is embedded in a piece of furniture (for example, chair, desk, bookcase).

Is part of a game controller (for example, gamepad, flightstick, sailing simulation device).

Is part of a keyboard or keypad.

Is part of a mouse.

Is part of a notification device.

Is part of a more general peripheral/accessory (for example, speakers, mousepad, microphone, webcam).

Illuminates a room/performance-stage/area (for example, room light-bulbs, spotlights, washlights, strobelights, booth-strips, billboard/sign, camera-flash).

No Kind specified for this device.

Is embedded in a wearable accessory (for example, audio-headset, wristband, watch, shoes).

Provides data for the AvailabilityChanged event.

Gets a value indicating whether the lamp device that triggered the event is available.

True if the lamp device is available; otherwise, false.

Container of various properties of an individual lamp for a specific index.

The number of blue intensities settable for this lamp.

The count of blue levels.

If this lamp index has a fixed color, the color is returned; otherwise null.

The lamp color.

The number of color independent intensities settable for this lamp.

The intensity value settable for the lamp.

The number of green intensities settable for this lamp.

The count of green levels.

Zero based index of the lamp. Every lamp is associated with one unique index.

The lamp index.

3D position of the lamp relative to the origin of the bounding-box.

The position of the lamp.

Purpose/s of the lamp.

The lamp purposes.

The number of red intensities settable for this lamp.

The count of red levels.

Time between the device receiving an update for a lamp and it emanating from the device.

The time value between receiving an update and emanating from the device.

Finds the nearest/closest matching color to the desired color, supported by this lamp. Call this to know whether a specific color will be applied during (e.g.) LampArray.SetColor

The color to find the nearest/closest. The nearest/closest color supported by this lamp.

Purpose/s of a lamp.

Accent Lamp that doesn't interact with the user (for example, case fan LED, illuminated side panels on a keyboard).

Device branding (for example, manufacturer logo).

Control Lamp (for example, button/key/slider)

Illuminates an object that is outside of the LampArray (for example, stage spotlight, car headlights, camera flash).

A lamp the user directly looks at (for example, within an artwork or costume).

Status lamp (for example, unread email, CPU temperature).

No Purposes defined for this lamp.

The base interface for lamp array effects.

Gets and sets the front-to-back z-index of a lamp array effect within a collection.

The front-to-back z-index of a lamp array effect within a collection.

Renders a series of images to selected lamp indexes on the device.

Creates and initializes a new instance of the effect.

The LampArray the effect is played on. Subset of lamp indexes that effect will apply to.

Gets or sets the duration of the effect.

Default value is 0.

Gets or sets the duration to delay before starting the effect.

Default value is 0.

Gets the most suitable image size for the caller selected lamp indexes that results in minimal scaling/distortion.

The image size.

Gets or sets the interval between the triggering of the BitmapRequested event. The supplied image will be displayed until the event is next triggered.

Time interval between updates. Default value is 0.

Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same LampArray ).

Default value is 0.

Event triggered by the system to indicate a new image should be supplied to the effect.

Provides event data for the BitmapRequested event.

Gets the time since the effect was started.

Time value since the effect was started.

Sets previously specified lamp/s indexes according to the caller defined image.

The image form which to update the lamp/s. If `null`, all lamps are to set off/Black

Blinks lamp/s a color for a specific duration. Timing of attack/sustain/decay phases can be defined.

Creates and initializes a new instance of the effect.

The LampArray the effect is played on. Subset of lamp indexes that effect will apply to.

Gets or sets the time spent attacking/ramping-up from off/Black to peak intensity.

Default value is 0.

Gets or sets the color of peak intensity for the effect. Duration color is visible defined by SustainDuration.

Default is Black

Gets or sets the time spent decaying/ramping-down from peak intensity to off/Black.

Default value is 0.

Number of occurrences this effect will play.

Default value is 0.

Gets or sets the delay between effect repetitions.

Default value is 0.

Gets or sets the repetition behavior of the effect.

Default is Occurrences

Gets or sets the duration to delay before starting the effect.

The time value to delay the start of an effect. Default value is 0.

Gets or sets the time spent displaying peak intensity for the effect.

Time value of time spent displaying peak intensity of an effect. Default value is 0.

Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same LampArray ).

Global precedence value. Default value is 0.

Transitions lamp/s from their existing color (whatever last set to), to the prescribed color.

Creates and initializes a new instance of the effect.

The LampArray the effect is played on. Subset of lamp indexes that effect will apply to.

Gets or sets the color of peak intensity for the effect.

Color value of the peak intensity for the effect.

Gets or sets the behavior when effect completes.

Default is ClearState

Gets or sets the time spent ramping-up to peak intensity from the previously set color.

Time value of time spent ramping-up to peak intensity.

Gets or sets the duration to delay before starting the effect.

Time value of duration before an effect starts.

The global precedence for two effects that modify the same lamp.

Default value is 0.

This effect provides an entry-point for developer-defined custom effects into the effect framework; allowing it to be included and scheduled within playlists.

Creates and initializes a new instance of the effect.

The LampArray the effect is played on. Subset of lamp indexes that effect will apply to.

Gets or sets the duration of the effect.

Time value of the duration. Default value is 0.

Gets or sets the interval between the triggering of the UpdateRequested event. The supplied image will be displayed until the event is next triggered.

Time span value of the update interval. Default value is 0.

The global precedence for two effects that modify the same lamp.

Value of the global precedence. Default value is 0.

Event triggered by the system to indicate that lamp state should be modified.

Behavior when an effect completes.

Clears the state of all lamps when effect completes for the start of the next effect in the playlist. This is the typical case for most effects.

Maintains the state of all lamps when effect completes, so state is preserved for start of the next effect in the playlist. Use to seamlessly connect effects when the end state is known.

Used to either chain multiple effects together, or to start effects simultaneously.

Creates and initializes a new instance of a playlist.

Gets or sets the starting behavior for the effects.

A lamp array effect start mode specifying the starting behavior for the effects. The default is Sequential.

Gets or sets the number of occurrences that this playlist will play.

Number of occurrences. Default is 0.

Gets or sets the repetition behavior for playlist.

A LampArrayRepetitionMode value. Default is **Occurrences**.

Gets the size of (the number of elements in) the playlist.

The size of (the number of elements in) the playlist.

Appends the effect to the end of the playlist.

Effect to append to the playlist.

Retrieves an iterator representing the first item in a lamp array effect playlist.

An iterator (of ILampArrayEffect ) representing the first item in a lamp array effect playlist.

Retrieves the lamp array effect at the specified index within a playlist.

The zero-based index of the lamp array effect to retrieve. An ILampArrayEffect representing the lamp array effect at the specified index within the playlist.

Retrieves a range of lamp array effects, beginning at the specified index within a playlist.

The zero-based index of the first lamp array effect to retrieve. An array of ILampArrayEffect, which the method will update with the requested effects. The number of effects returned in *items*.

Retrieves the index, within a playlist, of the specified lamp array effect.

An ILampArrayEffect representing the lamp array effect whose index to retrieve. The index of the effect within the playlist, as an out parameter. If the *value* is found, then the method will update *index* with the zero-based index of the effect within the playlist. `true` if the effect is found, otherwise `false`.

Overrides the zIndex for all contained effects.

The overriding zIndex.

Pauses the playlist, and persists the last state set by the internally playing effect.

Guarantees that all playlists will pause at the same time.

Playlists to pause simultaneously.

Starts this playlist from the beginning, unless it was previously paused, which will then resuming playing from the paused position.

Guarantees that all playlists will start at the same time.

Playlists to start simultaneously.

Stops playing this playlist.

Guarantees that all playlists will stop at the same time.

Playlists to stop simultaneously.

Defines constants that specify the starting behavior of effects in a playlist.

Specifies that effects should be started one at a time, in the order in which they were added.

Specifies that effects should be started all at the same time.

Defines constants that specify the repetition behavior for effect/playlist.

Specifies that the effect/playlist is run forever. Can only be stopped by stopping the playlist.

Specifies that the effect/playlist is run for the defined number of times.

Displays a solid/static color for a specific duration.

Creates and initializes a new instance of the effect.

The LampArray the effect is played on. Subset of lamp indexes that effect will apply to.

Gets or sets the solid color of the effect.

The Color value. Default is Black

Gets or sets the behavior when effect completes.

Default is ClearState

Gets or sets the duration of the effect; StartDelay is not included.

Time value of the duration of an effect. Default value is 0.

Gets or sets the duration to delay before starting the effect.

Time value of the start delay. Default value is 0.

Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same LampArray ).

Default value is 0.

Provides event data for the UpdateRequested event.

Gets the time since the effect was started.

Time value of the time since the effect started.

Sets every lamp index specified in the effect to the desired color.

Desired color to set every lamp to.

Sets the lamp corresponding to the index to the desired color.

The lamp index. The desired color.

Sets the color for multiple lamps. Position within each array maps lamp index to desired color.

Array of desired colors. Array of corresponding lamp indexes to modify.

Sets all lamps specified to the same color.

The desired color. Array of lamp indexes to set.

Represents a MIDI message which is implemented by all MIDI message classes.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a single MIDI out port.

Gets the ID of the device that contains the MIDI out port.

The device ID.

Sends the contents of the buffer through the MIDI out port.

The data to send to the device.

Send the data in the specified MIDI message to the device associated with this MidiOutPort.

The MIDI message to send to the device.

Represents a MIDI message that specifies active sensing.

Creates a new MidiActiveSensingMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies the channel pressure.

Creates a new MidiChannelPressureMessage object.

The channel from 0-15 that this message applies to. The pressure from 0-127.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the pressure from 0-127.

The pressure from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a continue message.

Creates a new MidiContinueMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a control change.

Creates a new MidiControlChangeMessage object.

The channel from 0-15 that this message applies to. The controller from 0-127 to receive this message. The value from 0-127 to apply to the controller.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets controller from 0-127 to receive this message.

The controller from 0-127 to receive this message.

Gets the value from 0-127 to apply to the controller.

The value from 0-127 to apply to the controller.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a port used to receive MIDI messages from a MIDI device.

Gets the id of the device that was used to initialize the MidiInPort.

The ID of the device.

Occurs when the MidiInPort receives data.

Closes the MidiInPort.

Creates a MidiInPort object for the specified device.

The device ID, which can be obtained by enumerating the devices on the system Windows.Devices.Enumeration.DeviceInformation.FindAllAsync. The asynchronous operation. Upon completion, IAsyncOperation.GetResults returns a MidiInPort object.

Gets a query string that can be used to enumerate all MidiInPort objects on the system.

The query string used to enumerate the MidiInPort objects on the system.

Provides data for the MessageReceived event.

The MIDI message.

The MIDI message.

Specifies constants used to map MIDI message types into their corresponding byte codes.

A MidiActiveSensingMessage.

A MidiChannelPressureMessage.

A MidiContinueMessage.

A MidiControlChangeMessage.

A MidiSystemExclusiveMessage.

A MidiTimeCodeMessage.

Specifies no message type.

A MidiNoteOffMessage.

A MidiNoteOnMessage.

A MidiPitchBendChangeMessage.

A MidiPolyphonicKeyPressureMessage.

A MidiControlChangeMessage.

A MidiSongPositionPointerMessage.

A MidiSongSelectMessage.

A MidiStartMessage.

A MidiStopMessage.

A MidiSystemExclusiveMessage.

A SystemResetMessage.

A MidiTimingClockMessage.

A MidiTuneRequestMessage.

Represents a MIDI messages that specifies a MIDI note to turn off.

Creates a new MidiNoteOffMessage object.

The channel from 0-15 that this message applies to. The note which is specified as a value from 0-127. The velocity which is specified as a value from 0-127.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the note to turn off which is specified as a value from 0-127.

The note which is specified as a value from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Gets the value of the velocity from 0-127.

The velocity which is specified as a value from 0-127.

Represents a MIDI message that specifies a MIDI note to turn on.

Creates a new MidiNoteOnMessage object.

The channel from 0-15 that this message applies to. The note which is specified as a value from 0-127. The velocity which is specified as a value from 0-127.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the note to turn on which is specified as a value from 0-127.

The note which is specified as a value from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Gets the value of the velocity from 0-127.

The velocity which is specified as a value from 0-127.

Represents a port used to send MIDI messages to a MIDI device.

Gets the id of the device that was used to initialize the MidiOutPort.

The ID of the device.

Closes the MidiOutPort.

Creates a MidiOutPort object for the specified device.

The device ID, which can be obtained by enumerating the devices on the system Windows.Devices.Enumeration.DeviceInformation.FindAllAsync. The asynchronous operation. Upon completion, IAsyncOperation.GetResults returns a MidiOutPort object.

Gets a query string that can be used to enumerate all MidiOutPort objects on the system.

The query string used to enumerate the MidiOutPort objects on the system.

Send the specified data buffer to the device associated with this MidiOutPort.

The data to send to the device.

Send the data in the specified MIDI message to the device associated with this MidiOutPort.

The MIDI message to send to the device.

Represents a MIDI message that specifies a pitch bend change.

Creates a new MidiPitchBendChangeMessage object.

The channel from 0-15 that this message applies to. The pitch bend value which is specified as a 14-bit value from 0-16383.

Gets the pitch bend value which is specified as a 14-bit value from 0-16383.

The pitch bend value which is specified as a 14-bit value from 0-16383.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies the polyphonic key pressure.

Creates a new MidiPolyphonicKeyPressureMessage object.

The channel from 0-15 that this message applies to. The note which is specified as a value from 0-127. The polyphonic key pressure which is specified as a value from 0-127.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the note which is specified as a value from 0-127.

The note which is specified as a value from 0-127.

Gets the polyphonic key pressure which is specified as a value from 0-127.

The polyphonic key pressure which is specified as a value from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a program change.

Creates a new MidiProgramChangeMessage object.

The channel from 0-15 that this message applies to. The program to change from 0-127.

Gets the channel from 0-15 that this message applies to.

The channel from 0-15 that this message applies to.

Gets the program to change from 0-127.

The program to change from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a song position pointer.

Creates a new MidiSongPositionPointerMessage object.

The song position pointer encoded in a 14-bit value from 0-16383.

Gets the song position pointer encoded in a 14-bit value from 0-16383.

The song position pointer encoded in a 14-bit value from 0-16383.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies the selected song.

Creates a new MidiSongSelectMessage object.

The song to select from 0-127.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the song to select from 0-127.

The song to select from 0-127.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a start message.

Creates a new MidiStartMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a stop message.

Creates a new MidiStopMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents the Microsoft GS wavetable software synthesizer, included in Windows. This synthesizer provides a Roland GS sound set, which includes and extends the General MIDI sound set.

Gets the audio output device being used by this instance of the Microsoft MIDI synthesizer.

An object that represents the audio output device. Use the methods and properties of this object to further identify the device.

Gets the device ID of the Microsoft MIDI synthesizer. Note that all instances of the synthesizer have the same ID.

The device ID of this instance of the Microsoft MIDI synthesizer.

Gets or sets the output volume of this instance of the Microsoft MIDI synthesizer.

The synthesizer's output volume, a number between 0 and 1, inclusive.

Closes this instance of the Microsoft MIDI synthesizer. It is a best practice for the caller to use this method to clear resources used by the MIDI object.

Creates a new instance of the Microsoft MIDI synthesizer that uses the system's default audio output device.

An instance of the Windows MIDI synthesizer.

Creates a new instance of the Microsoft MIDI synthesizer with a specified audio output device.

The audio output device. An instance of the Microsoft MIDI synthesizer.

Determines whether a particular device is an instance of the Microsoft MIDI synthesizer. When all MIDI out ports on the system are enumerated, this method can be used to identify which of them is the Microsoft MIDI synthesizer.

An object that represents the device in question. **True** if the device is the Microsoft MIDI synthesizer; otherwise, **false**.

Sends an array of bytes through the synthesizer's out port. This enables you to send your data as a byte array instead of as a defined MIDI message.

The array of bytes to send.

Sends a MIDI message through the Microsoft MIDI synthesizer's out port.

The MIDI message to send.

Represents a MIDI message that specifies a system exclusive message.

Creates a new MidiSystemExclusiveMessage object.

The system exclusive data.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a system reset.

Creates a new MidiSystemResetMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a time code.

Creates a new MidiTimeCodeMessage object.

The frame type from 0-7. The time code from 0-32.

Gets the value of the frame type from 0-7.

The value of the frame type from 0-7.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Gets the time code value from 0-32.

The time code value from 0-32.

Represents a MIDI message that specifies a timing clock.

Creates a new MidiTimingClockMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Represents a MIDI message that specifies a tune request.

Creates a new MidiTuneRequestMessage object.

Gets the array of bytes associated with the MIDI message, including status byte.

The array of bytes associated with the MIDI message.

Gets the duration from when the MidiInPort was created to the time the message was received. For messages being sent to a MidiOutPort, this value has no meaning.

The duration from when the MidiInPort was created to the time the message was received.

Gets the type of this MIDI message.

The MIDI message type.

Provides static methods for retrieving intrinsic properties of a camera.

KnownCameraIntrinsicsProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the focal length of the camera.

Indicates the focal length of the camera. This property is a SingleArray value that should be interpreted as a vector.

Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the principal point, relative to the camera.

Indicates the principal point, relative to the camera. This property is a SingleArray value that should be interpreted as a vector.

Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the radial distortion of the camera.

Indicates the radial distortion of the camera. This property is a SingleArray value that should be interpreted as a vector.

Gets a string key used to retrieve an array of single-precision, floating-point property values indicating the tangential distortion of the camera.

Indicates the tangential distortion of the camera. This property is a SingleArray value that should be interpreted as a vector.

Provides static properties of color frame sources.

KnownPerceptionColorFrameSourceProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled.

Indicates whether or not auto exposure is enabled. This property is a Boolean value.

Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera.

The current exposure duration of the camera. This property is a TimeSpan value.

Gets a string key used to retrieve a single-precision, floating-point property indicating the exposure compensation.

The exposure compensation. This property is a Single value.

Provides static properties of depth frame sources.

KnownPerceptionDepthFrameSourceProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve a 16-bit unsigned integer property indicating the maximum depth of the depth frame source.

Indicates the maximum depth of the depth frame source. This property is a UInt16 value.

Gets a string key used to retrieve a 16-bit unsigned integer property indicating the minimum depth of the depth frame source.

Indicates the minimum depth of the depth frame source. This property is a UInt16 value.

Provides static properties that are applicable to all types of frame sources.

KnownPerceptionFrameSourceProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string value that identifies the device on the system.

The identifier.

Gets a string key used to look up a string property with the device, model, version string for the physical sensor device this frame source represents.

The device, model, version string for the physical sensor device this frame source represents. This property is a String value.

Gets a string key used to look up an enumeration property indicating the physical location of the sensor on the Windows device.

The physical location of the sensor on the Windows device. This is an enumeration value.

Gets a string key used to look up a string property that is a string key indicating the kind of frame the source provides.

A string key indicating the kind of frame the source provides. This property is a String value. The string key will indicate color, depth, or infrared as specified by Windows.Devices.Perception.KnownPerceptionFrameKindStatics.

Gets a string key used to look up a string property with the unique ID of the frame source.

The unique ID of the frame source. This property is a String value.

Gets a string key used to look up a string array property containing the physical device IDs of the sensor this frame source represents.

An array of strings with the physical device IDs of the sensor this frame source represents. This property is a StringArray value.

Provides static properties of infrared frame sources.

KnownPerceptionInfraredFrameSourceProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve a Boolean property indicating whether or not active IR illumination is enabled.

Indicates whether or not active IR illumination is enabled. This property is a Boolean value.

Gets a string key used to retrieve a Boolean property indicating whether or not ambient IR light subtraction is enabled.

Indicates whether or not ambient IR light subtraction is enabled. This property is a Boolean value.

Gets a string key used to retrieve a Boolean property indicating whether or not auto exposure is enabled.

Indicates whether or not auto exposure is enabled. This property is a Boolean value.

Gets a string key used to retrieve a TimeSpan property indicating the current exposure duration of the camera.

The current exposure duration of the camera. This property is a TimeSpan value.

Gets a string key used to retrieve a single-precision, floating-point property indicating the amount of exposure compensation.

Indicates the amount of exposure compensation. This property is a Single value.

Gets a string key used to retrieve a Boolean property indicating whether or not interleaved illumination is enabled.

Indicates whether or not interleaved illumination is enabled. This property is a Boolean value.

Gets a string key used to retrieve a Boolean property indicating whether or not the structured light pattern is enabled.

Indicates whether or not the structured light pattern is enabled. This property is a Boolean value.

Provides static properties of video frame sources.

KnownPerceptionVideoFrameSourceProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve a boolean property indicating the supported video profiles that are currently available.

The supported video profiles that are currently available. This property is an IInspectable value.

Gets a string key used to retrieve a CameraIntrinsics property defining the physical properties of the camera device. The CameraIntrinsics object also provides convenience methods for sensor-related geometry, including camera space to image space projections.

Returns an object representing the intrinsic physical properties of the camera.

Gets a string key used to retrieve a boolean property indicating whether or not the video frame source is providing mirrored video frames.

Indicates whether or not the video frame source is providing mirrored video frames. This property is a Boolean value.

Gets a string key used to retrieve the supported video profiles property.

The supported video profiles. This property is an IInspectable value.

Gets a string key used to retrieve the current video profile property.

The current video profile. This property is an IInspectable value.

Provides static properties of a video profile.

KnownPerceptionVideoProfileProperties may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a string key used to retrieve an enumeration property indicating the bitmap alpha mode.

The bitmap alpha mode. This property is an enumeration value.

Gets a string key used to retrieve an enumeration property indicating the bitmap pixel format.

The bitmap pixel format. This property is an enumeration value.

Gets a string key used to retrieve a TimeSpan property indicating the time duration of each frame.

The time duration of each frame. This property is a TimeSpan value.

Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame height, in pixels.

The frame height, in pixels. This property is a UInt32 value.

Gets a string key used to retrieve a 32-bit unsigned integer property indicating the frame width, in pixels.

The frame width, in pixels. This property is a UInt32 value.

Contains a Windows.Media.VideoFrame with the color frame data.

PerceptionColorFrame may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.VideoMediaFrame instead.

Gets a Windows.Media.VideoFrame with the color frame data.

A Windows.Media.VideoFrame with the color frame data.

Releases system resources that are exposed by a Windows Runtime object.

Contains information about a color frame arrived event.

PerceptionColorFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead.

Gets the relative time of this frame.

The relative time of this frame.

Attempts to open the color frame that has arrived.

PerceptionColorFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead. If the attempt is successful, this method returns the newly-arrived color frame. If the attempt is unsuccessful, this value is unchanged.

Reads color frames from a color frame source.

PerceptionColorFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead.

Gets or sets a boolean value indicating whether or not this reader is paused.

A boolean value indicating whether or not this reader is paused.

Gets the color frame source this reader gets frames from.

The color frame source this reader gets frames from.

Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the color frame source.

Releases system resources that are exposed by a Windows Runtime object.

Attempts to read the most recent frame that is available to this color frame reader.

PerceptionColorFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead. If the attempt was successful, this method returns the most recent frame that is available to this color frame reader. If the attempt was not successful, this method returns null.

A frame source that provides color frames.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.

Gets a boolean value indicating whether or not the source is active.

A boolean value indicating whether or not the source is active.

Gets a boolean value indicating whether or not the source is available.

A boolean value indicating whether or not the source is available.

Gets a read-only collection of video profiles that are currently available from the color frame source.

A read-only collection of video profiles that are currently available from the color frame source.

Gets a CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device.

A CameraIntrinsics value specifying the intrinsic properties of the color frame source camera device.

Gets a string value that identifies the device on the system.

The identifier.

Gets a string value indicating the kind of physical device that generates the color frames for this source.

A string value indicating the kind of physical device that generates the color frames for this source.

Gets a string value indicating the display name of the color frame source.

A string value indicating the display name of the color frame source.

Gets a string value indicating the unique ID of the color frame source.

A string value indicating the unique ID of the color frame source.

Gets a boolean value indicating whether or not the source is the subject of controller mode.

A boolean value indicating whether or not the source is the subject of controller mode.

Gets a read-only collection of frame source properties.

A read-only collection of frame source properties.

Gets a read-only collection of video profiles that are supported by the color frame source.

A read-only collection of video profiles that are supported by the color frame source.

Gets a PerceptionVideoProfile object indicating the current video profile.

A PerceptionVideoProfile object indicating the current video profile.

Subscribes to the ActiveChanged event.

Subscribes to the AvailableChanged event.

Subscribes to the CameraIntrinsicsChanged event.

Subscribes to the PropertiesChanged event.

Subscribes to the VideoProfileChanged event.

Attempts to acquire Controller Mode on the color frame source.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the color frame source. Otherwise, this returns null.

This method returns a boolean value indicating whether or not the color frame source can be controlled separately from another frame source.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A string representing the unique ID of the other frame source. Returns true if the two sources can be controlled independently of one another, otherwise returns false.

Creates a new color frame source watcher.

PerceptionColorFrameSource.CreateWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.CreateWatcher instead. A new color frame source watcher.

Finds all color frame sources.

PerceptionColorFrameSource.FindAllAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FindAllAsync instead. When the method completes, it asynchronously returns a list of color frame sources.

Finds an color frame source by looking up its unique ID.

PerceptionColorFrameSource.FromIdAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FromIdAsync instead. The unique ID of the color frame source. When this method completes, it asynchronously returns a color frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null.

Checks whether or not the color frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this color frame source to the entity, or vice versa.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. Returns true if a correlation exists, otherwise returns false.

Gets a frame reader that reads frames from this color frame source.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. Returns a frame reader that reads frames from this color frame source.

Requests access to use color frame sources.

PerceptionColorFrameSource.RequestAccessAsync may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN. When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request.

Attempts to get the intrinsic properties of the depth camera that is correlated with this color source.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The depth frame source to try to get intrinsic properties of. If the attempt is successful, this will return a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null.

Attempts to get a coordinate mapper that maps from color frame image space to depth frame space.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the depth frame source to try to map to. The depth frame source to try to map to. This should be in a correlation group with the color frame source. If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously.

This method returns the transform from the color frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the color frame source coordinate system to the target entity coordinate system. Returns true if a correlation exists, otherwise false.

Attempts to set a video profile on this color frame source. Requires an active Controller Mode control session on this frame source.

PerceptionColorFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A PerceptionControlSession representing active control of this frame source. The video profile to set. This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result that indicates success.

Event data for color frame source added events.

PerceptionColorFrameSourceAddedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the color frame source that was added.

The color frame source that was added.

Event data for color frame source added events.

PerceptionColorFrameSourceRemovedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the color frame source that was removed.

The color frame source that was removed.

Monitors changes to the list of color frame sources, and provides notifications when the list changes.

PerceptionColorFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Gets the operational status of the color frame source watcher.

A DeviceWatcherStatus enumeration value indicating the status of the color frame source watcher.

Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known color frame sources is complete.

Subscribes to the SourceAdded event.

Subscribes to the SourceRemoved event. This event is fired once for every color frame source that is removed.

Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of color frame sources.

When this method is called, the color frame source watcher enumerates any existing color frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The color frame source then starts watching for new color frame sources.

PerceptionColorFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

When this method is called, the color frame source watcher stops looking for changes to the color frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete.

PerceptionColorFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Represents a control session on a controllable frame source.

PerceptionControlSession may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Subscribes to the ControlLost event. This event is triggered when control of the session is lost to another client.

Releases system resources that are exposed by a Windows Runtime object.

Creates a property change request. This request is asynchronously processed, and is not guaranteed to succeed. The property change result should be inspected to determine if the property change was actually accepted and, if it was not, the reason why the property change was not accepted.

PerceptionControlSession may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN. The name of the property to change. The new property value. This method asynchronously returns the result of the property change request.

Provides convenience methods to facilitate geometric math for a camera device, combining the intrinsic properties of that camera with correlated depth frames to provide screen-space pixel to camera-space coordinate projections.

PerceptionDepthCorrelatedCameraIntrinsics may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead.

Unprojects all pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera.

PerceptionDepthCorrelatedCameraIntrinsics may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. The depth frame containing the depth value to use when projecting the points into camera space. The coordinates of each pixel in the image will be mapped from camera image space to depth image space, and then used to look up the depth in this depth frame. Returns a set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. This method returns asynchronously.

Unprojects a point in camera image space out into the coordinate frame of the camera device, using the corresponding depth from a correlated depth camera.

PerceptionDepthCorrelatedCameraIntrinsics may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. A point, relative to the camera frame. The depth frame containing the depth value to use when projecting the point into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. An unprojected coordinate, relative to the coordinate system of the camera device. The coordinate is located in front of the camera, at the depth of the corresponding pixel in depthFrame.

Unprojects a set of points in camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera.

PerceptionDepthCorrelatedCameraIntrinsics may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. A set of points, relative to the camera frame. The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinate will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values.

Unprojects a region of pixels in an image from camera image space out into the coordinate frame of the camera device, using the corresponding depth values from a correlated depth camera.

PerceptionDepthCorrelatedCameraIntrinsics may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. The region of pixels to project from camera image space out into the coordinate frame of the camera device. The depth frame containing the depth value to use when projecting the points into camera space. The pixelCoordinates will be mapped from camera image space to depth image space, and then used to look up the depth in depthFrame. A set of coordinates, relative to the coordinate system of the camera device and with correlated depth values. This method returns asynchronously.

Provides convenience methods to map pixel coordinates in camera image space to depth image space.

PerceptionDepthCorrelatedCoordinateMapper may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead.

Maps all pixels in an image from camera image space to depth image space.

PerceptionDepthCorrelatedCoordinateMapper may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. The depth frame to map the pixels to. Returns the pixel coordinates, mapped to depth image space. This function returns asynchronously.

Maps a set of pixels from camera image space to depth image space.

PerceptionDepthCorrelatedCoordinateMapper may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. A set of pixel coordinates, in camera image space. The depth frame to map the pixels to. The mapping of the pixel coordinate to depth image space.

Maps a pixel from camera image space to depth image space.

PerceptionDepthCorrelatedCoordinateMapper may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. A pixel coordinate, in camera image space. The depth frame to map the pixel to. Returns the mapping of the pixel coordinate to depth image space.

Maps a region of pixels from camera image space to depth image space.

PerceptionDepthCorrelatedCoordinateMapper may be unavailable after Windows Creator Update. Use Windows.Media.Devices.Core.DepthCorrelatedCoordinateMapper instead. The region of pixels to map from camera image space to depth image space. The depth frame to map the region of pixels to. The pixel coordinates, mapped to depth image space. This function returns asynchronously.

Contains a Windows.Media.VideoFrame with the depth frame data.

PerceptionDepthFrame may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.DepthMediaFrame instead.

Gets a Windows.Media.VideoFrame with the depth frame data.

A Windows.Media.VideoFrame with the depth frame data.

Releases system resources that are exposed by a Windows Runtime object.

Contains information about a depth frame arrived event.

PerceptionDepthFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead.

Gets the relative time of this frame.

The relative time of this frame.

Attempts to open the depth frame that has arrived. Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail.

PerceptionDepthFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead. If the attempt is successful, this method returns the newly-arrived depth frame. If the attempt is unsuccessful, this value is unchanged.

Reads depth frames from a depth frame source.

PerceptionDepthFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead.

Gets a boolean value indicating whether or not this reader is paused.

A boolean value indicating whether or not this reader is paused.

Gets the depth frame source this reader gets frames from.

The depth frame source this reader gets frames from.

Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the depth frame source.

Releases system resources that are exposed by a Windows Runtime object

Attempts to read the most recent frame that is available to this depth frame reader.

PerceptionDepthFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead. If the attempt was successful, this method returns the most recent frame that is available to this depth frame reader. If the attempt was not successful, this method returns null.

A frame source that provides depth frames.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.

Gets a boolean value indicating whether or not the source is active.

A boolean value indicating whether or not the source is active.

Gets a boolean value indicating whether or not the source is available.

A boolean value indicating whether or not the source is available.

Gets a read-only collection of video profiles that are currently available from the depth frame source.

A read-only collection of video profiles that are currently available from the depth frame source.

Gets a CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device.

A CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device.

Gets a string value that identifies the device on the system.

The identifier.

Gets a string value indicating the kind of physical device that generates the depth frames.

A string value indicating the kind of physical device that generates the depth frames.

Gets a string value indicating the display name of the depth frame source.

A string value indicating the display name of the depth frame source.

Gets a string value indicating the unique ID of the depth frame source.

A string value indicating the unique ID of the depth frame source.

Gets a boolean value indicating whether or not the source is the subject of controller mode.

A boolean value indicating whether or not the source is the subject of controller mode.

Gets a read-only collection of frame source properties.

A read-only collection of frame source properties.

Gets a read-only collection of video profiles that are supported by the depth frame source.

A read-only collection of video profiles that are supported by the depth frame source.

Gets a PerceptionVideoProfile object indicating the current video profile.

A PerceptionVideoProfile object indicating the current video profile.

Subscribes to the ActiveChanged event.

Subscribes to the AvailableChanged event.

Subscribes to the CameraIntrinsicsChanged event.

Subscribes to the PropertiesChanged event.

Subscribes to the VideoProfileChanged event.

Attempts to acquire Controller Mode on the depth frame source.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the depth frame source. Otherwise, this returns null.

This method returns a boolean value indicating whether or not the depth frame source can be controlled separately from another frame source.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A string representing the unique ID of the other frame source. True if the two sources can be controlled independently of one another; otherwise, false.

Creates a new depth frame source watcher.

PerceptionDepthFrameSource.CreateWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.CreateWatcher instead. A new depth frame source watcher.

Finds all depth frame sources.

PerceptionDepthFrameSource.FindAllAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FindAllAsync instead. When the method completes, it asynchronously returns a list of depth frame sources.

Finds an depth frame source by looking up its unique ID.

PerceptionDepthFrameSource.FromIdAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FromIdAsync instead. The unique ID of the depth frame source. When this method completes, it asynchronously returns a depth frame source if one exists with the specified ID. Otherwise, this method asynchronously returns null.

Checks whether or not the depth frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this depth frame source to the entity, or vice versa.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. True if a correlation exists, otherwise false.

Gets a frame reader that reads frames from this depth frame source.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A frame reader that reads frames from this depth frame source.

Requests access to use depth frame sources.

PerceptionDepthFrameSource.RequestAccessAsync may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN. When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request.

Attempts to get the intrinsic properties of the depth camera that is correlated with this depth source.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The depth frame source to try to get intrinsic properties of. If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null.

Attempts to get a coordinate mapper that maps from depth frame image space to depth frame space.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the depth frame source to try to map to. The depth frame source to try to map to. This should be in a correlation group with the depth frame source. If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously.

Gets the transform from the depth frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the depth frame source coordinate system to the target entity coordinate system. True if a correlation exists, otherwise false.

Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source.

PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A PerceptionControlSession representing active control of this frame source. The video profile to set. This method returns an PerceptionFrameSourcePropertyChangeResult object asynchronously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result indicating success.

Event data for depth frame source added events.

PerceptionDepthFrameSourceAddedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the depth frame source that was added.

The depth frame source that was added.

Event data for depth frame source removed events.

PerceptionDepthFrameSourceRemovedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the depth frame source that was removed.

The depth frame source that was removed.

Monitors changes to the list of depth frame sources, and provides notifications when the list changes.

PerceptionDepthFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Gets the operational status of the depth frame source watcher.

A DeviceWatcherStatus enumeration value indicating the status of the depth frame source watcher.

Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known depth frame sources is complete.

Subscribes to the SourceAdded event.

Subscribes to the SourceRemoved event. This event is fired once for every depth frame source that is removed.

Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of depth frame sources.

When this method is called, the depth frame source watcher enumerates any existing depth frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The depth frame source then starts watching for new depth frame sources.

PerceptionDepthFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

When this method is called, the depth frame source watcher stops looking for changes to the depth frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete.

PerceptionDepthFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Indicates the access status an app is allowed for a particular type of frame source.

PerceptionFrameSourceAccessStatus may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

The app is allowed to access the type of perception frame source it requested.

The app is not allowed to access the type of perception frame source it requested because system access to camera devices is denied. This usually occurs when the user denies all apps access to camera devices in the system privacy settings.

The app is not allowed to access the type of perception frame source it requested because the user denied the app access to camera devices.

Access status is not specified.

Contains information about an attempt to change properties on a frame source.

PerceptionFrameSourcePropertiesChangedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the type of change that occurred as a result of the property change request.

The type of change that occurred as a result of the property change request.

Gets a string key indicating the location of the change in the collection.

A string key indicating the location of the change in the collection

Contains information about an attempted property change on a frame source.

PerceptionFrameSourcePropertyChangeResult may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets a PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect.

A PerceptionFrameSourcePropertyChangeStatus indicating the status of the change request, including whether or not the change took effect.

Gets the value of the property after the change request has been processed.

The value of the property after the change request has been processed.

Indicates the status of a property change that an app requested of a frame source.

PerceptionFrameSourcePropertyChangeStatus may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

The requested property change was accepted by the frame source.

The frame source property could not be changed because the app lost controller mode before the request was processed.

The requested property is not supported by the frame source.

The requested property change was not accepted because the property is read-only.

The status change is unknown.

The requested property change was not accepted because the value is not in a valid range.

Contains a Windows.Media.VideoFrame with the infrared frame data.

PerceptionInfraredFrame may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.InfraredMediaFrame instead.

Gets a Windows.Media.VideoFrame with the infrared frame data.

A Windows.Media.VideoFrame with the infrared frame data.

Releases system resources that are exposed by a Windows Runtime object.

Contains information about a infrared frame arrived event.

PerceptionInfraredFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead.

Gets the relative time of this frame.

The relative time of this frame.

Attempts to open the infrared frame that has arrived.

PerceptionInfraredFrameArrivedEventArgs may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead. If the attempt is successful, this method returns the newly-arrived infrared frame. If the attempt is unsuccessful, this value is unchanged.

Reads infrared frames from a infrared frame source.

PerceptionInfraredFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead.

Gets a boolean value indicating whether or not this reader is paused.

A boolean value indicating whether or not this reader is paused.

Gets the infrared frame source this reader gets frames from.

The infrared frame source this reader gets frames from.

Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the infrared frame source.

Releases system resources that are exposed by a Windows Runtime object

Attempts to read the most recent frame that is available to this infrared frame reader.

PerceptionInfraredFrameReader may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameReader instead. If the attempt was successful, this method returns the most recent frame that is available to this infrared frame reader. If the attempt was not successful, this method returns null.

A frame source that provides infrared frames.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.

Gets a boolean value indicating whether or not the source is active.

A boolean value indicating whether or not the source is active.

Gets a boolean value indicating whether or not the source is available.

A boolean value indicating whether or not the source is available.

Gets a read-only collection of video profiles that are currently available from the infrared frame source.

A read-only collection of video profiles that are currently available from the infrared frame source.

Gets a CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device.

A CameraIntrinsics value specifying the intrinsic properties of the infrared frame source camera device.

Gets a string value that identifies the device on the system.

The identifier.

Gets a string value indicating the kind of physical device that generates the infrared frames.

A string value indicating the kind of physical device that generates the infrared frames.

Gets a string value indicating the display name of the infrared frame source.

A string value indicating the display name of the infrared frame source.

Gets a string value indicating the unique ID of the infrared frame source.

A string value indicating the unique ID of the infrared frame source.

Gets a boolean value indicating whether or not the source is the subject of controller mode.

A boolean value indicating whether or not the source is the subject of controller mode.

Gets a read-only collection of frame source properties.

A read-only collection of frame source properties.

Gets a read-only collection of video profiles that are supported by the infrared frame source.

A read-only collection of video profiles that are supported by the infrared frame source.

Gets a PerceptionVideoProfile object indicating the current video profile.

A PerceptionVideoProfile object indicating the current video profile.

Subscribes to the ActiveChanged event.

Subscribes to the AvailableChanged event.

Subscribes to the CameraIntrinsicsChanged event.

Subscribes to the PropertiesChanged event.

Subscribes to the VideoProfileChanged event.

Attempts to acquire Controller Mode on the infrared frame source.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. If the attempt is successful, this returns a PerceptionControlSession object that can be used to control properties of the infrared frame source. Otherwise, this returns null.

Retrieves a boolean value indicating whether or not the infrared frame source can be controlled separately from another frame source.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A string representing the unique ID of the other frame source. True if the two sources can be controlled independently of one another, otherwise false.

Creates a new infrared frame source watcher.

PerceptionInfraredFrameSource.CreateWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.CreateWatcher instead. A new infrared frame source watcher.

Finds all infrared frame sources.

PerceptionInfraredFrameSource.FindAllAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FindAllAsync instead. When the method completes, it asynchronously returns a list of infrared frame sources.

Finds an infrared frame source by looking up its unique ID.

PerceptionInfraredFrameSource.FromIdAsync may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceInformation.FromIdAsync instead. The unique ID of the infrared frame source. When the method completes, it asynchronously returns an infrared frame source if one exists with the specified ID. Otherwise, this method asynchronously returns nullptr.

Checks whether or not the infrared frame source is correlated with the target entity.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. True if a correlation exists, otherwise false. If the result is true, a transform matrix can be retrieved to change coordinate basis from this infrared frame source to the entity, or vice versa.

Gets a frame reader that reads frames from this infrared frame source.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A frame reader that reads frames from this infrared frame source.

Requests access to use infrared frame sources.

PerceptionInfraredFrameSource.RequestAccessAsync may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN. When this method completes, it asynchronously returns a PerceptionFrameSourceAccessStatus indicating the result of the access request.

Attempts to get the intrinsic properties of the depth camera that is correlated with this infrared source.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The depth frame source to try to get intrinsic properties of. If the attempt is successful, this returns a read-only collection of PerceptionDepthCorrelatedCameraIntrinsics objects specifying the intrinsic properties of the camera used by the correlated depth frame source. Otherwise, this returns null.

Attempts to get a coordinate mapper that maps from infrared frame image space to depth frame space.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the depth frame source to try to map to. The depth frame source to try to map to. This should be in a correlation group with the infrared frame source. If the two sources are correlated, this method returns a PerceptionDepthCorrelatedCoordinateMapper. Otherwise, it returns null. This method returns asynchronously.

Gets the transform from the infrared frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. The unique ID of the target entity. If a correlation exists, this will be set to a 4x4 transform matrix that changes basis from the infrared frame source coordinate system to the target entity coordinate system. True if a correlation exists, otherwise false.

Attempts to set a video profile on this infrared frame source. Requires an active Controller Mode control session on this frame source.

PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameSource instead. A PerceptionControlSession representing active control of this frame source. The video profile to set. This method returns an PerceptionFrameSourcePropertyChangeResult object asynchonously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a success result.

Event data for infrared frame source added events.

PerceptionInfraredFrameSourceAddedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the infrared frame source that was added.

The infrared frame source that was added.

Event data for infrared frame source removed events.

PerceptionInfraredFrameSourceRemovedEventArgs may be unavailable after Windows Creator Update. Please refer to Windows.Media.Capture.Frames APIs on MSDN.

Gets the infrared frame source that was removed.

The infrared frame source that was removed.

Monitors changes to the list of infrared frame sources, and provides notifications when the list changes.

PerceptionInfraredFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Gets the operational status of the infrared frame source watcher.

The operational status of the infrared frame source watcher.

Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known infrared frame sources is complete.

Subscribes to the SourceAdded event.

Subscribes to the SourceRemoved event. This event is fired once for every infrared frame source that is removed.

Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listeningfor changes to the list of infrared frame sources.

When this method is called, the infrared frame source watcher enumerates any existing infrared frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The infrared frame source then starts watching for new infrared frame sources.

PerceptionInfraredFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

When this method is called, the infrared frame source watcher stops looking for changes to the infrared frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete.

PerceptionInfraredFrameSourceWatcher may be unavailable after Windows Creator Update. Use Windows.Devices.Enumeration.DeviceWatcher instead.

Represents a Windows.Devices.Perception video profile.

PerceptionVideoProfile may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameFormat instead.

Gets the bitmap alpha mode.

A BitmapAlphaMode enumeration value indicating the bitmap alpha mode.

Gets the bitmap pixel format.

A BitmapPixelFormat enumeration value indicating the bitmap pixel format.

Gets the time duration of each frame.

A Windows.Foundation.TimeSpan indicating the time duration of each video frame.

Gets the frame height, in pixels.

The frame height, in pixels.

Gets the frame width, in pixels.

The frame width, in pixels.

A comparison function used to determine if two IPerceptionVideoProfile objects are equivalent.

PerceptionVideoProfile may be unavailable after Windows Creator Update. Use Windows.Media.Capture.Frames.MediaFrameFormat instead. The IPerceptionVideoProfile object to compare to this one. True if the two video profiles are equivalent, otherwise false.

Represents an object that can produce PerceptionFrames.

IPerceptionFrameProvider may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Gets a value indicating whether or not the device is ready to start producing PerceptionFrames.

Whether or not the device is ready to start producing PerceptionFrames.

Gets the PerceptionFrameProviderInfo describing this device.

The PerceptionFrameProviderInfo describing this device.

The properties describing the device and the frames produced by the device.

The properties describing the device and the frames produced by the device. PropertyType::Inspectable is not supported as a property value.

The device is requested to update one of its Properties to a new value.

IPerceptionFrameProvider may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. Success or failure will be conveyed to the app.

Tells the device to start producing frames. If success is returned, PerceptionFrameProviderManagerService::PublishFrameForProvider is expected to be called by this Provider.

IPerceptionFrameProvider may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Tells the device to stop producing frames. Called only after Start is called and only if Start returns success.

IPerceptionFrameProvider may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

The IPerceptionFrameProviderManager is expected to provide any IPerceptionFrameProvider that has been registered via PerceptionFrameProviderManagerService::RegisterFrameProviderInfo().

IPerceptionFrameProviderManager may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

The method to request an IPerceptionFrameProvider associated with a registered PerceptionFrameProviderInfo.

IPerceptionFrameProviderManager may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The info specifying the desired IPerceptionFrameProvider. The associated IPerceptionFrameProvider, or nullptr if there is no such registerd provider.

A string used to identify the type classification of a frame.

KnownPerceptionFrameKind may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Gets the string representing the Color FrameKind of a PerceptionFrameProviderInfo.

The string representing the Color FrameKind of a PerceptionFrameProviderInfo.

Gets the string representing the Depth FrameKind of a PerceptionFrameProviderInfo.

The string representing the Depth FrameKind of a PerceptionFrameProviderInfo.

Gets the string representing the Infrared FrameKind of a PerceptionFrameProviderInfo.

The string representing the Infrared FrameKind of a PerceptionFrameProviderInfo.

A group of IPerceptionFrameProvider identifiers to be controlled together.

PerceptionControlGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Creates a PerceptionControlGroup containing the IPerceptionFrameProviders with the ids specified.

PerceptionControlGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. A list of the unique identifiers associated with the grouped IPerceptionFrameProviders. To be controllable, the id must match the associated PerceptionFrameProviderInfo::Id property.

The id(s) of the IPerceptionFrameProvider(s) controlled by this group.

The id(s) of the IPerceptionFrameProvider(s) controlled by this group.

A description of the physical position and orientation of a device specified by the IPerceptionFrameProvider's unique identifier (PerceptionFrameProviderInfo::Id) sharing a common coordinate frame of other PerceptionCorrelations that will be combined into a PerceptionCorrelationGroup.

PerceptionCorrelation may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Initializes a new PerceptionCorrelation instance.

PerceptionCorrelation may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The unique identifier of the IPerceptionFrameProvider being described. The position of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup. The orientation of the device in a common coordinate frame of all members of a PerceptionCorrelationGroup.

The orientation of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup.

The orientation of the described device.

The position of the device in the common coordinate frame shared by other PerceptionCorrelations in the PerceptionCorrelationGroup.

The position of the described device.

The unique identifier of the described device.

The unique identifier of the described device.

A collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame.

PerceptionCorrelationGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Initializes a new PerceptionCorrelationGroup from a collection of one or more PerceptionCorrelation objects describing multiple providers in a common coordinate frame.

PerceptionCorrelationGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The collection of PerceptionCorrelations describing multiple providers in a common coordinate frame.

The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame.

The collection of PerceptionCorrelations describing multiple unique providers in a common coordinate frame.

A group of unique identifiers specifying IPerceptionFrameProviders that share handlers for entering and exiting Face Authentication mode.

PerceptionFaceAuthenticationGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Initializes a new PerceptionFaceAuthenticationGroup instance.

PerceptionFaceAuthenticationGroup may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The collection of unique identifiers which maps to IPerceptionFrameProviders via PerceptionFrameProviderInfo::Id. The handler to invoke when this group is requested to enter Face Authentication mode returning if it's ready. The handler to invoke when this group is leaving Face Authentication mode after startHandler is called and returned true.

The id(s) of the IPerceptionFrameProvider(s) referenced by this group.

The id(s) of the IPerceptionFrameProvider(s) referenced by this group.

Represents a frame of data from the device.

PerceptionFrame may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

The actual bytes of the frame which can be consumed as described by the Properties of the IPerceptionFrameProvider which produced the frame.

The bytes of the frames.

Gets the Properties for this frame.

The Properties for this frame.

Gets or sets the Relative Time of this frame relative to other frames from this IPerceptionFrameProvider.

The Relative Time of this frame relative to other frames from this IPerceptionFrameProvider.

A specific set of properties describing a unique IPerceptionFrameProvider.

PerceptionFrameProviderInfo may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Initializes a new PerceptionFrameProviderInfo instance.

Gets or sets the descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500".

The descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500".

Gets or sets the friendly name for the device, for example, "Contoso Depth Camera x500".

The friendly name for the device.

Gets or sets the type of frames the device creates.

The type of frames the device creates. Must be one of: IKnownPerceptionFrameKind::Color, IKnownPerceptionFrameKind::Depth, or IKnownPerceptionFrameKind::Infrared.

Gets or sets a value indicating whether the device enumerates via FindAllAsync or device-added events on source watchers.

True if the device enumerates via FindAllAsync or device added events on source watchers; otherwise, false. If false, the device will only be accessible via FromIdAsync. If false, the device will enumerate as a Face Authentication source, if registered via PerceptionFrameProviderManagerService::RegisterFaceAuthenticationGroup().

Gets or sets the unique identifier of the IPerceptionFrameProvider.

The unique identifier of the IPerceptionFrameProvider, for example, a GUID, or "com.contoso.depthcamera.x500.serialNumber1234".

Static methods for managing IPerceptionFrameProvider registration and unregistration, PerceptionFaceAuthenticationGroup registration and unregistration, PerceptionControlGroup registration and unregistration, PerceptionCorrelationGroup registration and unregistration, IPerceptionFrameProvider availablity, and publishing a new PerceptionFrame for an IPerceptionFrameProvider.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Sends the PerceptionFrame to the service to tell any apps listening for frames for the provided provider. Frames aren't expected to be published before IPerceptionFrameProvider::Start() is called or after IPerceptionFrameProvider::Stop() is called.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The IPerceptionFrameProvider which produced the frame. The PerceptionFrame that was produced and should be sent to apps.

Registers a PerceptionControlGroup associated with the IPerceptionFrameProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The group of IPerceptionFrameProvider(s) to control atomically.

Registers a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The group of PerceptionCorrelations(s) to control atomically.

Registers a PerceptionFaceAuthenticationGroup associated with the given IPerceptionProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The group of IPerceptionFrameProvider(s) to atomically control.

Registers the PerceptionFrameProviderInfo in association with the given IPerceptionFrameProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager which can provide the IPerceptionFrameProvider associated with the info. The PerceptionFrameProviderInfo which identifies the available IPerceptionFrameProvider.

Removes the registration of a previously registered PerceptionControlGroup.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The group of IPerceptionFrameProvider(s) to prevent from being controlled.

Unregisters a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The PerceptionCorrelationGroup to unregister.

Unregisters a PerceptionFaceAuthenticationGroup in association with the given IPerceptionProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager that owns the lifetime of the group. The PerceptionFaceAuthenticationGroup to unregister.

Unregisters the PerceptionFrameProviderInfo in association with the given IPerceptionProviderManager.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The manager which previously registered this info. The PerceptionFrameProviderInfo which identifies the IPerceptionFrameProvider.

Sets whether or not the IPerceptionFrameProvider is available.

PerceptionFrameProviderManagerService may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The provider to set availability for. Whether or not the provider is available.

A request from an app that's in control of this IPerceptionFrameProvider to update a property.

PerceptionPropertyChangeRequest may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Gets the name of the property to change.

The name of the property to change.

Sets the new status of the request after processing the request.

The currently stored status of the request.

Gets the requested new value of the property.

The requested new value of the property.

Gets a Windows::Foundation::Deferral object to allow background processing if needed.

PerceptionPropertyChangeRequest may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The Deferral object.

Invoked when a PerceptionFaceAuthenticationGroup enters Face Authentication mode.

PerceptionStartFaceAuthenticationHandler may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. True if the group is ready to preform Face Authentication; otherwise, false. The associated PerceptionFaceAuthenticationGroup that was registered.

Invoked when a PerceptionFaceAuthenticationGroup exits Face Authentication mode. This will only be invoked after the group received a PerceptionStartFaceAuthenticationHandler from which it returned true.

PerceptionStopFaceAuthenticationHandler may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The associated PerceptionFaceAuthenticationGroup that was registered.

An allocator that can create PerceptionFrames directly which can be written into or copied from Windows::Media::VideoFrame into a PerceptionFrame.

PerceptionVideoFrameAllocator may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.

Initializes a new PerceptionVideoFrameAllocator with the required properties for use by the IPerceptionFrameProvider to create PerceptionFrames published via PerceptionFrameProviderManagerService::PublishFrameForProvider.

PerceptionVideoFrameAllocator may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. This is the number of buffers in flight required by the FrameProvider to produce its * frames at framerate. The suggestion is at least 2. The Windows::Graphics::Imaging::BitmapPixelFormat describing the format of the bytes of the frame. The resolution in pixels of the frame. The Windows::Graphics::Imaging::BitmapAlphaMode describing how transparency is handled in the pixels.

Creates an empty PerceptionFrame with the properties specified when creating the PerceptionVideoFrameAllocator.

PerceptionVideoFrameAllocator may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The empty frame with the properties specified when creating the PerceptionVideoFrameAllocator.

Releases system resources that are exposed by a Windows Runtime object.

Creates a deep copy of the video FrameProvider with the bytes already filled in with the resulting PerceptionFrame.

PerceptionVideoFrameAllocator may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN. The input frame from which to copy the pixel data. The resulting filled PerceptionFrame.

Represents the barcode scanner device.

Gets the capabilities of the specified barcode scanner.

The capabilities of the barcode scanner.

Gets the DeviceInformation.Id of the barcode scanner.

The DeviceInformation.Id of the barcode scanner.

Retrieves the video device ID which represents the camera lens associated with the claimed barcode scanner. (Not supported on mobile platforms)

The video device ID.

Occurs when the barcode scanner detects an operation status change.

Tests the state of the barcode scanner.

The specified health check level. A text description of the test result. Returns an error if the specified check level is not supported by the device.

Attempts to get an exclusive access to the barcode scanner.

When the method completes, it returns a ClaimedBarcodeScanner.

Close the barcode scanner session, allowing it to be claimed by another client. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Creates BarcodeScanner object from the DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific barcode scanner, which can be retrieved from the DeviceId property. The barcode scanner specified by the unique device identifier. Returns a null object in the following cases:

Returns the first available barcode scanner.

The first available barcode scanner. Returns a null object in the following cases:

Gets an Advanced Query Syntax (AQS) string that you can use to list the available barcode scanners.

An Advanced Query Syntax (AQS) string that is used to enumerate available barcode scanners.

Gets an Advanced Query Syntax (AQS) string that you can use to list the barcode scanners available over the specified connection types

A list of the connection types to test for available barcode scanners. An Advanced Query Syntax (AQS) string that is used to enumerate the barcode scanners available over the specified connection types

Gets the list of profiles supported by the barcode scanner.

As array of strings representing the supported profiles. Returns an empty list if the scanner does not support profiles.

Gets the symbologies supported by the claimed barcode scanner.

When the method completes successfully, it returns a list of values that represent the symbologies supported by the device.

Determines whether the profile is supported.

Barcode scanner profile. True if the barcode scanner supports the profile; otherwise false.

Determines whether the specified symbology is supported by the barcode scanner.

The specific barcode symbology. True if the device supports the specified symbology; otherwise, false.

Retrieves the requested statistics from the barcode scanner.

The list of statistics to retrieve. IBuffer representing the requested statistics.

Represents the barcode scanner capabilities.

Indicates whether the barcode scanner supports image preview.

True if the barcode scanner supports image preview; otherwise, false.

Indicates whether the barcode scanner supports the software trigger functionality.

True if the software trigger is supported; otherwise, false.

Indicates whether the barcode scanner supports reporting of usage statistics.

True if the barcode scanner supports statistics reporting; otherwise, false.

Indicates whether the barcode scanner supports updating or resetting of usage statistics.

True if the barcode scanner supports updating of usage statistics; otherwise, false.

Indicates whether the barcode scanner supports displaying a live video preview from an attached camera.

True if the barcode scanner supports displaying a live video preview; otherwise, false.

Gets the power reporting type for the barcode scanner.

Power reporting type.

Provides the barcode data from the DataReceived event.

Gets the data from the DataReceived event.

Data from the barcode scanning event.

Provides data for the ErrorOccurred event.

Gets the data associated with the ErrorOccurred event.

The error information.

Indicates whether it is worthwhile to make another attempt at the operation.

True if the application should make another attempt at the operation; otherwise, false.

Gets any data that was successfully read.

The partial input information from the barcode scanner.

Provides the data from the ImagePreviewReceived event.

Gets the from the device representing a preview frame.

The data stream representing the preview frame.

Contains the barcode scanner data.

Creates an instance of BarcodeScannerReport.

The decoded barcode label type. The full raw scan data. The decoded barcode label.

Gets the full raw data from the DataReceived event.

The raw data stream from the scanning event.

Gets the decoded barcode label, which does not include the header, checksum, and other miscellaneous information.

The data stream containing the decoded barcode label.

Gets the decoded barcode label type. Possible values are defined in the BarcodeSymbologies class.

The specific barcode symbology.

Defines the constants that indicate the barcode scanner status.

Vendor specific status information.

The device power is off or detached from the terminal. This is valid if UnifiedPosPowerReportingType is Advanced.

The device power is on, but it is not ready or unable to respond to requests. This is valid if UnifiedPosPowerReportingType is Advanced.

The device power is off or the device is offline. This is valid if UnifiedPosPowerReportingType is Standard.

The device is online. This is valid if UnifiedPosPowerReportingType is Standard or Advanced.

Provides information about an operation status change.

Gets the vendor specific status code.

The vendor specific status code.

Gets the status change information.

The status change information.

Contains the barcode symbology.

Gets the Australia Postal barcode symbology.

The Australia Postal barcode symbology.

Gets the Aztec barcode symbology.

The Aztec barcode symbology.

Gets the Canada Postal barcode symbology.

The Canada Postal barcode symbology.

Gets the Composite Component A or B barcode symbology.

The Composite Component A or B barcode symbology.

Gets the Composite Component-C barcode symbology.

The Composite Component-C barcode symbology.

Gets the China Postal barcode symbology.

The China Postal barcode symbology.

Gets the Codabar barcode symbology.

The Codabar barcode symbology.

Gets the Codablock 128 barcode symbology.

The Codablock 128 barcode symbology.

Gets the Codablock A barcode symbology.

The Codablock A barcode symbology.

Gets the Codablock F barcode symbology.

The Codablock F barcode symbology.

Gets the Code 11 barcode symbology.

The Code 11 barcode symbology.

Gets the Code 128 barcode symbology.

The Code 128 barcode symbology.

Gets the Code 16k barcode symbology.

The Code 16k barcode symbology.

Gets the Code 32 barcode symbology.

The Code 32 barcode symbology.

Gets the Code 39 barcode symbology.

The Code 39 barcode symbology.

Gets the Code 39 Extended barcode symbology.

The Code 39 Extended barcode symbology.

Gets the Code 49 barcode symbology.

The Code 49 barcode symbology.

Gets the Code 93 barcode symbology.

The Code 93 barcode symbology.

Gets the Code 93 Extended barcode symbology.

The Code 93 Extended barcode symbology.

Gets the Data Code barcode symbology.

The Data Code barcode symbology.

Gets the Data Matric barcode symbology.

The Data Matrix barcode symbology.

Gets the Dutch Postal barcode symbology.

The Dutch Postal barcode symbology.

Gets the EAN (European Article Number) 13 barcode symbology.

The EAN 13 barcode symbology.

Gets the EAN 13 with 2 digit supplement barcode symbology.

The EAN 13 with 2 digit supplement barcode symbology.

Gets the EAN 13 with 5 digit supplement barcode symbology.

The EAN 13 with 5 digit supplement barcode symbology.

Gets the EAN 8 barcode symbology.

The EAN 8 barcode symbology.

Gets the EAN 8 with 2 digit supplement barcode symbology.

The EAN 8 with 2 digit supplement barcode symbology.

Gets the EAN 8 with 5 digit supplement barcode symbology.

The EAN 8 with 5 digit supplement barcode symbology.

Gets the EAN 99 barcode symbology.

The EAN 99 barcode symbology.

Gets the EAN 99 with 2 digit supplement barcode symbology.

The EAN 99 with 2 digit supplement barcode symbology.

Gets the EAN 99 with 5 digit supplement barcode symbology.

The EAN 99 with 5 digit supplementbarcode symbology.

Gets the EAN Velocity barcode symbology.

The EAN Velocity barcode symbology.

Gets the EAN Velocity with 2 digit supplement barcode symbology.

The EAN Velocity with 2 digit supplement barcode symbology.

Gets the EAN Velocity with 5 digit supplement barcode symbology.

The EAN Velocity with 5 digit supplement barcode symbology.

Gets the first possible OEM defined barcode symbology when the symbology type is not included in the current list.

The OEM defined barcode symbology.

Gets the GS1 128 shipping container barcode symbology.

The GS1 128 shipping container barcode symbology.

Gets the GS1 128 Coupon barcode symbology.

The GS1 128 Coupon barcode symbology.

Gets the GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology.

The GS1 Databar Omnidirectional, GS1 Databar Stacked Omnidirectional, GS1 Databar Stacked, or GS1 Databar Truncated barcode symbology.

Gets the GS1 DataBar Limited or RSS Limited barcode symbology.

The GS1 DataBar Limited or RSS Limited barcode symbology.

Gets the GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology.

The GS1 Databar Expanded, GS1 Databar Expanded Stacked, or RSS Expanded barcode symbology.

Gets the GS1DWCode barcode symbology.

The GS1DWCode barcode symbology.

Gets the Han Xin barcode symbology.

The Han Xin barcode symbology.

Gets the InfoMail barcode symbology.

The InfoMail barcode symbology.

Gets the International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology.

The International Standard Book Number (ISBN), also known as Bookland or Bookland EAN, barcode symbology.

Gets the ISBN with 5 digit supplement barcode symbology.

The ISBN with 5 digit supplement barcode symbology.

Gets the International Society of Blood Transfusion (ISBT) 128 barcode symbology.

The International Society of Blood Transfusion (ISBT) 128 barcode symbology.

Gets the International Standard Music Number (ISMN) barcode symbology.

The International Standard Music Number (ISMN) barcode symbology.

Gets the ISMN with 2 digit supplement barcode symbology.

The ISMN with 2 digit supplement barcode symbology.

Gets the ISMN with 5 digit supplement barcode symbology.

The ISMN with 5 digit supplement barcode symbology.

Gets the International Standard Serial Number (ISSN) barcode symbology.

The International Standard Serial Number (ISSN) barcode symbology.

Gets the ISSN with 2 digit supplement barcode symbology.

The ISMN with 2 digit supplement barcode symbology.

Gets the ISSN with 5 digit supplement barcode symbology.

The ISSN with 5 digit supplement barcode symbology.

Gets the Italian Post 25 barcode symbology.

The Italian Post 25 barcode symbology.

Gets the Italian Post 39 barcode symbology.

The Italian Post 39 barcode symbology.

Gets the Japan Postal barcode symbology.

The Japan Postal barcode symbology.

Gets the Korea Postal barcode symbology.

The Korea Postal barcode symbology.

Gets the MaxiCode barcode symbology.

The MaxiCode barcode symbology.

Gets the Magnetic Ink Character Recognition (MICR) barcode symbology.

The Magnetic Ink Character Recognition (MICR) barcode symbology.

Gets the Micro PDF 417 barcode symbology.

The Micro PDF 417 barcode symbology.

Gets the Micro QR Code barcode symbology.

The Micro QR Code barcode symbology.

Gets the MSI barcode symbology.

The MSI barcode symbology.

Gets the Microsoft tag barcode symbology.

The Microsoft tag barcode symbology.

Gets the OCR-A barcode symbology.

The OCR-A barcode symbology.

Gets the OCR-B barcode symbology.

The OCR-B barcode symbology.

Gets the PDF 417 barcode symbology.

The PDF 417 barcode symbology.

Gets the Plessey barcode symbology.

The Plessey barcode symbology.

Gets the Pharma-Zentral-Nummer (Pzn) barcode symbology.

The Pharma-Zentral-Nummer (Pzn) barcode symbology.

Gets the Quick Response (QR) Code barcode symbology.

The Quick Response (QR) Code barcode symbology.

Gets the Serials Industry Systems Advisory Committee (SISAC) barcode symbology.

The Serials Industry Systems Advisory Committee (SISAC) barcode symbology.

Gets the Sweden Postal barcode symbology.

The Sweden Postal barcode symbology.

Gets the Telepen barcode symbology.

The Telepen barcode symbology.

Gets the Discreet 2 of 5 barcode symbology.

The Discreet 2 of 5 barcode symbology.

Gets the 2 of 5 International Air Transportation Association (IATA) barcode symbology.

The 2 of 5 International Air Transportation Association (IATA) barcode symbology.

Gets the Industrial 2 of 5 barcode symbology.

The Industrial 2 of 5 barcode symbology.

Gets the Interleaved 2 of 5 barcode symbology.

The Interleaved 2 of 5 barcode symbology.

Gets the 2 of 5 Matrix barcode symbology.

The 2 of 5 Matrix barcode symbology.

Gets the Standard 2 of 5 barcode symbology.

The Standard 2 of 5 barcode symbology.

Gets the TLC 39 barcode symbology.

The TLC 39 barcode symbology.

Gets the Tri-Optic Media Storage Devices barcode symbology.

The Tri-Optic Media Storage Devices barcode symbology.

Gets the UCC/EAN 128 barcode symbology.

The UCC/EAN 128 barcode symbology.

Gets the UK Postal barcode symbology.

The UK Postal barcode symbology.

Unknown barcode symbology.

Unknown barcode symbology.

Gets the Universal Product Code (UPC) version A barcode symbology.

The Universal Product Code (UPC) version A barcode symbology.

Gets the UPC A with 2 digit supplemental barcode symbology.

The UPC A with 2 digit supplemental barcode symbology.

Gets the UPC A with 5 digit supplement barcode symbology.

The UPC A with 5 digit supplement barcode symbology.

Gets the UPC Coupon with supplemental barcode symbology.

The UPC Coupon with supplemental barcode symbology.

Gets the Universal Product Code (UPC) version E barcode symbology.

The Universal Product Code (UPC) version E barcode symbology.

Gets the UPC-E with 2 digit supplemnent barcode symbology.

The UPC-E with 2 digit supplemnent barcode symbology.

Gets the UPC-E with 5 digit supplement barcode symbology.

The UPC-E with 5 digit supplement barcode symbology.

Gets the United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology.

The United States Postal Service 4-State Flat Mail Identification Code Sort (FICS) barcode symbology.

Gets the United States Postal Service (USPS) Intelligent Mail barcode symbology.

The United States Postal Service (USPS) Intelligent Mail barcode symbology.

Gets the United States Postal Service (USPS) Intelligent Mail Package barcode symbology.

The United States Postal Service (USPS) Intelligent Mail Package barcode symbology.

Gets the United States Postal Service PLANET barcode symbology.

The United States Postal Service PLANET barcode symbology.

Gets the United States Postal Numeric Encoding Technique (POSTNET) barcode symbology.

The United States Postal Numeric Encoding Technique (POSTNET) barcode symbology.

Returns the barcode symbology type as a string.

The barcode symbology type. The barcode symbology type as a string.

The attributes of a barcode scanner symbology.

Gets or sets the first value used to determine the barcode symbology decode length.

The first part of the decode length.

Gets or sets the second value used to determine the barcode symbology decode length.

The second part of the decode length.

Gets or sets the decode length kind used by the barcode symbology.

The decode length kind used by the barcode symbology.

Gets or sets whether the check digit will be transmitted to the host as part of the raw data.

True if the check digit will be tranmissted to the host as raw data; otherwise, false.

Gets whether the barcode symbology supports transmitting the check digit to the host as part of the raw data.

True if the barcode symbology supports transmitting the check digit as raw data; otherwise, false.

Gets whether barcode check digit will be validated.

True if the barcode check digit will be validated; otherwise, false.

Gets whether the barcode symbology supports check digit validation.

True if the barcode symbology supports check digit validation; otherwise, false.

Gets whether the barcode symbology supports multiple decode lengths.

True if the barcode symbology supports multiple decode lengths; otherwise, false.

The types of decode lengths that barcode symbologies can support.

Decode lengths of any number.

Decode lengths of either DecodeLength1 or DecodeLength2 single-byte characters.

Decode lengths between DecodeLength1 and DecodeLength2 single-byte characters. The order of DecodeLength1 and DecodeLength2 do not matter (either can be higher or lower than the other).

A cash drawer device in a retail scenario.

The functionality of the cash drawer device as exposed by API.

The functionality of the cash drawer device as exposed by API.

The identifier string of the cash drawer device.

String representing the ID of the device.

Gets the CashDrawerEventSource to allow the app to detect the open/close state of the drawer. The actual current state is reported by IsDrawerOpen..

The cash drawer event source. If the drawer does not support open/close detection, then it will return null.

Indicates whether the cash drawer is open.

True if the drawer is open, otherwise false.

Get the current power and availability status of the cash drawer.

The cash drawer status.

Indicates there has been a change in the power availability status of the drawer.

Gets the device's health state asynchronously.

The specified health check level. This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good.

Attempts to get exclusive access on the cash drawer.

When the method completes, it returns a ClaimedCashDrawer.

Close the cash drawer session.

Creates CashDrawer object from the DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific cash drawer, which can be retrieved from the DeviceId property. The cash drawer specified by the unique device identifier. Returns a null object in the following cases:

Gets the default paired or locally-connected cash drawer.

The default locally-connected drawer. May return null if there is no drawer available.

Gets an Advanced Query Syntax (AQS) string that you can use to list the available cash drawers.

An Advanced Query Syntax (AQS) string that is used to enumerate available cash drawers.

Gets an Advanced Query Syntax (AQS) string that you can use to list the cash drawers available over the specified connection types

A list of the connection types to check for available cash drawers. An Advanced Query Syntax (AQS) string that is used to enumerate the cash drawers available over the specified connection types

Retrieves the requested statistics from the cash drawer.

The list of statistics to retrieve. String representing the requested statistics.

Represents the cash drawer capabilities.

Indicated whether cash drawer open sensor is available.

True if the sensor is available, otherwise false.

Whether statistics reporting is supported by the cash drawer.

True if statistics reporting is supported by the cash drawer; otherwise, false.

Whether statistics updating is supported by the cash drawer.

True if statistics updating is supported by the cash drawer; otherwise, false.

Whether the status from multiple drawers is supported.

True if multiple drawer detection is supported, otherwise false.

Whether status reporting is supported by the cash drawer.

True if status reporting is supported, otherwise false.

Whether the cash drawer has standard or advanced power reporting.

Defines the constants that indicates power reporting capabilities of the cash drawer.

The cash drawer close alarm. Parameter defaults are provided, however the user can update them as appropriate.

Gets or sets the alarm timeout for the cash drawer close alarm.

Defines the amount of time for the alarm timeout.

Delay between cash drawer closed alarm beeps.

Defines the amount of time between beeps.

Duration of the cash drawer close alarm beep.

Defines the length of time the alarm beep sounds.

Frequency of beep tone.

Defines the audio frequency of the beep tone.

Event allowing the app to be notified if the alarm timeout has been triggered.

Starts the alarm countdown, returning an awaitable object that completes when the cash drawer is closed.

True if the drawer has been closed; otherwise, false indicates a problem has occurred.

This object is passed as a parameter to the event handlers for the DrawerClosed event.

Gets the data associated with the DrawerClosed event.

The cash drawer.

Provides event sources that allow a developer to detect when the cash drawer is opened or closed.

Occurs when the cash drawer is closed.

Occurs when the cash drawer is opened.

This object is passed as a parameter to the event handlers for the DrawerOpened event.

Gets the data associated with the DrawerOpened event.

The cash drawer.

Provides the current power and availability status of the cash drawer.

ExtendedStatus provides a way for a Point of Service driver or provider to send custom notifications to the app.

Value representing the custom notification.

Gets the status kind for the cash drawer status.

The status kind.

Defines the constants that indicate the cash drawer power status.

The device status is not any of the above states. This is available so a POS driver can provide custom notifications to the app.

The device is powered off or detached from the terminal.

The device is powered on but is not available to respond to requests.

The device is either off or offline, but the current state can not be distinguished.

The device is powered on and ready to use.

This object is passed as a parameter to the event handlers for the StatusUpdated event.

Gets the data associated with the StatusUpdated event.

The cash drawer status.

Represents the claimed barcode scanner.

Gets the DeviceInformation.Id of the claimed barcode scanner.

The DeviceInformation.Id of the claimed barcode scanner.

Gets or sets a Boolean value that indicates whether to provide the decoded data to the service object.

Set to true if decoded data is provided to the application; otherwise, false.

Gets or sets a Boolean value that indicates whether the barcode scanner is disabled after receiving the data.

Set to true if the application wants to receive and process only one input or only one input at a time.

Indicates whether the barcode scanner can receive DataReceived events.

True if the device can receive DataReceived events; otherwise, false.

Gets or sets whether to show the video preview window when the barcode scanner is enabled.

True if the video preview window will be shown; otherwise false.

Event that is raised when the **ClaimedBarcodeScanner** is closed.

Occurs when the device scans a barcode.

Occurs when there is a problem in reading a barcode.

Occurs when the device receives the bitmap image of the scan.

Occurs when the device gets a request to release its exclusive claim.

Occurs when the barcode scanner trigger or button is pressed during a scanning operation.

Occurs when the barcode scanner trigger or button is released during a scanning operation.

Releases exclusive claim to the barcode scanner. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Puts the barcode scanner into a state where it cannot receive DataReceived events.

No object or value is returned when this method completes.

Gets the barcode scanner into a ready state for DataReceived events.

No object or value is returned when this method completes.

Gets the attributes of the specified barcode symbology.

The barcode symbology. A BarcodeSymbologyAttributes object, containing the attributes of the specified barcode symbology.

Hides the video preview window.

Resets the specified statistics to zero for all statistics that can be reset.

The list of names of the statistics to reset. No object or value is returned by this method when it completes.

Retains exclusive claim to the barcode scanner.

Sets the active profile on the barcode scanner.

The name of the profile to set on the device. No object or value is returned when the method completes.

Sets the barcode symbologies for the device to use.

The specific symbologies to use. No object or value is returned when this method completes.

Sets the attributes of the barcode symbology used by the claimed barcode scanner.

The barcode symbology. The barcode symbology attributes. True if the barcode symbology attributes were successfully set; otherwise, false.

Shows the video preview window.

True if the video preview is shown; false if the video preview is not shown or not supported.

Used to signal the barcode scanner to start scanning. A session is active until StopSoftwareTriggerAsync is invoked, or until the scanner ends the session on its own.

No object or value is returned when this method completes.

Used to stop a session that was started with StartSoftwareTriggerAsync. No error is raised if this is called when no session is active.

No object or value is returned when this method completes.

Updates the specified statistics.

The list of key-value pairs of statistics to update. No object or value is returned by this method when it completes.

This object is passed as a parameter to the event handlers for the ClaimedBarcodeScanner.Closed event.

Provides access to exclusive and privileged methods, properties, and events on a point-of-service cash drawer device.

Gets the close alarm for this cash drawer. This is only valid if IsDrawerOpenSensorAvailable is true.

The close alarm for the cash drawer.

The identifier string of the claimed cash drawer device.

String representing the ID of the device.

Indicates whether the cash drawer is open.

True if the drawer is open, otherwise false.

Indicates whether the cash drawer is operational and can be used.

True if the cash drawer can be opened or CloseAlarm can be used; otherwise, false.

Event that is raised when the **ClaimedCashDrawer** is closed.

Occurs when the device gets a request to release its exclusive claim.

Disposes the claimed cash drawer, releases claim on the device, and disables the device the same way as calling DisableAsync.

Notifies the underlying hardware to power off.

Whether the attempt to disable succeeded or not.

Asynchronously notifies the underlying hardware to power on for use.

Whether the attempt to enable succeeded or not.

Opens the cash drawer.

Boolean indicating whether the drawer was successfully opened.

Resets the specified device statistics to their defaults.

The list of names of the statistics to reset. True on success; otherwise false.

Retain the current claim on the cash drawer. This is usually called in response to a ReleaseDeviceRequested event notification.

True if the retain attempt succeeded; false if the retain attempt failed.

Updates device statistics values using the provided key/value pair.

The statistics to update. True if update succeeded; otherwise false.

This object is passed as a parameter to the event handlers for the ClaimedCashDrawer.Closed event.

Represents a journal printer station that has been claimed for use.

Gets or sets the number of characters per line for the journal printer station.

The number of characters.

Gets or sets the color cartridge that the journal printer station should use when it prints. This property must agree with what is available through ColorCartridgeCapabilities.

An enumeration value that identifies the color cartridge that the journal printer station should use when it prints.

Gets whether the printer cartridge for the journal printer station is empty. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.

True if the printer cartridge is empty; otherwise false.

Gets whether the cartridge for journal printer station has been removed. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.

True if the cartridge is missing; otherwise false.

Gets whether the printer cover for the journal printer station is open.

True if the cover is open; otherwise false.

Gets whether the head for the journal printer station is currently cleaning.

True if the head is currently cleaning; otherwise false.

Gets or sets whether the journal printer station prints with high quality or high speed. Note, this may throw an exception if the corresponding sensor is not available on the printer.

True if the journal printer station prints with high quality. False if the journal printer station prints with high speed.

Gets whether the paper is empty for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.

True if the printer is out of paper; otherwise false.

Gets whether the printer paper is near the end for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.

True if the paper is near the end; otherwise false.

Gets whether the journal printer station is ready to print. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.

True if the printer is ready to print; otherwise false.

Gets or sets the current height of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current height of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets or sets the spacing of each single-high print line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines.

The spacing of each single-high print line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the current width of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current width of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Creates a new print job for the journal printer station.

The new print job for the journal printer station.

Determines if a JournalPrintJob can successfully execute a print instruction with the specified data.

The data sequence that you want to validate before you use it with the JournalPrintJob.Print method. This sequence may include printable data and escape sequences. True if the data passes validation; otherwise false.

Represents a claimed line display device.

Gets the capabilities of the claimed line display.

The capabilities of the line display.

Gets the line display's custom glyph list, if the feature is supported.

The line display's LineDisplayCustomGlyphs object.

Gets the default device window of the line display.

The default device window, covering the entire screen area.

Gets the device control description of the line display.

The control description of the line display.

Gets the device control version number of the line display.

The UnifiedPOS control version number of the line display.

Gets the DeviceInformation.Id of the line display.

The DeviceInformation.Id of the line display.

Gets the service version number of the line display.

The service version number.

Gets the maximum bitmap size.

The maximum bitmap size in pixels.

Gets the physical device description.

The physical device description given by the UnifiedPOS specification.

Gets the physical device name.

The physical device name given by the UnifiedPOS specification.

Gets the character sets supported by the line display.

The character set numbers supported.

Gets the screen sizes supported by the line display.

A list containting the sizes that the device supports. Each size is represented as a pair of rows and columns.

Event that is raised when the **ClaimedLineDisplay** is closed.

Occurs when a claimed line display claimed is claimed by another app with LineDisplay.ClaimAsync.

Notifies the application that there is a change in the power status of the line display.

Gets the device's health state asynchronously.

The specified health check level. This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good.

Gets the current power status of the device.

The current power status of the device.

Close the line display session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Creates a LineDisplay object from the DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific line display, which can be retrieved from the DeviceId property. The line display specified by the unique device identifier. Returns a null object in the following cases:

Gets the attributes of the line display.

The attributes of the line display.

Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays.

An Advanced Query Syntax string that is used to enumerate available line displays.

Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types

A list of the connection types to check for available line displays. An AQS string that is used to enumerate available line displays available over the specified connection types

Retrieves the requested statistics from the line display.

The list of statistics to retrieve. An XML string representing the requested statistics.

Retains an app's claim on a line display device after it has been claimed by another app with LineDisplay.ClaimAsync.

Attempts to asynchronously clear all descriptions.

Returns True if all descriptors are successfully cleared; otherwise, False.

Attempts to asynchronously create a LineDisplayWindow.

The viewport’s origin device row, origin device column, width in rows and height in columns. The numbers of rows and the number of columns in the window. A new LineDisplayWindow object, representing a new window for the device.

Attempts to asynchronously set a descriptor using the specified attribute.

The descriptor to be set. Must have a value between 0 and LineDisplayCapabilities.SupportedDescriptors - 1. The state to give to the descriptor. Returns True if the descriptor was set successfully; otherwise, False.

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. True if the bitmap is stored successfully, False if a failure occurs.

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. Determines how the bitmap will be horizontally aligned relative to its originating character cell. Determines how the bitmap will be vertically aligned relative to its originating character cell. True if the bitmap is stored successfully, False if a failure occurs.

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats. Determines how the bitmap will be horizontally aligned relative to its originating character cell. Determines how the bitmap will be vertically aligned relative to its originating character cell. The displayed bitmap width in pixels, if different from the original bitmap width. Height will be calculated proportionally. True if the bitmap is stored successfully, False if a failure occurs.

Updates the device attributes.

The updated attributes to be applied to the device. Returns True if the attributes were successfully updated; otherwise, False.

This object is passed as a parameter to the event handlers for the ClaimedLineDisplay.Closed event.

Represents the claimed magnetic stripe reader.

Gets or sets the MagneticStripeReaderEncryptionAlgorithms that will be used to encrypt the track data.

The encryption algorithm the will be used to encrypt the track data.

Gets the DeviceInformation.Id of the claimed magnetic stripe reader.

The DeviceInformation.Id of the claimed magnetic stripe reader.

Indicates whether to provide raw or decoded data from the most recently swiped card.

Set to true if decoded data is provided to the application; otherwise, false.

Indicates whether the device is authenticated.

True is the device is authenticated; otherwise, false.

Gets or sets a Boolean value that indicates whether the magnetic stripe reader is disabled after receiving the data from the most recently swiped card.

Set to true if the application wants to receive and process only one input or only one input at a time.

Indicates whether the magnetic stripe reader is ready to receive data events.

True if the device is operational; otherwise, false.

Indicates whether the track data contains start and end sentinel values.

True if the track data contains start and end sentinel values. False if the track data properties only contain track data between sentinels.

Gets or sets the track data that the application wants to receive following a card swipe.

The card track.

Occurs when a motor vehicle card is swiped.

Occurs when a bank card is swiped.

Event that is raised when the **ClaimedMagneticStripeReader** is closed.

Occurs when the magnetic stripe reader detects an error when reading a card.

Occurs when the device gets a request to release its exclusive claim.

Occurs when a vendor-specific card is swiped.

Puts the device into an authenticated state.

A buffer containing the response token generated from the challenge token retrieved from a previous call to the RetrieveDeviceAuthenticationDataAsync method.

Releases the exclusive claim to the magnetic strip reader.

Puts the device into an unauthenticated state.

A buffer containing the response token generated from the challenge token retrieved from a previous call to the RetrieveDeviceAuthenticationDataAsync method.

Puts the ClaimedMagneticStripeReader into a state where it cannot receive data events.

No object or value is returned when this method completes.

Gets the magnetic stripe reader into a ready state to receive data events.

No object or value is returned by this method when it completes.

Resets the specified statistics to zero for all statistics that can be reset.

The list of names of the statistics to reset. No object or value is returned by this method when it completes.

Retains exclusive claim to the magnetic stripe reader.

Retrieves a challenge token from the device.

Buffer used to store the resulting challenge token from the device.

Sets the type of error to report by the ErrorOccurred event.

Error reporting type.

Provides a new encryption key to the device.

The HEX-ASCII or base64-encoded value for the new key. The name used to identify the key.

Updates the specified statistics.

The list of key-value pairs of statistics to update. No object or value is returned by this method when it completes.

This object is passed as a parameter to the event handlers for the ClaimedMagneticStripeReader.Closed event.

Represent a point-of-service printer that has been claimed for use.

Gets or sets a numeric value that indicates the character set that the application wants to use for printing characters.

The character set that the application wants to use for printing characters.

Gets the identifier string of the claimed point-of-service printer.

The identifier of the claimed point-of-service printer.

Gets or sets whether the driver or provider can map Unicode characters to characters that the point-of-service printer can print, or just sends the low byte of the Unicode character to the printer directly.

True if the driver or provider maps Unicode characters to character that the point-of-service printer can print. False if the driver or provider sends the low byte of each Unicode character to the point-of-service printer directly.

Gets whether the cover of the point-of-service printer is currently open.

True if the cover of the printer is currently open; otherwise, false.

Gets whether the printer is powered on for use.

True if the printer is powered on for use; false otherwise.

Gets an object that represents the journal station for a claimed point-of-service printer.

An object that represents the journal station for a claimed point-of-service printer. Null if a journal station is not present.

Gets or sets the mapping mode of the point-of-service printer that the app wants to use. The mapping mode defines the unit of measure used for other printer properties, such as line height and line spacing.

An enumeration value that indicates the mapping mode of the point-of-service printer that the app wants to use.

Gets an object that represents the receipt station for a claimed point-of-service printer.

An object that represents the receipt station for a claimed point-of-service printer. Null if a receipt station is not present.

Gets an object that represents the slip station for a claimed point-of-service printer.

An object that represents the slip station for a claimed point-of-service printer. Null if a slip station is not present.

Event that is raised when the **ClaimedPosPrinter** is closed.

Occurs when a point-of-service printer gets a request to release its exclusive claim.

Disposes the claimed point-of-service printer object synchronously, releases the exclusive claim on the printer and disables it. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Notifies the underlying hardware to turn off.

True if the attempt turn off the printer succeeded; otherwise false.

Notifies the underlying hardware asynchronously to power on for use.

True if the attempt to turn on the printer succeeded; otherwise false.

Resets the specified statistics to zero for all statistics for the point-of-service printer that can be reset.

A list of the names of the statistics that you want to reset. An operation that returns true if the reset succeeds, or otherwise returns false.

Retains the claim on the point-of-service printer asynchronously, usually in response to the ReleaseDeviceRequested event.

True if the printer was successfully retained; otherwise, false.

Updates the specified statistics for the point-of-service printer.

The statistics to update. An operation that returns true if the update succeeds, or otherwise returns false.

This object is passed as a parameter to the event handlers for the ClaimedPosPrinter.Closed event.

Represents a receipt printer station that has been claimed for use.

Gets or sets the number of characters the receipt printer station can print per line of text.

The number of characters the receipt printer station can print per line of text.

Gets or sets the color cartridge that the receipt printer station should use when it prints.

An enumeration value that identifies the color cartridge that the receipt printer station should use when it prints.

Gets whether the cartridge of the receipt printer station is currently out of ink or toner.

True if the cartridge of the receipt printer station is currently out of ink or toner; otherwise, false.

Gets whether the cartridge of the receipt printer station is currently removed.

True if the cartridge of the receipt printer station is currently removed; otherwise, false.

Gets whether the cover of the receipt printer station is currently open.

True if the cover of the receipt printer station is currently open; otherwise, false.

Gets whether the receipt printer station is currently cleaning its print head.

True if the receipt printer station is currently cleaning its print head; otherwise, false.

Gets or sets whether the receipt printer station prints with high quality or high speed.

True if the receipt printer station prints with high quality. False if the receipt printer station prints with high speed.

Gets whether the receipt printer station needs paper.

True if the receipt printer station needs paper; otherwise, false.

Gets whether the receipt printer station is almost out of paper.

True if the receipt printer station is almost out of paper; otherwise, false.

Gets whether the receipt printer station is on and accepting print jobs.

True if the receipt printer station is on and accepting print jobs; otherwise, false.

Gets or sets the current height of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current height of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets or sets the spacing of each single-high print line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines.

The spacing of each single-high print line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the number of lines that must be advanced before cutting the receipt paper.

The number of lines that must be advanced before cutting the receipt paper.

Gets the current width of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current width of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the size of paper that the claimed receipt printer station currently uses.

The size of paper that the claimed receipt printer station currently uses.

Gets the print area for the receipt printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.

The print area for the receipt printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.

Gets the maximum number of characters that the receipt printer station can print on each line in sideways mode.

The maximum number of characters that the receipt printer station can print on each line in sideways mode.

Gets the maximum number of lines that the receipt printer station can print in sideways mode.

The maximum number of lines that the receipt printer station can print in sideways mode.

Creates a new print job for the receipt printer station.

The new print job for the receipt printer station.

Determines whether a data sequence, possibly including one or more escape sequences, is valid for the receipt printer station, before you use that data sequence when you call the ReceiptPrintJob.Print and ReceiptPrintJob.ExecuteAsync methods.

The data sequence that you want to validate before you use it with the ReceiptPrintJob.Print method. This sequence may include printable data and escape sequences. True if the data passes validation; otherwise false.

Represents a slip printer station that has been claimed for use.

Gets or sets the number of characters the slip printer station can print per line of text.

The number of characters the slip printer station can print per line of text.

Gets or sets the color cartridge that the slip printer station should use when it prints.

An enumeration value that identifies the color cartridge that the slip printer station should use when it prints.

Gets whether the cartridge of the slip printer station is currently out of ink or toner.

True if the cartridge of the slip printer station is currently out of ink or toner; otherwise, false.

Gets whether the cartridge of the slip printer station is currently removed.

True if the cartridge of the slip printer station is currently removed; otherwise, false.

Gets whether the cover of the slip printer station is currently open.

True if the cover of the slip printer station is currently open; otherwise, false.

Gets whether the slip printer station is currently cleaning its print head.

True if the slip printer station is currently cleaning its print head; otherwise, false.

Gets or sets whether the slip printer station prints with high quality or high speed.

True if the slip printer station prints with high quality. False if the slip printer station with high speed.

Gets whether the slip printer station needs paper.

True if the slip printer station needs paper; otherwise, false.

Gets whether the slip printer station is almost out of paper.

True if the slip printer station is almost out of paper; otherwise, false.

Gets whether the slip printer station is on and accepting print jobs.

True if the slip printer station is on and accepting print jobs; otherwise, false.

Gets or sets the current height of the printed line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current height of the printed line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the number of lines that the slip printer station can print after the ClaimedSlipPrinter.IsPaperNearEnd property is set to **true** but before the printer reaches the end of the slip.

The number of lines that the slip printer station can print after the ClaimedSlipPrinter.IsPaperNearEnd property is set to **true** but before the printer reaches the end of the slip.

Gets or sets the spacing of each single-high print line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines.

The spacing of each single-high print line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the current width of the printed line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current width of the printed line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the maximum number of lines that the slip printer station can print on a form.

The maximum number of lines that the slip printer station can print on a form.

Gets the size of paper that the claimed slip printer station currently uses, in the units that the ClaimedPosPrinter.MapMode property specifies.

The size of paper that the claimed slip printer station currently uses.

Gets the print area for the slip printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.

The print area for the slip printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.

Gets the side of the sheet on which the claimed slip printer station is currently printing.

The side of the sheet on which the claimed slip printer station is currently printing.

Gets the maximum number of characters that the slip printer station can print on each line in sideways mode.

The maximum number of characters that the slip printer station can print on each line in sideways mode.

Gets the maximum number of lines that the slip printer station can print in sideways mode.

The maximum number of lines that the slip printer station can print in sideways mode.

Changes the side of the sheet on which the claimed slip printer station is currently printing.

The side of the sheet on which the claimed slip printer station is currently printing.

Closes the mechanism that holds the slip in place while the slip printer station is printing, typically after the user inserts or removes the slip.

Creates a new print job for the slip printer stiation.

The new print job for the slip printer station.

Waits for the user to insert a slip into the slip printer station.

The interval of time that the operation should wait for the user to insert the slip before exiting. An asynchronous operation that returns true if the user inserts the slip within the specified time span, and returns false otherwise.

Opens the mechanism that holds the slip in place while the slip printer station is printing, typically before the user inserts or removes the slip.

Waits for the user to remove a slip from the slip printer station.

The interval of time that the operation should wait for the user to remove the slip before exiting. An asynchronous operation that returns true if the user removes the slip within the specified time span, and returns false otherwise.

Determines whether a data sequence, possibly including one or more escape sequences, is valid for the slip printer station, before you use that data sequence when you call the SlipPrintJob.Print and SlipPrintJob.ExecuteAsync methods.

The data sequence that you want to validate before you use it with the SlipPrintJob.Print method. This sequence may include printable data and escape sequences. True if the data passes validation; otherwise false.

Represents the arguments common to cash drawer event sources.

Gets the cash drawer associated with the event source.

The cash drawer.

Represents properties and actions common to all type of claimed stations for a point-of-service printer.

Gets or sets the number of characters the station can print per line of text.

The number of characters the device can print per line of text.

Gets or sets the color cartridge that the printer station should use when it prints.

An enumeration value that identifies the color cartridge that the printer station should use when it prints.

Gets whether the cartridge of the printer station is currently out of ink or toner.

True if the cartridge of the printer station is currently out of ink or toner; otherwise, false.

Gets whether the cartridge of the printer station is currently removed.

True if the cartridge of the printer station is currently removed; otherwise, false.

Gets whether the cover of the printer station is currently open.

True if the cover of the printer station is currently open; otherwise, false.

Gets whether the printer station is currently cleaning its print head.

True if the printer station is currently cleaning its print head; otherwise, false.

Gets or sets whether the printer station prints with high quality or high speed.

True if the printer station prints with high quality. False if the point-of-service printer prints with high speed.

Gets whether the printer station needs paper.

True if the printer station needs paper; otherwise, false.

Gets whether the printer station is almost out of paper.

True if the printer station is almost out of paper; otherwise, false.

Gets whether the printer station is on and accepting print jobs.

True if the printer station is on and accepting print jobs; otherwise, false.

Gets or sets the current height of the printed line for the printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current height of the printed line for the printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets or sets the spacing of each single-high print line for the printer station, in the units that the ClaimedPosPrinter.MapMode property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines.

The spacing of each single-high print line for the slip printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Gets the current width of the printed line for the printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

The current width of the printed line for the printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.

Determines whether a data sequence, possibly including one or more escape sequences, is valid for the printer station, before you use that data sequence when you call the IPosPrinterJob.Print and IPosPrinterJob.ExecuteAsync methods.

The data sequence that you want to validate before you use it with the IPosPrinterJob.Print method. This sequence may include printable data and escape sequences. True if the data passes validation; otherwise false.

Represents the capabilities common to all types of stations for point-of-service printers.

Gets information about the sensors that the printer station has available to report the status of the printer station.

A combination of enumeration values that indicate the sensors that the printer station has available to report the status of the printer station.

Gets the color cartridges that the printer station can use to print in color.

A combination of enumeration values that indicates which color cartridges the printer station can use to print in color.

Gets whether the printer station can print bold characters.

True if the printer station can print bold characters; otherwise false.

Gets whether the printer station can print characters that are both double-high and double-wide.

True if the printer station can print characters that are both double-high and double-wide; otherwise false.

Gets whether the printer station can print double-high characters.

True if the printer station can print double-high characters; otherwise false.

Gets whether the printer station can print double-wide characters.

True if the printer station can print double-wide characters; otherwise false.

Gets whether the printer station can print a dark color plus an alternate color.

True if the printer station can print a dark color plus an alternate color; otherwise false.

Gets whether the printer station can print italic characters.

True if the printer station can print italic characters; otherwise false.

Gets whether the printer station has an out-of-paper sensor.

True if the printer station has an out-of-paper sensor; otherwise false.

Gets whether the printer station has a low-paper sensor.

True if the printer station has a low-paper sensor; otherwise false.

Gets whether a printer station is present.

True if a printer station is present; otherwise false.

Gets whether the printer station can underline characters.

True if the printer station can underline characters; otherwise false.

Gets a collection of the line widths in characters per line that the printer station supports.

A collection of the line widths in characters per line that the printer station supports.

Represents the capabilities common to receipt and slip printer stations.

Gets whether the receipt or slip printer station can print in a rotated upside-down mode.

True if the receipt or slip printer station can print in a rotated upside-down mode; otherwise false.

Gets whether the receipt or slip printer station can print barcodes.

True if the receipt or slip printer station can print barcodes; otherwise false.

Gets whether the receipt or slip printer station can print bitmaps.

True if the receipt or slip printer station can print bitmaps; otherwise false.

Gets whether the receipt or slip printer station can print information rotated 90 degrees to the left.

True if the receipt or slip printer station can print information rotated 90 degrees to the left; otherwise false.

Gets whether the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print.

True if the receipt or slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false.

Gets whether the receipt or slip printer station can print information rotated 90 degrees to the right.

True if the receipt or slip printer station can print information rotated 90 degrees to the right; otherwise false.

Gets information about the capabilities of the receipt or slip printer station to draw ruled lines.

Information about the capabilities of the printer station to draw ruled lines.

Gets a list of the directions in which the receipt or slip printer station can rotate a barcode when printing.

A list of the directions in which the receipt or slip printer station can rotate a barcode when printing.

Gets a list of the directions in which the receipt or slip printer station can rotate a bitmap when printing.

A list of the directions in which the receipt or slip printer station can rotate a bitmap when printing.

Represents actions common to jobs for all types of stations for a point-of-service printer.

Runs the print job on the printer station asynchronously.

The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false.

Adds an instruction to the print job to print the specified text.

The text to print on the point-of-service printer.

Adds an instruction to the print job to print a newline character.

Adds an instruction to the print job to print the specified line of text.

The line of text to print.

Represents actions common to jobs for receipt and slip printer stations.

Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt or slip printer station.

The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. The direction in which to print the ruled line. The width of the ruled line that the printer station should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer station is used. The appearance of the ruled line, such as whether it is solid or broken, or single or double. The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the ICommonClaimedPosPrinterStation.ColorCartridge property. If an unsupported value is specified, the printing results may be unpredictable.

Adds an instruction to the print job to print a barcode on the receipt or slip printer station with the specified data and symbology.

The data to represent as a barcode. The symbology (encoding) of the barcode. The height of the barcode, in pixels. The width of the barcode, in pixels. The vertical position of the barcode text relative to the barcode. The horizontal alignment of the barcode on the page.

Adds an instruction to the print job to print a barcode on a receipt or slip printer station with the specified data, symbology, and custom alignment.

The data to represent as a barcode. The symbology (encoding) of the barcode. The height of the barcode, in pixels. The width of the barcode, in pixels. The vertical position of the barcode text relative to the barcode. The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt or slip printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt or slip printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt or slip printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt or slip printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print a bitmap on the receipt or slip printer station by using the information that you saved about the bitmap and how to print it when you called the SetBitmap or SetCustomAlignedBitmap method.

The number that you assigned to the bitmap that you want to print when you called SetBitmap or SetCustomAlignedBitmap.

Sets the rotation of the barcode on the page for the receipt or slip printer station.

The rotation of the barcode on the page.

Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt or slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt or slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Sets the area of the page on which the receipt or slip printer station can print the job.

The area of the page on which the receipt or slip printer station can print the job.

Sets the rotation of the text or image on the page for the receipt or slip printer station.

The rotation of the text or image on the page. Whether bitmaps should be rotated as well. This setting takes effect only for subsequent calls to PrintBitmap, and may not apply to saved bitmaps that you print using PrintSavedBitmap.

Represents the capabilities of journal station of a point-of-service printer.

Gets information about the sensors that the journal printer station has available to report the status of the printer cartridge.

A combination of enumeration values that indicate the set of sensors that can provide state information for the journal printer ink cartridges.

Gets the color cartridges that the journal printer station can use to print in color.

A combination of enumeration values that indicates which color cartridges the journal printer station can use to print in color.

Gets whether the journal printer station can print bold characters.

True if the journal printer station can print bold characters; otherwise false.

Gets whether the journal printer station can print characters that are both double-high and double-wide.

True if the journal printer station can print characters that are both double-high and double-wide; otherwise false.

Gets whether the journal printer station can print double-high characters.

True if the journal printer station can print double-high characters; otherwise false.

Gets whether the journal printer station can print double-wide characters.

True if the journal printer station can print double-wide characters; otherwise false.

Gets whether the journal printer station can print a dark color plus an alternate color.

True if the journal printer station can print a dark color plus an alternate color; otherwise false.

Gets whether the journal printer station can print italic characters.

True if the journal printer station can print italic characters; otherwise false.

Gets whether the journal printer station has an out-of-paper sensor.

True if the journal printer station has an out-of-paper sensor; otherwise false.

Gets whether the journal printer station has a low-paper sensor.

True if the journal printer station has a low-paper sensor; otherwise false.

Gets whether a point-of-service printer with a station that functions as a journal printer station is present.

True if a point-of-service printer with a station that functions as a journal printer station is present; otherwise false.

Gets whether the journal printer station can reverse paper feed by line.

True if the journal printer station can reverse paper feed by line; otherwise false.

Gets whether the journal printer station can reverse paper feed by map mode unit.

True if the journal printer station can reverse paper feed by map mode unit; otherwise false.

Gets whether the journal printer station can print characters in reverse-video style.

True if the journal printer station can print characters in reverse-video style; otherwise false.

Gets whether the journal printer station can print characters in strikethrough style.

True if the journal printer station can print characters in strikethrough style; otherwise false.

Gets whether the journal printer station can print characters in subscript style.

True if the journal printer station can print characters in subscript style; otherwise false.

Gets whether the journal printer station can print characters in superscript style.

True if the journal printer station can print characters in superscript style; otherwise false.

Gets whether the journal printer station can underline characters.

True if the journal printer station can underline characters; otherwise false.

Gets a collection of the line widths in characters per line that the journal printer station supports.

A collection of the line widths in characters per line that the journal printer station supports.

Represents a set of printing instructions that you want to run on the journal printer station.

Runs the print job on the journal printer station asynchronously.

The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false.

Adds an instruction to the print job to feed paper by line on the journal printer station.

The number of lines to feed on the journal printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the print job to feed paper by map mode unit on the journal printer station.

The number of map mode units to feed on the journal printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the print job to print the specified text on the journal printer station.

The text to print on the journal printer.

Adds an instruction to the print job to print the specified text and options on the journal printer station.

The text to print on the journal printer. The print options of the text to print on the journal printer.

Adds an instruction to the print job to print a newline character on the journal printer station.

Adds an instruction to the print job to print the specified line of text on the journal printer station.

The line of text to print.

Represents a line display device.

Gets the capabilities of the specified line display.

The capabilities of the line display.

Gets the device control description of the line display.

The control description of the line display.

Gets the device control version number of the line display.

The UnifiedPOS control version number of the line display, formatted as a string.

Gets the DeviceInformation.Id of the line display.

The DeviceInformation.Id of the line display.

Gets the service version number of the line display.

The UnifiedPOS service version number, formatted as a string.

Gets the physical device description.

The physical device description given by the UnifiedPOS specification.

Gets the physical device name.

The physical device name given by the UnifiedPOS specification.

Gets the standard UnifiedPOS statistics category selector strings.

The standard UnifiedPOS statistics category selector strings.

Gets the current power status of the device.

The power status of the device.

Attempts to gain exclusive access to the line display.

When the method completes, it returns a ClaimedLineDisplay.

Close the line display session, allowing it to be claimed by another client. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Creates a LineDisplay object from the DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific line display, which can be retrieved from the DeviceId property. The line display specified by the unique device identifier. Returns a null object in the following cases:

Returns the first available line display.

The first available line display. Returns a null object in the following cases:

Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays.

An Advanced Query Syntax string that is used to enumerate available line displays.

Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types

A list of the connection types to check for available line displays. An AQS string that is used to enumerate the line displays available over the specified connection types

Represents the attributes of a line display device.

Gets or sets the blink rate of the line display.

The blink rate in milliseconds.

Gets or sets the brightness of the line display.

The brightness of the line display.

Gets or sets the current character set used by the device to display characters.

The current character set.

Gets or sets the current window to which text is displayed.

The current window to which text is displayed.

Gets or sets whether character set mapping is enabled.

True if character set mapping is enabled; otherwise, False.

Gets or sets whether the device is enabled to notify the user of power state changes.

True if power state notifications are enabled; otherwise, False.

Gets or sets the current screen size.

The current screen size in characters.

Represents the line display capabilities.

Gets whether the line display supports blinking

The support for blinking.

Gets whether the line display supports changing its blink rate.

True if the line display supports changing its blink rate; otherwise, false.

Gets whether the line display supports changing its screen size.

True if the line display supports changing its screen size; otherwise, false.

Gets whether the line display supports displaying bitmaps.

True if the line display supports displaying bitmaps; otherwise, false.

Gets whether the line display supports displaying custom glyphs.

True if the line display supports displaying custom glyphs; otherwise, false.

Gets whether the line display supports mapping characters sets.

True if the line display supports mapping character sets; otherwise false.

Gets whether the line display supports reading characters at the current cursor position.

True if the line display supports reading characters at the cursor; otherwise false.

Gets whether the line display supports reversing the video display.

The support for reversing the video display.

Gets whether the line display supports adjusting the screen brightness.

True if the line display supports adjusting the screen brightness; otherwise, false.

Gets whether the line display supports a cursor.

True if the line display supports a cursor; otherwise, false.

Gets whether the line display supports horizontal marquee scrolling.

True if the line display supports horizontal marquee scrolling; otherwise, false.

Gets whether the line display supports delaying between displaying successive characters.

True if the line display supports inter-character wait; otherwise, false.

Gets whether the line display supports reporting statistics.

True if the line display supports reporting statistics; otherwise, false.

Gets whether the line display supports updating (or resetting) statistics.

True if the line display supports updating statistics; otherwise, false.

Gets whether the line display supports vertical marquee scrolling.

True if the line display supports vertical marquee scrolling; otherwise, false.

Gets the type of power reporting supported by the line display.

This property can have one of the following values:

Gets the number of descriptors supported by the line display.

The number of descriptors supported by the line display. A value of zero indicates that the line display does not support descriptors.

Gets the maximum number of windows supported by the line display.

The maximum number of windows supported by the line display.

Represents a line display cursor.

Gets whether the line display device supports customizing the cursor style.

True if the device supports customizing the cursor style; otherwise, False.

Gets whether cursor blinking is supported.

True if cursor blinking is supported; otherwise, false.

Gets whether a block cursor is supported.

True if a block cursor is supported; otherwise, False.

Gets whether a half-block cursor is supported.

True if a half-block cursor is supported; otherwise, False.

Gets whether another type (unknown as per UnifiedPOS) of cursor is supported.

True if another type of cursor is supported; otherwise, False.

Gets whether an inverted cursor is supported.

True if an inverted cursor is supported; otherwise, False.

Gets whether an underlined cursor is supported.

True if an underline cursor is supported; otherwise, False.

Gets the attributes of the line display cursor.

The attributes of the line display cursor.

Attempts to asynchronously update the attributes of the line display curor.

The attributes to be applied to the cursor. Returns True if the attributes were successfully updated; otherwise, False.

Represents the attributes of a line display cursor.

Gets or sets the type of cursor used by the line display.

The type of cursor used.

Gets or sets whether automatic advancing of the cursor is enabled.

True if automatic advancing is enabled; otherwise, False.

Gets or sets whether blinking is enabled on the cursor.

True if blinking is enabled; otherwise, False.

Gets or sets the position of the cursor.

The position of the cursor.

Defines the constants that indicate the type of cursor a line display is using.

A block cursor.

A half-block cursor.

No cursor.

Another type of cursor (not part of the UnifiedPOS specification).

An inverted cursor.

An underline cursor.

Represents a set of custom glyphs to be used by a line display.

Gets the glyph dimensions (based on the number of pixels for a character cell) supported by the device

The glyph dimensions, in pixels.

Gets the list of character codes available for redefinition as custom glyphs.

The list of character codes.

Attempts to asynchronously define a custom glyph.

The character for which the glyph will be defined. The glyph data. Returns True if the glyph was successfully defined; otherwise, False.

Defines the constants that indicate the state of a line display descriptor.

Sets the descriptor to blinking.

Turns the descriptor off.

Turns the descriptor on.

Defines the constants that indicate the horizontal alignment of text on a line display, relative to the current text character position.

Align the bitmap in the horizontal center of the current character position.

Align the bitmap's left edge with the leftmost pixel of the current charcter position.

Align the bitmap's right edge with the rightmost pixel of the current charcter position.

Represents an object containing properties describing and allowing control of marquee scrolling on a line display.

Gets or sets the current format of the marquee.

The current format of the marquee.

Gets or sets the marquee repeat wait period.

The delay between finishing a marquee scroll and starting over again.

Gets or sets the scroll wait interval.

The delay between placing or walking each character in the marquee.

Attempts to asynchronously cause the window which owns this marquee to enter Marquee Mode and start scrolling.

The direction in which to start scrolling. Returns True if the marquee successfully started scrolling; otherwise, False.

Attempts to asynchronously exit Marquee mode and/or Marquee Init mode. Format is set to None.

Returns True if the marquee was successfully stopped; otherwise, False.

Defines the constants that indicate the marquee format for the current window.

Marquee scrolling is disabled.

The display is populated by placing data. For example, if the scrolling direction is left, then the viewport is filled by placing characters starting at the left side, and beginning scrolling only after the viewport is full.

The display is populated by walking data from the opposite end of the display as the scrolling direction. For example, if the scrolling direction is Left, then the viewport is filled by bringing characters in from the right side and scrolling them to the left.

Defines the constants that indicate the power status of a line display.

The line display is off.

The line display is offline.

The line display is either off or offline.

The line display is online.

The power state is unknown.

Defines the constants that indicate the scrolling direction of the line display.

The line display scrolls right. Only supported if the parent LineDisplay.IsHorizontalMarqueeSupported is True.

The line display scrolls left. Only supported if the parent LineDisplay.IsHorizontalMarqueeSupported is True.

The line display scrolls down. Only supported if the parent LineDisplay.IsVerticalMarqueeSupported is True.

The line display scrolls up. Only supported if the parent LineDisplay.IsVerticalMarqueeSupported is True.

Represents a standard statistics category selector.

Retrieves all device statistics when provided to ClaimedLineDisplay.GetStatisticsAsync(IEnumerable<String>).

The UnifiedPOS value for retrieving all statistics from a device.

Retrieves manufacturer-defined statistics when provided to [ClaimedLineDisplay.GetStatisticsAsync(IEnumerable<String>)](claimedlinedisplay_getstatisticsasync_980600774.md.

The UnifiedPOS value for retrieving manufacturer-defined statistics from a device.

Retrieves UnifiedPOS statistics when provided to ClaimedLineDisplay.GetStatisticsAsync(IEnumerable<String>).

The UnifiedPOS value for retrieving UnifiedPOS statistics from a device.

Provides event data for power state changes in the line display device.

Gets the current power status of the device.

The current power status of the device.

Represents an object used to store a bitmap via the LineDisplayWindow.StoreBitmapAsync method.

Gets the UnifiedPOS escape sequence that is used to print images inline with text.

A string that, when printed to the line display device, displays this bitmap at the cursor position.

Attempts to asynchronously delete the stored bitmap.

Returns True if the bitmap was successfully deleted; otherwise, False.

Defines the constants that indicate whether the line display is reversed or blinking.

The display is blinking.

The display not reverse or blinking (ie. normal).

The display is reversed.

The display is reversed and blinking.

Defines the constants that indicate whether the line display supports blinking or reversing the display.

The feature is supported for the entire display.

The feature is not supported.

The feature is supported for individual characters.

Defines the constants that indicate the vertical alignment of text on a line display, relative to the current text character position.

Align the bitmap's bottom edge with the bottommost pixel of the current charcter position.

Align the bitmap in the vertical center of the current character position.

Align the bitmap's top edge with the topmost pixel of the current charcter position.

Represents a line display window.

Gets the cursor of the line display window.

The cursor of the line display window.

Gets or sets the delay interval between displaying successive characters.

The delay interval between displaying successive characters. The default value of this property is 0.

Gets the line display marquee.

The line display marquee.

Gets dimensions of the window, in number of character lines (rows and columns).

The number of character lines (rows and columns).

Closes the line display window resource, destroying the window on the device.

Attempts to asynchronously read the currently displayed character at the current cursor position.

Returns the code for the character at the current cursor position. Returns 0 if the method fails.

Clears the current window. Changers all characters to blanks, clears any bitmaps displayed in the window, and sets **Cursor.Position** to {0,0}.

True if the window was successfully cleared; otherwise, false.

Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

The bitmap to be displayed. Return True if the bitmap was successfully displayed; otherwise, False.

Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

The bitmap to be displayed. The horizontal alignment of the bitmap relative to the current text character position. The vertical alignment of the bitmap relative to the current text character position. Return True if the bitmap was successfully displayed; otherwise, False.

Attempts to asynchronously display a bitmap from a storage file at the current cursor position, at a particular width.

The bitmap to be displayed. The horizontal alignment of the bitmap relative to the current text character position. The vertical alignment of the bitmap relative to the current text character position. The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled). Return True if the bitmap was successfully displayed; otherwise, False.

Attempts to asynchronously display a bitmap from a storage file at a particular point.

The bitmap to be displayed. The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}. Return True if the bitmap was successfully displayed; otherwise, False.

Attempts to asynchronously display a bitmap from a storage file at a particular point, scaled to a particular width.

The bitmap to be displayed. The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}. The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled). Return True if the bitmap was successfully displayed; otherwise, False.

Attempts to asynchronously display a stored bitmap from at LineDisplayStoredBitmap object at the current cursor position.

The bitmap to be displayed. Returns True if the bitmap was successfully displayed; otherwise, False.

Try to display the specified text in the line display window.

The text to be displayed. True if the text was displayed successfully; otherwise, false.

Try to display the specified text in the line display window, using the specified display attribute.

The text to be displayed. The display attribute to be applied to the window. True if the text was displayed successfully; otherwise, false.

Try to display the specified text at a specified position in the line display window, using the specified display attribute.

The text to be displayed. The display attribute to be applied to the window. The row and column at which to start displaying the text. True if the text was displayed successfully; otherwise, false.

Refresh the line display window.

True if the window was successfully refreshed; otherwise, false.

Scroll the window text contents the specified number of lines in the specified direction.

The direction in which to scroll text. The number of columns or rows to scroll. Columns are used if the scroll direction is left or right; rows are used if the scroll direction is up or down.

Represents the magnetic stripe reader device.

Gets the capabilities of the magnetic stripe reader.

The capabilities of the magnetic stripe reader.

Device authentication protocol supported by the magnetic stripe reader.

The supported authentication protocol.

Gets the DeviceInformation.Id of the magnetic stripe reader.

The DeviceInformation.Id of the magnetic stripe reader.

Gets the card types supported by the magnetic stripe reader.

The card type identifier.

Occurs when the device detects an operation status change.

Tests the health of the magnetic stripe reader.

The specific health check level. A text description of the text result. Returns an error if the specified check level is not supported by the device.

Attempts to get an exclusive access to the magnetic stripe reader.

When the method completes, it returns a ClaimedMagneticStripeReader or it returns null if the operation fails to claim a magnetic stripe reader.

Close the magnetic stripe reader session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Creates a MagneticStripeReader object from DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific magnetic stripe reader, which can be retrieved from the DeviceId property. The magnetic stripe reader specified by the unique device identifier. Returns a null object in the following cases:

Returns the first magnetic stripe reader found.

The first magnetic stripe reader found. Returns a null object in the following cases:

Returns an Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers.

An Advanced Query Syntax (AQS) string that is used to enumerate available magnetic stripe readers.

Gets an Advanced Query Syntax (AQS) string that you can use to list the magnetic stripe readers available over the specified connection types

A list of the connection types to check for available magnetic stripe readers. An Advanced Query Syntax (AQS) string that is used to enumerate the magnetic stripe readers available over the specified connection types

Gets the error reporting type the application wants to receive.

The error reporting type.

Retrieves the requested statistics from the magnetic stripe reader.

The list of statistics to retrieve. IBuffer representing the requested statistics.

Provides the American Association of Motor Vehicle Administrators (AAMVA) card data from the AamvaCardDataReceived event.

Gets the address from the swiped AAMVA card.

The address from the swiped AAMVA card.

Gets the birth date from the swiped AAMVA card.

The birth date from the swiped AAMVA card.

Gets the city from the swiped AAMVA card.

The city from the swiped AAMVA card.

Gets the class from the swiped AAMVA card.

The class from the swiped AAMVA card.

Gets the endorsements from the swiped AAMVA card.

The endorsements from the swiped AAMVA card.

Gets the expiration date from the swiped AAMVA card.

The expiration date from the swiped AAMVA card.

Gets the eye color from the swiped AAMVA card.

The eye color from the swiped AAMVA card.

Gets the first name from the swiped AAMVA card.

The first name from the swiped AAMVA card.

Gets the gender from the swiped AAMVA card.

The gender from the swiped AAMVA card.

Gets the hair color from the swiped AAMVA card.

The hair color from the swiped AAMVA card.

Gets the height from the swiped AAMVA card.

The height from the swiped AAMVA card.

Gets the license number from the swiped AAMVA card.

The license number from the swiped AAMVA card.

Gets the postal code from the swiped AAMVA card.

The postal code from the swiped AAMVA card.

Gets the additional data from the swiped AAMVA card.

The report from the swiped AAMVA card.

Gets the restrictions from the swiped AAMVA card.

The restrictions from the swiped AAMVA card.

Gets the state from the swiped AAMVA card.

The state from the swiped AAMVA card.

Gets the suffix from the swiped AAMVA card.

The suffix from the swiped AAMVA card.

Gets the surname from the swiped card.

The surname from the swiped AAMVA card.

Gets the weight from the swiped AAMVA card.

The weight from the swiped AAMVA card.

Defines the constants that indicates the level of support for magnetic stripe reader authentication protocol: NotSupported, Optional, or Required.

Does not support authentication.

Supports authentication, but does not require it.

Requires authentication.

Defines the constants that indicates the authentication protocol supported by the device.

The device supports challenge response protocol.

The device does not support device authentication.

Provides bank card data from the BankCardDataReceived event.

Gets the account number from the swiped bank card.

The account number from the swiped bank card.

Gets the expiration date from the swiped card.

The expiration date from the swiped card.

Gets the first name from the swiped bank card.

The first name from the swiped bank card.

Gets the middle initial from the swiped bank card.

The middle initial from the swiped bank card.

Gets the data from the swiped bank card.

The data from the swiped bank card.

Gets the service code for the swiped bank card.

The service code for the swiped bank card.

Gets the suffix from the swiped bank card.

The suffix from the swiped bank card.

Gets the surname from the swiped bank card.

The surname from the swiped bank card.

Gets the title from the swiped bank card.

The title from the swiped bank card.

Provides capabilities information for the magnetic stripe reader.

Gets the authentication level supported by the device.

The supported authentication level.

Gets the type of card authentication data that is supported by the device.

The string containing the type of card authentication data.

Indicates whether the device supports ISO cards.

True if the device supports ISO cards; otherwise, false.

Indicates whether device supports JIS Type-I cards.

True if the device support JIS Type-I cards; otherwise, false.

Indicates whether the device supports JIS Type-II cards.

True if the device supports JIS Type-II cards; otherwise, false.

Indicates whether the device supports reporting of usage statistics.

True if the device supports reporting of usage statistics; otherwise, false.

Indicates whether the device supports updating of usage statistics.

True if the device supports updating of statistics; otherwise, false.

Indicates whether the device is capable of masking track data.

True if the device is capable of masking track data; otherwise, false.

Indicates whether the devices is able to transmit start and end sentinels.

True if the device is able to transmit start and end sentinels; otherwise, false.

Gets the power reporting capabilities of the device.

The power reporting capabilities of the device.

Gets the supported encryption algorithm.

The supported encryption algorithm.

Contains the card type of the recently swiped card.

Indicates the American Association of Motor Vehicle Administrators (AAMVA) card type.

The AAMVA card type.

Indicates a bank card type.

Bank card type.

Indicates vendor-specific card type.

Vendor-specific card type.

Indicates an unknown card type.

Unknown card type.

Contains the encryption algorithm supported by the device.

Indicates vendor specific encryption algorithm.

Vendor-specific algorithm.

Indicates no encryption algorithm.

No encryption algorithm.

Indicates Triple DES DUKPT (Derived Unique Key Per Transaction) encryption algorithm supported by the device.

The Triple DES DUKPT encryption algorithm.

Provides error information for the ErrorOccurred event.

Gets the error information, such as cause of error, severity, error message, and any available vendor specific error information.

The error information.

Gets the track data for tracks the did not have errors.

The track data for tracks the did not have errors.

Gets the Track 1 error information.

The Track 1 error information.

Gets the Track 2 error information.

The Track 2 error information.

Gets the Track 3 error information.

The Track 3 error information.

Gets the Track 4 error information.

The Track 4 error information.

Defines the constants that indicates the error reporting type for the device.

Report errors at the card level.

Report errors at the track level.

Contains data from the recently swiped card.

Gets the additional security or encryption information for the recently swiped card.

The additional security or encryption information.

Gets the card authentication information for the recently swiped card.

The card authentication data.

Gets the length of the raw CardAuthenticationData before it is encrypted.

The length of the raw CardAuthenticationData before it is encrypted.

Gets the card type identifier for the recently swiped card.

The card type identifier.

Gets a dictionary of properties for the recently swiped card.

A dictionary of properties.

Gets the track data for Track 1.

The Track 1 data.

Gets the track data for Track 2.

The Track 3 data.

Gets the track data for Track 3.

The Track 3 data.

Gets the track data for Track 4.

The Track 4 data.

Defines the constants that indicate the device authentication status.

An authenticated device.

Vendor specific status.

A device not authenticated.

Provides information about an operation status change.

Gets the vendor specific error code.

The vendor specific error code.

Gets the status change information.

The status change information.

Contains the track data obtained following a card swipe.

Gets the raw or decoded data from the swiped card.

The track data from the swiped card.

Gets the discretionary data from the swiped card.

The discretionary data from the swiped card.

Gets the encrypted data from the swiped card.

The encrypted data from the swiped card.

Defines the constants that indicates the track error type.

An end sentinel error.

An LRC error.

No specified error.

A parity error.

A start sentinel error.

An unknown error.

Defines the constants that indicates the device track ID to read.

No track ID

Read track 1

Read track 2

Read track 3

Read track 4

Provides data for the recently swiped vendor card.

Gets data for the recently swiped vendor card.

The vendor specific data.

Connection types that can be used to access a point of service device.

All connection types.

Devices with a Bluetooth radio.

Devices with an IP address, including both Wired Ethernet and Wi-Fi.

Locally connected devices, such as USB.

Represents a point-of-service printer.

Gets the capabilities of the point-of-service printer.

The capabilities of the point-of-service printer.

Gets the identifier of the point-of-service printer.

The identifier of the point-of-service printer.

Gets the current status of the power and availability of the point-of-service printer.

The current status of the power and availability of the point-of-service printer.

Gets the barcode symbologies that the point-of-service printer supports.

The barcode symbologies that the point-of-service printer supports.

Gets the list of character sets that the point-of-service printer supports.

The list of numeric values for the character sets that the point-of-service-printer supports.

Gets the fonts and typefaces that the point-of-service printer supports.

The fonts and typefaces that the point-of-service printer supports.

Occurs when the status of the power or availability of the point-of-service printer changes.

Gets the health state of the point-of-service printer asynchronously.

The type of health check that you want to perform for the point-of-service printer. Only level POSInternal(1) should be used, as any other UnifiedPosHealthCheckLevel levels will result in an error. An asynchronous operation that returns the health state of the point-of-service printer. You should display this value in the app interface immediately so the user of the app can interpret the value. For example, the operation returns “OK” as the health state if the state of the point-of-service printer is good.

Claims the point-of-service printer for use, and gets an instance of the ClaimedPosPrinter class for the point-of-service printer.

The claimed point-of-service printer.

Close the POS printer session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

Creates a PosPrinter object for point-of-service printer with the specified DeviceInformation.Id.

The DeviceInformation.Id that identifies a specific point-of-service printer. The point-of-service printer that the unique device identifier identifies. Returns a null object in the following cases:

Gets the default paired or locally-connected printer.

The default locally-connected printer.

Gets an Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers.

An Advanced Query Syntax (AQS) string that you can use to list the available point-of-service printers.

Gets an Advanced Query Syntax (AQS) string that you can use to list the point-of-service printers available over the specified connection types

A list of the connection types to check for available point-of-service printers. An Advanced Query Syntax (AQS) string that is used to enumerate the point-of-service printers available over the specified connection types

Gets the specified font property from the point-of-service printers.

The typeface of the font property to retrieve. The requested font property.

Gets the specified statistics from the point-of-service printer.

The list of statistics to retrieve. The requested statistics.

Describes the possible horizontal alignments of the text that a point-of-service printer prints on the page.

Text is centered.

Text is left-aligned.

Text is right-aligned.

Describes the possible vertical positions in which a point-of-service printer prints the barcode text relative to the barcode.

The barcode text is above the barcode.

The barcode text is below the barcode.

There is no barcode text.

Represents the capabilities of the point-of-service printer.

Gets whether the point-of-service printer can map the characters that the application sends (in the character set that the ClaimedPosPrinter.CharacterSet property defines) to the character sets that the PosPrinter.SupportedCharacterSets property defines.

True if the point-of-service printer can map the characters that the application sends to the code page used by the printer. If false, the user must make sure that the Unicode characters have the low byte as the value that will be used to send to the printer.

Gets the character set that the point-of-service printer uses by default.

The character set that the point-of-service printer uses by default.

Gets whether the point-of-service printer has a sensor that detects if the printer cover is open.

True if the point-of-service printer has a sensor that detects if the printer cover is open; otherwise false.

Gets whether the point-of-service printer supports reporting statistics.

True if the point-of-service printer supports reporting statistics; otherwise, false.

Gets whether the point-of-service printer supports updating statistics.

True if the point-of-service printer supports updating statistics; otherwise, false.

Gets whether the point-of-service printer supports printer transactions.

True if the point-of-service printer supports printer transactions; otherwise false.

Gets the capabilities of the journal station for the point-of-service printer.

The capabilities of the journal station for the point-of-service printer.

Gets the power reporting capabilities of the point-of-service printer.

The power reporting capabilities of the point-of-service printer, such as whether the printer can determine and report two or three different power states.

Gets the capabilities of the receipt station for the point-of-service printer.

The capabilities of the receipt station for the point-of-service printer.

Gets the capabilities of the slip station for the point-of-service printer.

The capabilities of the slip station for the point-of-service printer.

Describes the possible sensors available for a printer station of a point-of-service printer to use to report the status of the printer.

The printer station has a sensor that detects if the cartridge is empty.

The printer station has a sensor that detects if the head of the printer cartridge is being cleaned.

The printer station has a sensor that detects if the printer cartridge is almost out of ink or toner.

The printer station does not have any sensors available to report the status of the station.

The printer station has a sensor that detects if the cartridge is removed.

Represents the set of identifiers for the character sets that a point-of-service printer can use.

Gets the identifier for the ANSI character set.

The identifier for the ANSI character set.

Gets the identifier for the ASCII character set.

The identifier for the ASCII character set.

Gets the identifier for the UTF16LE character set.

The identifier for the UTF16LE character set.

Describes the possible color cartridges that a point-of-service printer can support.

Supports a first custom color cartridge, which provides a secondary color, usually red.

Supports a second custom color cartridge.

Supports a third custom color cartridge.

Supports a fourth custom color cartridge.

Supports a fifth custom color cartridge.

Supports a sixth custom color cartridge.

Supports a cyan cartridge for full color printing.

Supports full color printing.

Supports a magenta cartridge for full color printing.

Supports no color cartridges.

Supports a primary color cartridge.

Supports a yellow cartridge for full color printing.

Describes the color cartridges that the point-of-service printer can use for printing.

The first custom color cartridge, which provides a secondary color, usually red.

The second custom color cartridge.

The third custom color cartridge.

The fourth custom color cartridge.

The fifth custom color cartridge.

The sixth custom color cartridge.

The cyan cartridge for full color printing.

The magenta cartridge for full color printing.

The primary color cartridge.

An unknown color cartridge.

The yellow cartridge for full color printing.

Represents the property of a specific point-of-service printer font.

Gets the list of character sizes of the point-of-service printer font.

The list of numeric value pairs for the character sizes of the point-of-service-printer font.

Gets whether the point-of-service printer font is scalable to any size.

True if the point-of-service printer font is scalable to any size; otherwise, false.

Gets the typeface of the point-of-service printer font.

The typeface of the point-of-service printer font.

Describes the possible directions that a receipt or slip printer station can use to print a ruled line.

Prints a horizontal ruled line.

Prints a vertical ruled line.

Describes the line styles that a receipt or slip printer station can use to print a ruled line.

Prints a sequence of short lines separated by spaces.

Prints a sequence of short lines separated by a space, then followed by a very short line, followed by a space, then followed by a short line again.

Prints a continuous solid line of double the normal thickness.

Prints a continuous solid line.

Describes the valid units of measure for point-of-service printers.

The dot width for the point-of-service printer.

0.001 inch.

0.01 millimeter.

1/1440 of an inch.

Describes the capabilities of a receipt printer station for handling mark-sensed paper.

The receipt printer station cannot feed the mark-sensed paper.

The receipt printer station can feed the mark-sensed paper to the top of the form for the present paper, reverse feeding the paper if required.

The receipt printer station can feed the mark-sensed paper to the cutting position for the automatic cutter.

The receipt printer station can feed the mark-sensed paper to the top of the form for the next paper.

The receipt printer station can feed the mark-sensed paper to the paper take-up position.

Describes the ways the receipt printer station should feed the mark-sensed paper when you call the ReceiptPrintJob.MarkFeed method.

Feeds the mark-sensed paper to the top of the form for the present paper, reverse feeding the paper if required.

Feeds the mark-sensed paper to the cutting position for the automatic cutter.

Feeds the mark-sensed paper to the top of the form for the next paper.

Feeds the mark-sensed paper to the paper take-up position.

Represents the print options of the text that you want to print to a point-of-service printer.

Creates an instance of PosPrinterPrintOptions.

Gets or sets a value that indicates the alignment that the application wants to use for printing text.

The alignment that the application wants to use for printing text.

Gets or sets a value that indicates if the application wants to print characters in bold style.

True if the application wants to print characters in bold style; otherwise, false.

Gets or sets a numeric value that indicates the character height that the application wants to use for printing characters.

The character height that the application wants to use for printing characters. The value must be 0 or one of the supported height values of the font if the font is not scalable.

Gets or sets a numeric value that indicates the character set that the application wants to use for printing characters.

The character set that the application wants to use for printing characters. The value must be 0 or one of the supported character set values of the point-of-service printer.

Gets or sets a value that indicates if the application wants to print characters in double-high style.

True if the application wants to print characters in double-high style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in double-wide style.

True if the application wants to print characters in double-wide style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in italic style.

True if the application wants to print characters in italic style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in reverse-video style.

True if the application wants to print characters in reverse-video style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in strikethrough style.

True if the application wants to print characters in strikethrough style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in subscript style.

True if the application wants to print characters in subscript style; otherwise, false.

Gets or sets a value that indicates if the application wants to print characters in superscript style.

True if the application wants to print characters in superscript style; otherwise, false.

Gets or sets a string value that indicates the typeface that the application wants to use for printing characters.

The typeface that the application wants to use for printing characters.

Gets or sets a value that indicates if the application wants to print characters in underline style.

True if the application wants to print characters in underline style; otherwise, false.

Describes the sides of the sheet of paper on which the point-of-service printer prints.

The point-of-service printer is printing or should print on the front side of the sheet.

The point-of-service printer is printing or should print on the back side of the sheet.

The side on which the point-of-service printer is currently printing is unknown.

Provides information about the ClaimedPosPrinter.ReleaseDeviceRequested event that occurs when a point-of-service printer gets a request to release its exclusive claim.

Describes the possible ways that a point-of-service printer can rotate the text or image on the page.

The text or image is rotated 90 degrees counterclockwise.

The text or image is not rotated.

The text or image is rotated 90 degrees clockwise.

The text or image is upside-down.

Describes the capabilities of the point-of-service printer to draw ruled lines.

The printer can draw ruled horizontal lines.

The printer cannot draw ruled lines.

The printer can draw ruled vertical lines.

Provides information about the status of a point-of-service printer, such as the power state of the printer.

Gets extended information about the power state of the point-of-service printer that the original equipment manufacturer (OEM) defines. Value is only valid if the PosPrinterStatus.StatusKind property is **PosPrinterStatusKind.Extended**.

An OEM-defined value that provides extended information about the power state of the point-of-service printer when the value of the PosPrinterStatus.StatusKind property is **PosPrinterStatusKind.Extended**.

Gets the power state of a point-of-service printer.

The power state of a point-of-service printer.

Describes the power state for a point-of-service printer.

The original equipment manufacturer (OEM) reports extended information about the power state of the printer in the PosPrinterStatus.ExtendedStatus property.

The printer is turned off or disconnected from the terminal.

The printer is turned on, but it is not ready or not able to respond to requests.

The printer is either turned off, or turned on but not ready or not able to respond to requests.

The printer is online.

Provides information about the PosPrinter.StatusUpdated event that occurs when the status of a point-of-service printer changes.

Gets the new status of the point-of-service printer after the status of the printer changes.

The new status of the point-of-service printer after the status of the printer changes.

Represents the capabilities of receipt station of a point-of-service printer.

Gets whether the receipt printer station can perform paper cuts.

True if the receipt printer station can perform paper cuts; otherwise false.

Gets information about the sensors that the receipt printer station has available to report the status of the printer station.

A combination of enumeration values that indicate the sensors that the receipt printer station has available to report the status of the printer station.

Gets the color cartridges that the receipt printer station can use to print in color.

A combination of enumeration values that indicates which color cartridges the receipt printer station can use to print in color.

Gets whether the receipt printer station can print in a rotated upside-down mode.

True if the receipt printer station can print in a rotated upside-down mode; otherwise false.

Gets whether the receipt printer station can print barcodes.

True if the receipt printer station can print barcodes; otherwise false.

Gets whether the receipt printer station can print bitmaps.

True if the receipt printer station can print bitmaps; otherwise false.

Gets whether the receipt printer station can print bold characters.

True if the receipt printer station can print bold characters; otherwise false.

Gets whether the receipt printer station can print characters that are both double-high and double-wide.

True if the receipt printer station can print characters that are both double-high and double-wide; otherwise false.

Gets whether the receipt printer station can print double-high characters.

True if the receipt printer station can print double-high characters; otherwise false.

Gets whether the receipt printer station can print double-wide characters.

True if the receipt printer station can print double-wide characters; otherwise false.

Gets whether the receipt printer station can print a dark color plus an alternate color.

True if the receipt printer station can print a dark color plus an alternate color; otherwise false.

Gets whether the receipt printer station can print italic characters.

True if the receipt printer station can print italic characters; otherwise false.

Gets whether the receipt printer station can print information rotated 90 degrees to the left.

True if the receipt printer station can print information rotated 90 degrees to the left; otherwise false.

Gets whether the receipt printer station has an out-of-paper sensor.

True if the receipt printer station has an out-of-paper sensor; otherwise false.

Gets whether the receipt printer station has a low-paper sensor.

True if the receipt printer station has a low-paper sensor; otherwise false.

Gets whether the receipt printer station supports setting a custom size for the area of the page on which the printer should print.

True if the receipt printer station supports setting a custom size for the area of the page on which the printer should print; otherwise false.

Gets whether a point-of-service printer with a station that prints receipts is present.

True if a point-of-service printer with a station that prints receipts is present; otherwise false.

Gets whether the receipt printer station can reverse paper feed by line.

True if the receipt printer station can reverse paper feed by line; otherwise false.

Gets whether the receipt printer station can reverse paper feed by map mode unit.

True if the receipt printer station can reverse paper feed by map mode unit; otherwise false.

Gets whether the receipt printer station can print characters in reverse-video style.

True if the receipt printer station can print characters in reverse-video style; otherwise false.

Gets whether the receipt printer station can print information rotated 90 degrees to the right.

True if the receipt printer station can print information rotated 90 degrees to the right; otherwise false.

Gets whether the receipt printer station has a stamp capability.

True if the receipt printer station has a stamp capability; otherwise false.

Gets whether the receipt printer station can print characters in strikethrough style.

True if the receipt printer station can print characters in strikethrough style; otherwise false.

Gets whether the receipt printer station can print characters in subscript style.

True if the receipt printer station can print characters in subscript style; otherwise false.

Gets whether the receipt printer station can print characters in superscript style.

True if the receipt printer station can print characters in superscript style; otherwise false.

Gets whether the receipt printer station can underline characters.

True if the receipt printer station can underline characters; otherwise false.

Gets the type of mark-sensed paper handling that is available for the receipt printer station.

A logical OR combination of values that indicate the type of mark-sensed paper handling that is available for the receipt printer station.

Gets information about the capabilities of the receipt printer station to draw ruled lines.

Information about the capabilities of the receipt printer station to draw ruled lines.

Gets a list of the directions in which the receipt printer station can rotate a barcode when printing.

A list of the directions in which the receipt printer station can rotate a barcode when printing.

Gets a list of the directions in which the receipt printer station can rotate a bitmap when printing.

A list of the directions in which the receipt printer station can rotate a bitmap when printing.

Gets a collection of the line widths in characters per line that the receipt printer station supports.

A collection of the line widths in characters per line that the receipt printer station supports.

Represents a set of printing instructions that you want to run on the receipt printer.

Adds an instruction to the printer job to cut the receipt paper completely.

Adds an instruction to the printer job to cut the specified percentage of the receipt paper.

Decimal representation of the percentage of the receipt that the receipt printer should cut.

Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt printer station.

The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line (see remarks). The direction in which to print the ruled line. The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. The appearance of the ruled line, such as whether it is solid or broken, or single or double. The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the ClaimedReceiptPrinter.ColorCartridge property. If an unsupported value is specified, the printing results may be unpredictable.

Runs the print job on the receipt printer station asynchronously.

The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false.

Adds an instruction to the print job to feed paper by line on the receipt printer station.

The number of lines to feed on the receipt printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the print job to feed paper by map mode unit on the receipt printer station.

The number of map mode units to feed on the receipt printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the printer job to use the mark sensor of the receipt printer station to position the receipt paper.

An enumeration value that specifies how to position the receipt paper.

Adds an instruction to the print job to print the specified text on the receipt printer station.

The text to print on the receipt printer station.

Adds an instruction to the print job to print the specified text and options on the receipt printer station.

The text to print on the receipt printer. The print options of the text to print on the receipt printer.

Adds an instruction to the print job to print a barcode with the specified data and symbology on the receipt printer station.

The data to be represented as a barcode. The symbology (encoding) of the barcode. This can be determined based on the BarcodeSymbologies class static methods. The height of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width of the barcode. The vertical position of the barcode text relative to the barcode. The horizontal alignment of the barcode on the page.

Adds an instruction to the print job to print a barcode with the specified data, symbology, and custom alignment on the receipt printer station.

The data to be represented as a barcode. The symbology (encoding) of the barcode. The height of the barcode, in pixels. The width of the barcode, in pixels. The vertical position of the barcode text relative to the barcode. The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPriinter.MapMode property.

Adds an instruction to the print job to print a newline character on the receipt printer station.

Adds an instruction to the print job to print a line of text on the receipt printer station.

The line of text to print.

Adds an instruction to the print job to print a bitmap on the receipt printer station by using the bitmap and information saved to the printer via SetBitmap or SetCustomAlignedBitmap.

The number that you assigned to the bitmap that you want to print when you called SetBitmap or SetCustomAlignedBitmap.

Sets the rotation of the barcode on the page on the receipt printer station.

The rotation of the barcode on the page.

Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Sets the area of the page on which the receipt printer station can print the job.

The area of the page on which the receipt printer can print the job.

Sets the rotation of the text or image on the page for the receipt printer station.

The rotation of the text or image on the page for the receipt printer station. Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to PrintBitmap, and may not apply to saved bitmaps that you print using PrintSavedBitmap.

Adds an instruction to the print job to stamp on the receipt printer station.

Defines the height and width of an object in a two-dimensional plane.

The height of an object.

The width of an object.

Represents the capabilities of slip station of a point-of-service printer.

Gets information about the sensors that the slip printer station has available to report the status of the printer station.

A combination of enumeration values that indicate the sensors that the slip printer station has available to report the status of the printer station.

Gets the color cartridges that the slip printer station can use to print in color.

A combination of enumeration values that indicates which color cartridges the slip printer station can use to print in color.

Gets whether the slip printer station can print in a rotated upside-down mode.

True if the slip printer station can print in a rotated upside-down mode; otherwise false.

Gets whether the slip printer station can print barcodes.

True if the slip printer station can print barcodes; otherwise false.

Gets whether the slip printer station can print bitmaps.

True if the slip printer station can print bitmaps; otherwise false.

Gets whether the slip printer station can print bold characters.

True if the slip printer station can print bold characters; otherwise false.

Gets whether the slip printer station supports printing on both sides of the document.

True if the slip printer station supports printing on both sides of the document; otherwise, false.

Gets whether the slip printer station can print characters that are both double-high and double-wide.

True if the slip printer station can print characters that are both double-high and double-wide; otherwise false.

Gets whether the slip printer station can print double-high characters.

True if the slip printer station can print double-high characters; otherwise false.

Gets whether the slip printer station can print double-wide characters.

True if the slip printer station can print double-wide characters; otherwise false.

Gets whether the slip printer station can print a dark color plus an alternate color.

True if the slip printer station can print a dark color plus an alternate color; otherwise false.

Gets whether the slip printer station can print full-length forms.

True if the slip printer station can print full-length forms. False if the slip printer station is a validation-type station. Validation-type stations usually limit the number of print lines and turn off access to the receipt and journal stations while the validation slip is used.

Gets whether the slip printer station can print italic characters.

True if the slip printer station can print italic characters; otherwise false.

Gets whether the slip printer station can print information rotated 90 degrees to the left.

True if the slip printer station can print information rotated 90 degrees to the left; otherwise false.

Gets whether the slip printer station has an out-of-paper sensor.

True if the slip printer station has an out-of-paper sensor; otherwise false.

Gets whether the slip printer station has a low-paper sensor.

True if the slip printer station has a low-paper sensor; otherwise false.

Gets whether the slip printer station supports setting a custom size for the area of the page on which the printer station should print.

True if the slip printer station supports setting a custom size for the area of the page on which the printer station should print; otherwise false.

Gets whether a point-of-service printer with a station that prints forms such as checks or credit card slips is present.

True if a point-of-service printer with a station that prints forms such as checks or credit card slips is present; otherwise false.

Gets whether the slip printer station can reverse paper feed by line.

True if the slip printer station can reverse paper feed by line; otherwise false.

Gets whether the slip printer station can reverse paper feed by map mode unit.

True if the slip printer station can reverse paper feed by map mode unit; otherwise false.

Gets whether the slip printer station can print characters in reverse-video style.

True if the slip printer station can print characters in reverse-video style; otherwise false.

Gets whether the slip printer station can print information rotated 90 degrees to the right.

True if the slip printer station can print information rotated 90 degrees to the right; otherwise false.

Gets whether the slip printer station can print characters in strikethrough style.

True if the slip printer station can print characters in strikethrough style; otherwise false.

Gets whether the slip printer station can print characters in subscript style.

True if the slip printer station can print characters in subscript style; otherwise false.

Gets whether the slip printer station can print characters in superscript style.

True if the slip printer station can print characters in superscript style; otherwise false.

Gets whether the slip printer station can underline characters.

True if the slip printer station can underline characters; otherwise false.

Gets information about the capabilities of the slip printer station to draw ruled lines.

Information about the capabilities of the slip printer station to draw ruled lines.

Gets a list of the directions in which the slip printer station can rotate a barcode when printing.

A list of the directions in which the slip printer station can rotate a barcode when printing.

Gets a list of the directions in which the slip printer station can rotate a bitmap when printing.

A list of the directions in which the slip printer station can rotate a bitmap when printing.

Gets a collection of the line widths in characters per line that the slip printer station supports.

A collection of the line widths in characters per line that the slip printer station supports.

Represents a set of printing instructions that you want to run on the slip printer station.

Adds an instruction to the print job to print a drawn, ruled line on the paper of the slip printer station.

The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line. The direction in which to print the ruled line. The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used. The appearance of the ruled line, such as whether it is solid or broken, or single or double. The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the ClaimedSlipPrinter.ColorCartridge property. If an unsupported value is specified, the printing results may be unpredictable.

Runs the print job on the slip printer station asynchronously.

The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false.

Adds an instruction to the print job to feed paper by line on the slip printer station.

The number of lines to feed on the slip printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the print job to feed paper by map mode unit on the slip printer station.

The number of map mode units to feed on the slip printer. Use a positive number to feed paper forward or a negative number to feed paper backward.

Adds an instruction to the print job to print the specified text on the slip printer station.

The text to print on the slip printer station.

Adds an instruction to the print job to print the specified text and options on the slip printer station.

The text to print on the slip printer. The print options of the text to print on the slip printer.

Adds an instruction to the print job to print a barcode on the slip printer station with the specified data and symbology.

The data to represent as a barcode. The symbology (encoding) of the barcode. The height of the barcode, in pixels. The width of the barcode, in pixels. The vertical position of the barcode text relative to the barcode. The horizontal alignment of the barcode on the page.

Adds an instruction to the print job to print a barcode on the slip printer station with the specified data, symbology, and custom alignment.

The data to represent as a barcode. The symbology (encoding) of the barcode. The height of the barcode, in pixels. The width of the barcode, in pixels. The vertical position of the barcode text relative to the barcode. The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the slip printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the slip printer station.

Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the slip printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the slip printer station.

Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Adds an instruction to the print job to print a newline character on the slip printer station.

Adds an instruction to the print job to print a line of text on the slip printer station.

The line of text to print.

Adds an instruction to the print job to print a bitmap on the slip printer station by using the information that you saved about the bitmap and how to print it when you called the SetBitmap or SetCustomAlignedBitmap method.

The number that you assigned to the bitmap that you want to print when you called SetBitmap or SetCustomAlignedBitmap.

Sets the rotation of the barcode on the page on the slip printer station.

The rotation of the barcode on the page on the slip printer station.

Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the slip printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job. Information about the bitmap that you want to print. The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property. The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Sets the area of the page on which the slip printer station can print the job.

The area of the page on which the slip printer station can print the job.

Sets the rotation of the text or image on the page on the slip printer station.

The rotation of the text or image on the page. Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to PrintBitmap, and may not apply to saved bitmaps that you print using PrintSavedBitmap.

Provides error information.

Creates an instance for UnifiedPosErrorData.

The error message. The error severity. The cause of the error. The vendor specific error information.

Gets the vendor specific error information.

The vendor specific error information.

Gets the error message.

The error message.

Gets the cause of the error.

The cause of the error.

Gets the error severity.

The error severity.

Defines the constants that indicates the reason for the error event.

The device is busy.

The device is closed.

The device is not enabled.

The operation failed and returned a vendor specific error information.

The operation failed although the device was connected and powered on.

The operation is not supported or not available on the device.

The device is not connected or not powered on.

Cannot communicate with the device, possibly due to a configuration error.

The device is offline.

The operation timed out while waiting for a response from the device.

Unknown reason.

Defines the constants that indicates the error severity.

Requires assistance.

A fatal error.

A recoverable error.

An unknown error severity.

An unrecoverable error.

A warning.

Defines the constants that indicates the type of health check that can be performed on the devices.

Perform a more thorough test that may change the device.

Perform a interactive test of the device. The supporting service object will typically display a modal dialog box to present test options and results.

Perform internal tests to that do not physically change the device.

Perform an unspecified test.

Defines the constants that indicates power reporting capabilities of the Point of Service (POS) device.

Can determine and report the three power states (off, offline, and online) of the device.

Can determine and report the two power states (online and off/offline) of the device.

Cannot determine the state of the device, therefore no power reporting is possible.

Represents the request to disable the barcode scanner.

Notifies the client app that the request was processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to disable the barcode scanner.

Gets the BarcodeScannerDisableScannerRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents the request to enable the barcode scanner.

Notifies the client app that the request was processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to enable a barcode scanner.

Gets the BarcodeScannerEnableScannerRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Reads video frames from a camera.

Gets the BarcodeScannerProviderConnection being used by the frame reader.

The connection object.

Event that is raised when a frame is ready to be acquired. This event will not be raised until the frame reader is started by using StartAsync.

Disposes of the frame reader and associated resources, and stops requesting video frames.

Starts reading video frames from the camera.

Asynchronous operation.

Stops reading video frames from the camera.

Asynchronous operation.

Acquires the latest available frame from the camera.

A BarcodeScannerVideoFrame containing data for the latest video frame.

This object is passed as a parameter to the event handlers for the BarcodeScannerFrameReader.FrameArrived event.

Gets a deferral object for this operation.

A Deferral object that your code uses to signal when it has finished processing the activation.

Represents the request to get attributes of a barcode symbology.

Gets the barcode symbology. Possible values are defined in the BarcodeSymbologies class.

The specific barcode symbology.

Notifies the client app that the request was processed successfully.

The attributes of the requested barcode symbology. An asynchronous operation.

Notifies the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to get the attributes of a barcode symbology.

Gets the BarcodeScannerGetSymbologyAttributesRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents the request to hide a video preview window.

Notifies the client app that the request was processed successfully.

An asynchronous operation.

Informs the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to hide a video preview window.

Gets the BarcodeScannerHideVideoPreviewRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents a connection to a barcode scanner provider client.

Gets or sets the company name of the barcode scanner provider.

The company name.

Gets the ID of the barcode scanner provider connection.

The connection ID.

Gets or sets the name of the barcode scanner provider.

The provider name.

Gets the supported symbologies of the barcode scanner provider.

The supported symbologies.

Gets or sets the version of the barcode scanner provider.

The provider version.

Gets the video device ID that represents the camera lens associated with the barcode scanner.

The video device ID.

Raised when the client app attempts to disable the barcode scanner.

Raised when the client app attempts to enable the barcode scanner.

Raised when the client app attempts to get the attributes of a barcode symbology.

Raised when the client app attempts to hide a video preview window.

Raised when the client app attempts to set the barcode symbologies for the device to use.

Raised when the client app attempts to set the attributes of a barcode symbology.

Raised when the client app attempts to signal the barcode scanner to start scanning.

Raised when the client app attempts to signal the barcode scanner to stop scanning.

Closes the barcode scanner provider connection session.

Creates a new BarcodeScannerFrameReader instance.

A new **BarcodeScannerFrameReader** instance that reads frames from this **BarcodeScannerProviderConnection**.

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format when possible.

The preferred image format as a BitmapPixelFormat. A new **BarcodeScannerFrameReader** instance that reads frames from this **BarcodeScannerProviderConnection**.

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format and size when possible.

The preferred image format as a BitmapPixelFormat. The preferred frame size as a BitmapSize in pixels. A new **BarcodeScannerFrameReader** instance that reads frames from this **BarcodeScannerProviderConnection**.

Sends an error report to the client app.

The error information. An asynchronous operation.

Sends an error report to the client app.

The error information. Indicates whether the operation can be retried. The scan data that was successfully read.

Sends a barcode scanner data report to the client app.

The barcode scanner data. An asynchronous operation.

Sends a barcode scanner trigger state update to the client app during a scanning operation.

The barcode scanner trigger state. Possible values are defined in BarcodeScannerTriggerState. An asynchronous operation.

Starts the connection for data transfer.

Represents trigger information about the barcode scanner background task, where data will be transferred between the app and its caller.

Gets the connection object used to provide barcode scanning to a client app.

The connection used by the provider to communicate with a client app.

Represents the request to set the barcode symbologies for the device to use.

Gets the barcode symbologies for the device to use.

The specific symbologies to use.

Notifies the client app that the request was processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to set the barcode symbologies for the device to use.

Gets the BarcodeScannerSetActiveSymbologiesRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents the request to set the attributes of a barcode symbology.

Gets the attributes of a barcode symbology.

The attributes of a barcode symbology.

Gets the barcode symbology whose attributes are to be set.

The barcode symbology.

Notifies the client app that the request was processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to set the attributes of a barcode symbology.

Gets the BarcodeScannerSetSymbologyAttributesRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents the request to signal a barcode scanner to start scanning.

Notifies the client app that the request was processed successfully.

An asynchronous object.

Notifies the client that the request was not processed successfully.

An asynchronous object.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to signal a barcode scanner to start scanning.

Gets the BarcodeScannerStartSoftwareTriggerRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Represents the request to signal a barcode scanner to stop scanning.

Notifies the client app that the request was processed successfully.

An asynchronous object.

Notifies the client that the request was not processed successfully.

An asynchronous object.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: An asynchronous operation.

Notifies the client that the request was not processed successfully.

An **Int32** error code that will be converted to an HRESULT and raised as an exception in the calling application. The following values are supported: A description of what caused the failure, for use in debugging. An asynchronous operation.

Contains information about a request to stop software trigger.

Gets the BarcodeScannerStopSoftwareTriggerRequest object associated with this request.

The object that describes the request.

Gets a deferral object for this operation.

The deferral object.

Defines the constants that indicate the barcode trigger state.

The barcode scanner trigger or button is pressed during a scanning operation.

The barcode scanner trigger or button is released during a scanning operation.

Represents data from a video frame that was acquired by using a BarcodeScannerFrameReader.

Gets the format of the video frame.

The format of the video frame as a BitmapPixelFormat object.

Gets the height of the video frame.

The height of the video frame in pixels.

Gets the pixel data of the video frame.

The pixel data as an IBuffer.

Gets the width of the video frame.

The width of the video frame in pixels.

Disposes of the video frame and associated resources.

Represents the builder of barcode symbology attributes.

Creates an instance for BarcodeSymbologyAttributesBuilder.

Gets or sets whether the barcode symbology supports transmitting the check digit to the client as part of the raw data.

True if the barcode symbology supports transmitting the check digit as raw data; otherwise, false.

Gets or sets whether the barcode symbology supports check digit validation.

True if the barcode symbology supports check digit validation; otherwise, false.

Gets or sets whether the barcode symbology supports multiple decode lengths.

True if the barcode symbology supports multiple decode lengths; otherwise, false.

Creates a BarcodeSymbologyAttributes object from the properties of this class.

The symbology attributes.

Provides information about a battery controller that is currently connected to the device. For more info, see [Get battery information](https://docs.microsoft.com/previous-versions/windows/apps/dn895210(v=win.10)).

Gets a Battery object that represents all battery controllers connected to the device.

A Battery object that represents overall battery power.

Gets the identifier (ID) for an individual battery controller.

The battery controller identifier (ID).

<!--***in what increments does this change? Can it return a battery aggregate?***-->

Gets a Battery object that represents an individual battery controller connected to the device.

The device ID of the battery controller (DeviceId ). A Battery object that corresponds to the specified battery controller.

Gets an Advanced Query Syntax (AQS) string that can be used to find all battery controllers that are connected to the device.

An AQS string that can be used to find all battery controllers connected to the device.

Gets a BatteryReport object that indicates the charge, capacity, and status of the battery or aggregate.

Indicates the charge, capacity, and status of the battery or aggregate.

Provides properties that indicate the charge, capacity, and status of the battery. For more info, see [Get battery information](https://docs.microsoft.com/previous-versions/windows/apps/dn895210(v=win.10)).

Gets the rate that the battery is charging.

The rate that the battery is charging in milliwatts (mW). This value is negative when the battery is discharging.

Gets the estimated energy capacity of a new battery of this type.

The estimated energy capacity of a new battery of this type, in milliwatt-hours (mWh).

Gets the fully-charged energy capacity of the battery.

The fully-charged energy capacity of the battery, in milliwatt-hours (mWh).

Gets the remaining power capacity of the battery.

The remaining power capacity of the battery, in milliwatt-hours.

Gets a BatteryStatus enumeration that indicates the status of the battery.

A BatteryStatus enumeration that indicates the status of the battery.

Represents a customized printing experience for a 3D printer.

Gets the device identifier of the 3D printer.

The device identifier of the 3D printer.

Gets or sets a value that indicates the 3D object is ready for printing and no further user interaction is required.

**true** if the 3D object is ready for printing; otherwise, **false**.

Occurs when the user changes the designated 3D printer.

Occurs when the user initiates printing.

Gets the model of the 3D object to be printed.

The model of the 3D object to be printed.

Specifies the types of errors that may be encountered by the Print3DWorkflow class.

An invalid printing material has been selected.

The 3D model is not valid.

The print ticket is not valid.

The 3D model exceeds the print bed.

The 3D model does not have manifold edges.

No known error has been encountered.

The upload failed.

Provides data about the printer change to the app that initiated the change.

Gets the device identifier of the new 3D printer.

Device identifier of the new 3D printer.

Provides data about the print request to the app that initiated the request.

Gets the status of the print request.

The status of the print request.

Sets the extended status of the print request.

The extended status of the print request.

Sets the latest model data, including any updates made by the Print3DWorkflow.

The latest model data, including any updates made by the Print3DWorkflow.

Indicates if the data model has been updated by the Print3DWorkflow.

Returns **true** if the data model has been updated; otherwise, **false**.

Specifies the status of the Print3DWorkflow class.

The printing experience has been abandoned.

The printing experience has been canceled.

The print request failed.

The object is undergoing slicing in preparation for printing.

The print request has been submitted.

Represents a radio device on the system.

Gets an enumeration value that describes what kind of radio this object represents.

The kind of this radio.

Gets the name of the radio represented by this object.

The radio name.

Gets the current state of the radio represented by this object.

The current radio state.

Event raised by a state change in the radio represented by this object. When a USB Bluetooth radio is removed or otherwise goes offline, no state change is reported.

A static method that retrieves a Radio object. The method accepts the 'Device.Id' found through Windows.Devices.Enumeration.DeviceInformation.FindAllAsync. This procedure is more reliable than using GetRadiosAsync to obtain a radio in situations where a USB Radio has failed or been removed on a Windows 10 workstation. In this instance of a failed or removed radio, GetRadiosAsync returns no bluetooth radio.

A string that identifies a particular radio device. An asynchronous retrieval operation. On successful completion, it contains a Radio object that represents the specified radio device. Otherwise it throws an exception.

A static method that returns an Advanced Query Syntax (AQS) string to be used to enumerate or monitor Radio devices with Windows.Devices.Enumeration.DeviceInformation.FindAllAsync and related methods.

An identifier to be used to enumerate radio devices.

A static, asynchronous method that retrieves a collection of Windows.Devices.Radios.Radio objects representing radio devices which existed on the system at the time the program launched. Additions or removals of radios are ignored by subsequent calls.

An asynchronous retrieval operation. When the operation is complete, contains a list of Windows.Devices.Radios.Radio objects describing radios that existed at the time the program launched.

An asynchronous method that retrieves a value indicating what access the current user has to the radio represented by this object. In circumstances where user permission is required to access the radio, this method prompts the user for permission. Consequently, always call this method on the UI thread.

An asynchronous status retrieval operation. On successful completion, contains an enumeration value describing the current user's access to this radio.

An asynchronous operation that attempts to set the state of the radio represented by this object.

The desired radio state. An asynchronous state setting operation. On successful completion, contains an enumeration value describing status of the state change request.

Enumeration that describes possible access states that a user can have to a given radio.

Access is allowed.

Access was denied by the system. One common reason for this result is that the user does not have suitable permission to manipulate the radio in question.

Access was denied because of user action, usually through denying an operation through the radio privacy settings page.

Access state is unspecified.

Enumeration that represents the kinds of radio devices.

A Bluetooth radio.

An FM radio.

A mobile broadband radio.

An unspecified kind of radio device.

A Wi-Fi radio.

Enumeration that describes possible radio states.

The radio is powered off and disabled by the device firmware or a hardware switch on the device.

The radio is powered off.

The radio is powered on.

The radio state is unknown, or the radio is in a bad or uncontrollable state.

Represents an accelerometer sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the accelerometer.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets the type of accelerometer sensor the is represented by this object.

The type of accelerometer.

Gets or sets the current report interval for the accelerometer.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the AccelerometerDataThreshold for the accelerometer sensor.

Occurs each time the accelerometer reports a new sensor reading.

Occurs when the accelerometer detects that the PC has been shaken.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Accelerometer object from its identifier.

Gets the current accelerometer reading.

This method has no parameters.

Returns the default accelerometer.

The default accelerometer or null if no integrated accelerometers are found.

Returns the default accelerometer of a specific type of sensor. The possible accelerometer sensors are defined by AccelerometerReadingType.

Indicates the type of accelerometer to retrieve. The default accelerometer or **null** if no integrated accelerometers are found.

Gets the device selector.

The type of sensor to retrieve. Returns the device selector, if it exists; otherwise, null.

Provides access to accelerometer data thresholds (also known as change sensitivity).

Gets or sets the minimum amount of acceleration increase or decrease along the x-axis required to reach the threshold, measured in in g-force.

The accelerometer data threshold for the x-axis, in g-force.

Gets or sets the minimum amount of acceleration increase or decrease along the y-axis required to reach the threshold, measured in in g-force.

The accelerometer data threshold for the y-axis, in g-force.

Gets or sets the minimum amount of acceleration increase or decrease along the z-axis required to reach the threshold, measured in in g-force.

The accelerometer data threshold for the z-axis, in g-force.

Represents an accelerometer reading.

Gets the g-force acceleration along the x-axis.

The x-axis acceleration in g's.

Gets the g-force acceleration along the y-axis.

The y-axis acceleration in g's.

Gets the g-force acceleration along the z-axis.

The g-force acceleration along the z-axis.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time at which the sensor reported the reading.

The instant in time when the sensor reported the reading.

Provides data for the accelerometer reading– changed event.

Gets the most recent accelerometer reading.

The most recent accelerometer reading.

Indicates the type of accelerometer.

A gravity accelerometer is only interested in the influence of gravity on a sensor.

A linear accelerometer does not take into account the influence of gravity.

A standard accelerometer takes into account all of the forces impacting the sensor.

Provides data for the accelerometer-shaken event.

Gets the time at which the sensor reported the shaken event.

The time at which the sensor reported the event.

Represents an activity sensor that provides the activity and status of a sensor.

Gets the device identifier.

The device identifier.

Gets the minimum report interval supported by the sensor.

The minimum report interval supported by the sensor.

Gets the power in milliwatts that the sensor consumes.

The power in milliwatts that the sensor consumes.

Gets the list of activity types that the sensor pledges to perform.

The list of ActivityType -typed values for the activity types that the sensor pledges to perform.

Gets the list of activity types that the sensor supports.

The list of ActivityType -typed values for the activity types that the sensor supports.

Occurs each time the sensor reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the ActivitySensor object from its identifier.

Asynchronously gets the current sensor reading.

Asynchronously returns a ActivitySensorReading object that represents info about the sensor.

Asynchronously obtains the default sensor.

Asynchronously returns a ActivitySensor object that represents the default sensor.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

Asynchronously gets sensor readings from a specific time.

The time at which to get sensor readings. Asynchronously returns a list of ActivitySensorReading objects that represent info about the sensor.

Asynchronously gets sensor readings from a specific time and duration.

The time at which to get sensor readings. The time span during which to get sensor readings. Asynchronously returns a list of ActivitySensorReading objects that represent info about the sensor.

Represents the reading of an activity sensor that provides readings for the sensor.

Gets the activity type for the sensor.

A ActivityType -typed value that specifies the current activity for the sensor.

Gets the reading confidence for the sensor.

A ActivitySensorReadingConfidence -typed value that specifies the reading confidence for the sensor.

Gets the time at which the sensor reported the reading.

The instant in time when the sensor reported the reading.

Represents data for the reading–changed event of the sensor.

Gets the most recent sensor reading.

The most recent sensor reading.

Represents data for the sensor trigger.

Gets the reading of the sensor when it's triggered.

The reading of the sensor when it's triggered.

Specifies the confidence of a sensor reading.

There is high confidence in the reading of the sensor.

There is low confidence in the reading of the sensor.

Represents details about the sensor triggering.

Reads reports about the sensor triggering.

Returns a list of ActivitySensorReadingChangeReport objects that provides data for the sensor trigger.

Specifies activity types of a sensor.

The sensor indicates the user is riding a bicycle on the ground.

The sensor indicates that it making minor movements while the user is stationary.

The sensor indicates it is active but in an idle state. It is not with the user and remaining still such as resting on a table.

The sensor indicates the user is traveling in a motor vehicle on the ground.

The sensor indicates the user is traveling at a faster rate than walking and both feet are off the ground between steps.

The sensor indicates that it's not moving.

The sensor indicates an unknown activity.

The sensor indicates the user is walking. The user travels at a moderate pace with one foot on the ground at all times.

Provides an interface for an altimetric sensor to measure the relative altitude.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

The smallest report interval that is supported by this altimeter sensor.

The smallest ReportInterval supported by the sensor.

Gets or sets the current report interval for the altimeter.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Occurs each time the altimeter sensor reports a new value.

Gets the current reading for the altimeter.

The current alititude reading for this sensor.

Returns the default altimeter sensor.

The default altimeter.

Represents an altimeter reading.

Gets the current altitude determined by the altimeter sensor.

The altitude in meters.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time for the most recent altimeter reading.

The time when the altimeter sensor reported the reading.

Provides data for the altimeter reading– changed event.

Gets the most recent barometer reading.

The most recent altimeter reading.

Provides an interface for a barometric sensor to measure atmospheric pressure.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

The smallest report interval that is supported by this barometer sensor.

The smallest ReportInterval supported by the sensor.

Gets or sets the current report interval for the barometer.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets BarometerDataThreshold for the barometric pressure sensor.

Occurs each time the barometer sensor reports a new value.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Barometer object from its identifier.

Gets the current reading for the barometer.

The current atmospheric pressure according to this sensor.

Returns the default barometer sensor.

The default barometer.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

Provides access to barometer data thresholds (also known as change sensitivity).

Gets or sets the minimum amount of barometric pressure increase or decrease required to reach the threshold, measured in in hectopascals.

The barometric pressure data threshold, in hectopascals.

Represents a barometer reading.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the barometric pressure determined by the barometer sensor.

The pressure in hectopascals (hPA).

Gets the time for the most recent barometer reading.

The time when the barometer sensor reported the reading.

Provides data for the barometer reading– changed event.

Gets the most recent barometer reading.

The most recent barometer reading.

Represents a compass sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the compass.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets or sets the current report interval for the compass.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the CompassDataThreshold for the compass sensor.

Occurs each time the compass reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Compass object from its identifier.

Gets the current compass reading.

The current compass reading.

Returns the default compass.

The default compass or null if no integrated compasses are found.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

Provides access to compass data thresholds (also known as change sensitivity).

Gets or sets the minimum amount of directional change required to reach the threshold, measured in degrees.

The compass data threshold, in degrees.

Represents a compass reading.

Gets the compass's heading accuracy.

The compass's heading accuracy.

Gets the heading in degrees relative to magnetic-north.

The magnetic-north heading.

Gets the heading in degrees relative to geographic true-north.

The true-north heading.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Provides data for the compass reading–changed event.

Gets the current compass reading.

The current compass reading.

Represents a gyrometer sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the gyrometer.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets or sets the current report interval for the gyrometer.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the GyrometerDataThreshold for the gyrometer sensor.

Occurs each time the gyrometer reports the current sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Gyrometer object from its identifier.

Gets the current gyrometer reading.

This method has no parameters.

Returns the default gyrometer.

The default gyrometer or null if no integrated gyrometers are found.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

Provides access to gyrometer data thresholds (also known as change sensitivity).

Gets or sets the minimum change of angular velocity around the x-axis required to reach the threshold, measured in degrees per second.

The gyrometer data threshold for the x-axis, in degrees per second.

Gets or sets the minimum change of angular velocity around the y-axis required to reach the threshold, measured in degrees per second.

The gyrometer data threshold for the y-axis, in degrees per second.

Gets or sets the minimum change of angular velocity around the x-axis required to reach the threshold, measured in degrees per second.

The gyrometer data threshold for the x-axis, in degrees per second.

Represents a gyrometer reading.

Gets the angular velocity, in degrees per second, about the x-axis.

The angular velocity, in degrees per second, about the x-axis.

Gets the angular velocity, in degrees per second, about the y-axis.

The angular velocity, in degrees per second, about the y-axis.

Gets the angular velocity, in degrees per second, about the z-axis.

The angular velocity, in degrees per second, about the z-axis.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Provides data for the gyrometer reading– changed event.

Gets the current gyrometer reading.

The current gyrometer reading.

Provides access to the data exposed by the hinge angle sensor in a dual-screen device.

Gets the angle reported by the hinge angle sensor.

The angle reported by the HingeAngleSensor.

Gets a collection of key-value pairs that represent data properties reported by the sensor for the given reading.

A collection of key-value pairs that represent data properties reported by the sensor for the given reading.

Gets the time when the hinge angle reading was obtained.

The time when the HingeAngleSensor reading was obtained.

Represents the hinge angle sensor in a dual-screen device.

Gets the device identifier.

The device identifier.

Gets the minimum reporting threshold for the hinge angle sensor, measured in degrees.

The minimum reporting threshold for the hinge angle sensor, in degrees.

Gets the reporting threshold for the hinge angle sensor, measured in degrees.

The reporting threshold for the hinge angle sensor, in degrees.

Occurs when the hinge angle sensor in a dual-screen device reports a change in opening angle.

Obtains the hinge angle sensor from the identifier.

The sensor identifier. The HingeAngleSensor object from its identifier.

Asynchronously retrieves the current data from the hinge angle sensor.

When this method completes, it returns a reference to the HingeAngleReading.

Asynchronously retrieves the default hinge angle sensor.

When this method completes, it returns a reference to the default HingeAngleSensor.

Gets an Advanced Query Syntax (AQS) string for identifying instances of the display panels in a hinged dual-screen device. This string is passed to the HingeAngleSensor.GetRelatedToAdjacentPanelsAsync method.

Returns the HingeAngleSensor device selector, if it exists; otherwise, null.

Asynchronously retrieves a hinge angle sensor for two adjacent display panels.

The device Id of one of the hinged panels. The device Id of the other hinged panel. When this method completes, it returns a reference to a HingeAngleSensor.

Provides data for the ReadingChanged event.

Gets the data exposed by the hinge angle sensor in a dual-screen device.

The data provided by the HingeAngleSensor.

Represents an inclinometer sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the inclinometer.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets the sensor reading type.

A SensorReadingType -typed value that specifies the sensor reading type.

Gets or sets the current report interval for the inclinometer.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the InclinometerDataThreshold for the gyrometer sensor.

Occurs each time the inclinometer reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Inclinometer object from its identifier.

Gets the current inclinometer reading.

The current inclinometer reading.

Returns the default inclinometer for absolute readings.

The default inclinometer or null if no inclinometers are found.

Returns the default inclinometer based on the SensorReadingType.

The type of sensor to retrieve. The default inclinometer or **null** if no inclinometers are found.

Returns the default inclinometer for relative readings.

The default inclinometer or null if no inclinometers are found.

Gets the device selector.

The type of sensor to retrieve. Returns the device selector, if it exists; otherwise, null.

Provides access to inclinometer data thresholds (also known as change sensitivity).

Gets or sets the minimum change in rotation around the pitch-axis (transverse axis) required to reach the threshold, measured in degrees.

The inclinometer data threshold for the pitch-axis, in degrees.

Gets or sets the minimum change in rotation around the roll-axis (longitudinal axis) required to reach the threshold, measured in degrees.

The inclinometer data threshold for the roll-axis, in degrees.

Gets or sets the minimum change of rotation around the yaw-axis (vertical axis) required to reach the threshold, measured in degrees.

The inclinometer data threshold for the yaw-axis, in degrees.

Represents an inclinometer reading.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the rotation in degrees around the x-axis.

The rotation in degrees around the x-axis.

Gets a collection of key-value pairs that represent data properties reported by the sensor for the given reading.

A collection of key-value pairs that represent data properties reported by the sensor for the given reading.

Gets the rotation in degrees around the y-axis.

The rotation in degrees around the y-axis.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Gets the inclinometer's z-axis accuracy.

The inclinometer's z-axis accuracy.

Gets the rotation in degrees around the z-axis.

The rotation in degrees around the z-axis.

Provides data for the inclinometer reading– changed event.

Gets the current inclinometer reading.

The current inclinometer reading.

Identifies a threshold for sensor data. When this threshold is crossed, the sensor trigger will activate.

Represents an ambient-light sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the sensor.

The minimum ReportInterval supported by the sensor.

Gets or sets the current report interval for the ambient light sensor.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the LightSensorDataThreshold for the light sensor.

Occurs each time the ambient-light sensor reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the LightSensor object from its identifier.

Gets the current ambient-light sensor reading.

The current ambient-light sensor reading.

Returns the default ambient-light sensor.

The default ambient-light sensor or null if no integrated light sensors are found.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

Provides access to light data thresholds (also known as change sensitivity).

Gets or sets the minimum change in light (lux) required to reach the threshold, measured in absolute units of lux.

The light data threshold, in absolute units of lux.

Gets or sets the minimum change in light (lux) required to reach the threshold, measured in percent.

The light data threshold, in percent.

Represents an ambient light–sensor reading.

Gets the illuminance level in lux.

The illuminance level in lux.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Provides data for the ambient-light sensor reading-changed event.

Gets the current ambient light-sensor reading.

The current ambient light-sensor reading.

Represents a magnetic sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the magnetometer.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets or sets the current report interval for the magnetometer.

The current report interval.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Gets the MagnetometerDataThreshold for the magnetometer sensor.

Occurs each time the compass reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the Magnetometer object from its identifier.

Gets the current magnetometer reading.

The current magnetometer reading.

Returns the default magnetometer.

The default magnetometer.

Gets the device selector.

Returns the device selector, if it exists; otherwise, null.

The sensor's accuracy.

The actual and reported values differ but may be accurate enough for some application.

The actual and reported values are accurate.

The accuracy is currently not available, typically because the driver can't report it.

The actual and reported values have a high degree of inaccuracy.

Provides access to magnetometer data thresholds (also known as change sensitivity).

Gets or sets the minimum change of geomagnetic data around the x-axis required to reach the threshold, measured in microteslas.

The magnetometer data threshold for the x-axis, in microteslas.

Gets or sets the minimum change of geomagnetic data around the y-axis required to reach the threshold, measured in microteslas.

The magnetometer data threshold for the y-axis, in microteslas.

Represents a magnetometer reading.

Gets the magnetometer's directional accuracy.

The magnetometer's directional accuracy.

Gets the magnetic field strength in microteslas along the X axis.

The magnetic field strength in microteslas along the X axis.

Gets the magnetic field strength in microteslas along the Y axis.

The magnetic field strength in microteslas along the Y axis.

Gets the magnetic field strength in microteslas along the Z axis.

The magnetic field strength in microteslas along the Z axis.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Provides data for the magnetometer reading– changed event.

Gets the current magnetometer reading.

The current magnetometer reading.

Represents an orientation sensor.

Gets the device identifier.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval supported by the sensor.

The minimum ReportInterval supported by the sensor.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Gets the sensor reading type.

A SensorReadingType -typed value that specifies the sensor reading type.

Gets or sets the report interval supported by the sensor.

The report interval supported by the sensor.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Occurs each time the orientation sensor reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier Returns the OrientationSensor object from its identifier.

Gets the current sensor reading.

The current sensor reading.

Returns the default orientation sensor for absolute readings.

The default orientation sensor or **null** if no orientation sensors are found.

Returns the default orientation sensor, taking into account accuracy preferences.

The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated.” The default orientation sensor or **null** if no orientation sensors are found.

Returns the default orientation sensor, taking into account power and accuracy preferences.

The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated. Indicates the preferences of optimization for the sensor. This field is only used if an Absolute SensorReadingType is specified. An optimizationGoal of Precision will return an OrientationSensor using an accelereometer, a gyrometer, and a magnetometer to determine orientation with respect to magnetic North. This has the potential to use a lot of power due to it’s use of a gyrometer. The default orientation sensor or **null** if no orientation sensors are found.

Returns the default orientation sensor for relative readings.

The default orientation sensor or null if no orientation sensors are found.

Gets the device selector.

The type of sensor to retrieve. Returns the device selector, if it exists; otherwise, null.

Gets the device selector.

The type of sensor to retrieve. An Absolute SensorReadingType returns an OrientationSensor using an accelerometer, a gyromoter, and magnetometer to determine the orientation with respect to magnetic North. A Relative SensorReadingType returns an OrientationSensor using an accelerometer and gyrometer only (no magnetometer), measuring relative to where the sensor was first instantiated. Indicates the preferences of optimization for the sensor. This field is only used if an Absolute SensorReadingType is specified. An optimizationGoal of Precision will return an OrientationSensor using an accelereometer, a gyrometer, and a magnetometer to determine orientation with respect to magnetic North. This has the potential to use a lot of power due to it’s use of a gyrometer. Returns the device selector, if it exists; otherwise, null.

Represents an orientation-sensor reading.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the data properties reported by the sensor.

Contains a key/value pair for each data property reported by the sensor for the given reading. The key is a string of the property key, and the value is the value of the property that the key represents.

Gets the Quaternion for the current orientation-sensor reading.

The Quaternion for the current orientation-sensor reading.

Gets the rotation matrix for the current orientation-sensor reading.

The rotation matrix for the current orientation-sensor reading.

Gets the time at which the sensor reported the reading.

The time at which the sensor reported the reading.

Gets the orientation sensor's z-axis accuracy.

The orientation sensor's z-axis accuracy.

Provides data for the orientation-sensor reading-changed event.

Gets the current reading which includes a Quaternion, a RotationMatrix, and a timestamp.

The current reading which includes a Quaternion, a RotationMatrix, and a timestamp.

Provides an interface for a pedometer to measure the number of steps taken.

Gets the device identifier.

The device identifier.

The smallest report interval that is supported by this pedometer.

The smallest ReportInterval supported by the sensor.

Gets the power that the sensor consumes.

The amount of power consumed in milliwatts.

Gets or sets the current report interval for the pedometer.

The current report interval.

Occurs each time the pedometer reports a new value.

Obtains the pedometer from its identifier.

The sensor identifier. Returns the Pedometer object from its identifier.

Gets the current step information from the pedometer sensor.

A collection of the step information available from the sensor.

Asynchronously obtains the default pedometer.

Asynchronously returns a Pedometer object that represents the default sensor.

Gets the device selector.

Returns the device selector, if it exists; otherwise null.

Gets readings from the trigger details in background task.

The trigger details received from the background task. The collection of pedometer data retrieved from the trigger details.

Asynchronously gets sensor readings from a specific time.

The time for which you want to retrieve the reading. Asynchronously returns a list of PedometerReading objects that represent info about the sensor.

Asynchronously gets pedometer readings from a specific time and duration.

The time for which you want to retrieve the reading. The duration over which you want to retrieve data. Asynchronously returns a list of PedometerReading objects that represent info about the sensor.

A threshold for the Pedometer sensor. When the threshold conditions are met, the sensor trigger will activate.

Creates a PedometerDataThreshold object.

The pedometer sensor. The number of steps before the threshold is exceeded and the background task is activated.

Represents a pedometer reading.

Gets the total number of steps taken for this pedometer reading.

The total number of steps taken.

Gets the amount of time that has elapsed for this pedometer reading.

The amount of elapsed time for the current reading of cumulative steps. This value is given in milliseconds.

Indicates the type of steps taken for this pedometer reading.

The type of step taken.

Gets the time for the most recent pedometer reading.

The time when the pedometer reported the reading.

Provides data for the pedometer reading– changed event.

Gets the most recent pedometer reading.

The most recent pedometer reading.

The type of step taken according to the pedometer.

A running step.

An unknown step type.

A walking step.

Provides an interface for a proximity sensor to determine whether or not an object is detected.

Gets the device identifier.

The device identifier.

The largest distance where the proximity sensor can detect an object.

The maximum distance in millimeters where the proximity sensor supports detecting an object.

The shortest distance where the proximity sensor can detect an object.

The minimum distance in millimeters where the proximity sensor supports detecting an object.

Occurs each time the proximity sensor reports a new value.

Creates a controller responsible for turning the display on or off based on the ProximitySensorReading.

The controller for the phone display.

Obtains the proximity sensor from its identifier.

The sensor identifier. Returns the ProximitySensor object from its identifier.

Gets the current reading for the proximity sensor.

Indicates whether or not the proximity sensor detects an object, and if so, the distance to that object.

Gets the device selector.

Returns the device selector. If no device selector is available, this method returns null.

Gets readings from the trigger details in background task.

The trigger details received from the background task. The collection of proximity data retrieved from the trigger details.

A threshold for the ProximitySensor. When the threshold conditions are met, the sensor trigger will activate.

Creates a ProximitySensorDataThreshold object.

The proximity sensor.

Provides a controller responsible for turning on or off the phone display based on the readings from the ProximitySensor.

Disconnects this ProximitySensorDisplayOnOffController instance from the service and frees all the allocated resources.

Represents a reading from the proximity sensor.

Gets the distance from the proximity sensor to the detected object.

The distance between the sensor and the object in millimeters.

Gets whether or not an object is detected by the proximity sensor.

True if an object is detected by the proximity sensor; otherwise false.

Gets the time for the most recent proximity sensor reading.

The time when the proximity sensor reported the reading.

Provides data for the reading– changed event of the proximity sensor.

Gets or sets the most recent proximity sensor reading.

The most recent proximity sensor reading.

Provides data for what sensor triggered the data threshold monitoring task.

Gets the device identifier for the device that activated the threshold trigger.

The device identifier of the sensor.

Gets the type of sensor associated with the threshold trigger.

The type of sensor.

Indicates whether power or precision should be optimized for sensors.

This sensor will prioritize power efficiency over precision depending on the hardware available.

This sensor will prioritize precision over power efficiency.

Represents a Quaternion.

Gets the w-value of the Quaternion.

The w-value of the Quaternion.

Gets the x-value of the Quaternion.

The x-value of the Quaternion.

Gets the y-value of the Quaternion.

The y-value of the Quaternion.

Gets the z-value of the Quaternion.

The z-value of the Quaternion.

Specifies the sensor reading type.

The sensor reading type is absolute. **Absolute** sensors provide a reading that uses all of the sensors available.

The sensor reading type is relative. **Relative** sensors provide a reading that is accurate under most conditions, but might not be as accurate as it attempts to not use all sensors available. See the Remarks for more information.

Represents a 3x3 rotation matrix.

Gets the value at row 1, column 1 of the given rotation matrix.

The value at row 1, column 1 of the given rotation matrix.

Gets the value at row 1, column 2 of the given rotation matrix.

The value at row 1, column 2 of the given rotation matrix.

Gets the value at row 1, column 3 of the given rotation matrix.

The value at row 1, column 3 of the given rotation matrix.

Gets the value at row 2, column 1 of the given rotation matrix.

The value at row 2, column 1 of the given rotation matrix.

Gets the value at row 2, column 2 of the given rotation matrix.

The value at row 2, column 2 of the given rotation matrix.

Gets the value at row 2, column 3 of the given rotation matrix.

The value at row 2, column 3 of the given rotation matrix.

Gets the value at row 3, column 1 of the given rotation matrix.

The value at row 3, column 1 of the given rotation matrix.

Gets the value at row 3, column 2 of the given rotation matrix.

The value at row 3, column 2 of the given rotation matrix.

Gets the value at row 3, column 3 of the given rotation matrix.

The value at row 3, column 3 of the given rotation matrix.

Indicates the type of sensor.

An Accelerometer.

An ActivitySensor.

A Barometer.

A Compass.

A custom sensor.

A Gyrometer.

An Inclinometer.

A LightSensor.

An OrientationSensor.

A Pedometer.

A ProximitySensor.

A relative Inclinometer.

A relative OrientationSensor.

A SimpleOrientationSensor.

Indicates the orientation of the device.

The device is face-down and the display is hidden from the user.

The device is face-up and the display is visible to the user.

The device is not rotated.

The device is rotated 180-degrees counter-clockwise.

The device is rotated 270-degrees counter-clockwise.

The device is rotated 90-degrees counter-clockwise.

Represents a simple orientation sensor.

Gets the device identifier used in the SimpleOrientationSensor.FromIdAsync method.

The device identifier.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

A DisplayOrientations -typed value that specifies the display orientation with which to align the sensor data.

Occurs each time the simple orientation sensor reports a new sensor reading

Asynchronously retrieves a SimpleOrientationSensor object based on the specified device identifier.

The SimpleOrientationSensor device identifier. After the operation completes, returns the SimpleOrientationSensor instance based on the value of deviceId.

Gets the default simple orientation sensor.

The default simple orientation sensor.

Gets the default simple orientation sensor.

The default simple orientation sensor or null if no simple orientation sensors are found.

Retrieves an Advanced Query Syntax (AQS) string used to enumerate the available SimpleOrientationSensor devices.

The device selector, if it exists; otherwise, null.

Provides data for the sensor reading–changed event.

Gets the current sensor orientation.

The current sensor orientation.

Gets the time of the current sensor reading.

The time of the current sensor reading.

Represents a custom sensor.

Gets the device identifier of the sensor.

The device identifier.

Gets the maximum number of events that can be batched by the sensor.

The maximum number of batched events.

Gets the minimum report interval that is supported by the sensor.

The minimum report interval that is supported by the sensor.

Gets or sets the current report interval for the sensor.

The current report interval for the sensor.

Gets or sets the delay between batches of sensor information.

The delay between batches of sensor information in milliseconds.

Occurs each time the sensor reports a new sensor reading.

Asynchronously obtains the sensor from its identifier.

The sensor identifier. Returns the CustomSensor object from its identifier.

Gets the current sensor reading.

The current sensor reading.

Gets the device selector from the given interface identifier.

The interface Guid that is associated with the custom sensor. This Guid is defined and registered by the sensor. Returns the device selector, if it exists; otherwise, null.

Represents a property set of key/value pairs that contain the custom data sent from the sensor’s driver to the app.

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.

The performance count for the reading. Null if this property is not supported on the sensor.

Gets the property set for the sensor.

The property set for the sensor. This set contains the key/value pair for each property in the set.

Gets the time at which the sensor reported the reading.

The instant in time when the sensor reported the reading.

Represents data for the reading– changed event of the custom sensor.

Gets the most recent sensor reading.

The most recent sensor reading.

Represents the object that is passed as a parameter to the event handler that is invoked when error occurs on the serial port.

Gets the character type received that caused the event on the serial port.

One of the values defined in the SerialError enumeration.

Represents the object that is passed as a parameter to the event handler that is invoked when the state of a signal line changes on the serial port.

Gets the type of signal change that caused the event on the serial port.

One of the values defined in SerialPinChange enumeration.

Represents a serial port. The object provides methods and properties that an app can use to find the port (in the system).

Gets or sets the baud rate.

The baud rate of the serial port.

Gets or sets the break signal state.

Toggles the TX line to enable or disable data transmission.

Represents the number of bytes received by the last read operation of the input stream.

The number of bytes received by the last read operation of the input stream.

Gets the state of the Carrier Detect (CD) line.

Detects the state of Carrier Detect line. If the line is detected, value is **true**; otherwise, **false**.

Gets the state of the Clear-to-Send (CTS) line.

Detects the state of Clear-to-Send line. If the line is detected, value is **true**; otherwise, **false**.

The number of data bits in each character value that is transmitted or received, and does not include parity bits or stop bits.

The number of data bits in each character value that is transmitted or received.

Gets the state of the Data Set Ready (DSR) signal.

Indicates whether DSR has been sent to the serial port. If the signal was sent, value is **true**; otherwise, **false**.

Gets or sets the handshaking protocol for flow control.

One of the values defined in SerialHandshake enumeration.

Input stream that contains the data received on the serial port.

Input stream that contains the data received

Gets or sets a value that enables the Data Terminal Ready (DTR) signal.

Enables or disables the Data Terminal Ready (DTR) signal. **true** enables DTR; Otherwise, **false**.

Gets or sets a value that enables the Request to Send (RTS) signal.

Enables or disables the Request to Send (RTS) signal. **true** enables DTR; Otherwise, **false**.

Gets an output stream to which the app can write data to transmit through the serial port.

The output steam that contains the transfer data.

Gets or sets the parity bit for error-checking.

One of the values defined in SerialParity enumeration.

Gets the port name for serial communications.

The communication port name. For example "COM1".

Gets or sets the time-out value for a read operation.

The span of time before a time-out occurs when a read operation does not finish.

Gets or sets the standard number of stop bits per byte.

One of the values defined in the SerialStopBitCount enumeration.

Gets the **idProduct** field of the USB device descriptor. This value indicates the device-specific product identifier and is assigned by the manufacturer.

The device-defined product identifier.

Gets the **idVendor** field of the USB device descriptor. The value indicates the vendor identifier for the device as assigned by the USB specification committee.

The vendor identifier for the device as assigned by the USB specification committee.

Gets or sets the time-out value for a write operation.

The span of time before a time-out occurs when a write operation does not finish.

Event handler that is invoked when error occurs on the serial port.

Event handler that is invoked when the state of a signal or line changes on the serial port.

Releases the reference to the SerialDevice object that was previously obtained by calling FromIdAsync.

Starts an asynchronous operation that creates a SerialDevice object.

The device instance path of the device. To obtain that value, get the DeviceInformation.Id property value. Returns an IAsyncOperation(SerialDevice) object that returns the results of the operation.

Gets an Advanced Query Syntax (AQS) string that the app can pass to DeviceInformation.FindAllAsync in order to find all serial devices on the system.

String formatted as an AQS query.

Gets an Advanced Query Syntax (AQS) string that the app can pass to DeviceInformation.FindAllAsync in order to find a serial device by specifying its port name.

The serial port name. For example, "COM1". String formatted as an AQS query.

Gets an Advanced Query Syntax (AQS) string that the app can pass to DeviceInformation.FindAllAsync in order to find a specific Serial-to-USB device by specifying it's VID and PID.

Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. String formatted as an AQS query.

Defines values for error conditions that can occur on the serial port.

A character-buffer overrun has occurred. The next character is lost.

The hardware detected a framing error.

An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.

The hardware detected a parity error.

The application tried to transmit a character, but the output buffer was full.

Defines values for hardware and software flow control protocols used in serial communication. The values are used by Handshake property on the SerialDevice object.

No protocol is used for the handshake.

When the port is receiving data and if the read buffer is full, the Request-to-Send (RTS) line is set to **false**. When buffer is available, the line is set to **true**. When the serial port is transmitting data, CTS line is set to **false** and the port does not send data until there is room in the write buffer.

Both **RequestToSend** and **XOnXOff** controls are used for flow control.

The serial port sends an Xoff control to inform the sender to stop sending data. When ready, the port sends an Xon control to inform he sender that the port is now ready to receive data.

Defines values for the parity bit for the serial data transmission. The values are used by the Parity property on the SerialDevice object.

Sets the parity bit so that the total count of data bits set is an even number.

Leaves the parity bit set to 1.

No parity check occurs.

Sets the parity bit so that the total count of data bits set is an odd number.

Leaves the parity bit set to 0.

Defines values for types of signal state changes on the serial port.

Change in the break signal state.

Change in the Carrier Detect line for the port.

Change in the Clear-to-Send line for the port.

Change in the state of the Data Set Ready (DSR) signal.

Change in the ring indicator state.

Defines values that indicate the number of stop bits used in a transmission. The values are used by the StopBits property on the SerialDevice object.

One stop bit is used.

1.5 stop bits are used.

Two stop bits are used.

Provides data for the CardAdded event.

Gets info about the smart card that was inserted into the smart card reader.

Info about the smart card that was inserted.

Provides data for the CardRemoved event.

Gets info about the smart card that was taken out of the smart card reader.

Info about the smart card that was taken out of the smart card reader.

Represents info about a smart card.

Gets info about the smart card reader into which the smart card is inserted.

Info about the smart card reader.

Establishes a connection to the smart card and returns a SmartCardConnection object representing the connection.

Asynchronous operation that, when complete, returns the SmartCardConnection object representing the connection.

Returns the smart card's *Answer to Reset* (ATR), a standard series of bytes that contains info about the smart card's characteristics, behaviors, and state.

The smart card's ATR byte set.

Returns the smart card's status.

One of the SmartCardStatus enumeration values, representing the smart card's status.

Represents a smart card authentication challenge/response operation.

Gets the smart card's challenge value.

The smart card's challenge value.

Changes the smart card's admin key (also known as an *administrator PIN* or *unblock PIN*).

The response to a smart card authentication challenge/response operation. The new smart card admin key. An asynchronous action that completes after the admin key change attempt is done.

Completes the smart card authentication challenge/response operation and frees associated system resources.

Reconfigures an existing, configured smart card with a new response. Optionally, formats the smart card.

The new response to a smart card authentication challenge/response operation. True to format the smart card; otherwise false. An asynchronous action that completes after the smart card reconfiguration attempt is done.

Reconfigures an existing, configured smart card with a new response and ID. Optionally, formats the smart card.

The new response to a smart card authentication challenge/response operation. True to format the smart card; otherwise false. The new smart card ID. An asynchronous action that completes after the smart card reconfiguration attempt is done.

Verifies the response to the smart card challenge request.

The response to the smart card challenge request. After the verification attempt is done, true if the response was successfully verified; otherwise false.

Represents a connection to a smart card.

Completes the smart card authentication challenge/response operation and frees associated system resources.

Asynchronously transmits the supplied application protocol data unit (APDU) command and returns the response.

The application protocol data unit (APDU) command to transmit to the smart card. An asynchronous operation that, when completed, returns the response to the command that was transmitted.

Specifies the rules for characters in a smart card personal identification number (PIN).

Any of the characters in the specified character class can be in the PIN.

None of the characters in the specified character class can be in the PIN.

At least one of the characters in the specified character class must be in the PIN.

Represents a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card.

Creates and initializes a new instance of a set of personal identification number (PIN) rules on a Trusted Platform Module (TPM) virtual smart card.

Gets or sets whether number characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

One of the enumeration values, representing whether number characters are allowed.

Gets or sets whether lowercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

One of the enumeration values, representing whether lowercase letter characters are allowed.

Gets or sets the maximum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

The maximum character length.

Gets or sets the minimum character length for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

The minimum character length.

Gets or sets whether special characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

One of the enumeration values, representing whether special characters are allowed.

Gets or sets whether uppercase letter characters are allowed for a personal identification number (PIN) on a Trusted Platform Module (TPM) virtual smart card.

One of the enumeration values, representing whether uppercase letter characters are allowed.

Represents a wait time for a requested smart card personal identification number (PIN) reset.

Returns a wait time completion for a smart card personal identification number (PIN) reset.

Represents a method that handles a smart card personal identification number (PIN) reset.

An instance of an existing, configured physical smart card or Trusted Platform Module (TPM) virtual smart card. An instance of a smart card PIN reset request.

Represents a smart card personal identification number (PIN) reset request.

Gets the smart card's challenge value.

The smart card's challenge value.

Gets the length of time to wait before requesting the smart card personal identification number (PIN) reset.

The length of time to wait before requesting the smart card PIN reset.

Gets an instance of a wait time for a requested smart card personal identification number (PIN) reset.

An instance of a wait time for a requested smart card PIN reset.

Sets the response to a smart card authentication challenge/response operation.

The response to a smart card authentication challenge/response operation.

Represents info about, and operations for, configuring smart cards.

Gets the configured smart card.

The configured smart card.

Returns a smart card to be configured.

The specified smart card. An instance of SmartCardProvisioning, representing the smart card to be configured.

Asynchronously gets the name of the authority key container.

An async operation that provides access to a string containing the name of the authority key container.

Returns a smart card's authentication challenge/response context.

After the asynchronous operation completes, returns an instance of SmartCardChalllengeContext, representing the smart card's authentication challenge/response context.

Returns the smart card's ID.

After the asynchronous operation completes, returns the smart card's ID.

Returns the smart card's minidriver name.

After the asynchronous operation completes, returns the smart card's name.

Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters.

The smart card's human-readable name. The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). The smart card's PIN rules set. After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Creates an attested Trusted Platform Module (TPM) virtual smart card with the specified parameters.

The smart card's human-readable name. The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). The smart card's PIN rules set. The smart card's ID. After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Changes a smart card's personal identification number (PIN).

After the smart card PIN change attempt completes, returns true if the smart card's PIN was successfully changed; otherwise false.

Resets a smart card's personal identification number (PIN).

The method that handles the smart card PIN reset. After the smart card PIN reset attempt completes, returns true if the smart card's PIN was successfully reset; otherwise false.

Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, and personal identification number (PIN) rules set.

The smart card's human-readable name. The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). The smart card's PIN rules set. After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Creates a Trusted Platform Module (TPM) virtual smart card with a given human-readable name, admin key, personal identification number (PIN) rules set, and ID.

The smart card's human-readable name. The smart card's admin key (also known as an *administrator PIN* or *unblock PIN*). The smart card's PIN rules set. The smart card's ID. After the operation completes, returns an instance of SmartCardProvisioning, representing the configured TPM virtual smart card.

Deletes a Trusted Platform Module (TPM) virtual smart card.

The TPM virtual smart card to delete. After the deletion attempt completes, returns true if the TPM virtual smart card was successfully deleted; otherwise false.

Represents info about a smart card reader.

Gets the smart card reader's device ID.

The smart card reader's device ID.

Gets the smart card reader's type.

One of the enumeration values, representing the smart card reader's type.

Gets the smart card reader's device name.

The smart card reader's device name.

Occurs when a smart card is inserted into the smart card reader or tapped on an NFC reader.

Occurs when a smart card is taken out of the smart card reader.

Returns a list of info about all smart cards that are connected to the smart card reader.

After the operation completes, returns the list of info about all smart cards that are connected to the smart card reader.

Returns a smart card reader that matches the specified device ID.

The smart card reader's device ID. The matching smart card reader.

Returns an Advanced Query Syntax (AQS) string representing all smart card readers connected to the device. This string is passed to the FindAllAsync method to enumerate the given set of smart card readers.

The Advanced Query Syntax (AQS) string representing all smart card readers connected to the device.

Returns an Advanced Query Syntax (AQS) string representing a set of a specific type of smart card readers connected to the device. This string is passed to the FindAllAsync method to enumerate the given set of smart card readers.

One of the enumeration values, representing a specific smart card reader type. The Advanced Query Syntax (AQS) string representing a set of the specified type of smart card readers connected to the device.

Returns the smart card reader's status.

After the status request completes, returns one of the SmartCardReaderStatus enumeration values, representing the smart card reader's status.

Represents the smart card reader's type.

This value is never returned.

An embedded SE smart card reader.

A generic smart card reader.

A near field communication (NFC) smart card reader.

A Trusted Platform Module (TPM) virtual smart card reader.

A Universal Integrated Circuit Card (UICC) smart card reader.

Specifies the smart card reader's status.

The smart card reader is disconnected.

The smart card reader is allocated for exclusive use by another app.

The smart card reader is ready.

Specifies the smart card's status.

The smart card is disconnected.

The smart card is allocated for exclusive use by another app.

The smart card is ready.

The smart card can be used by multiple apps.

The smart card is unresponsive.

This enumerated type defines the type of radio standard in a device.

The device type is CDMA cellular class.

The device type is GSM cellular class.

The device type corresponds to no cellular class.

This interface specifies base functionality for all SMS message types.

Gets the cellular class of the message.

An enumeration value specifying the cellular class of the message.

Gets the unique device identifier associated with this message.

The device identifier, as a string.

Gets the message class of this message.

An enumeration value specifying the SMS message class of this message.

Gets the message type of this message.

An enumeration value specifying the message type of the message.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

The interface for manipulating an SMS Application message. Application messages are those which cannot be characterized as any other message type.

Constructor. Used to create an SmsAppMessage prior to sending it.

Reads or writes the binary part of the Application message.

Binary data part of the Application message.

The plain text body of the message.

The plain text body of the message.

The number to be dialed in reply to a received SMS message.

The number to be dialed in reply to a received SMS message. Available only for 3GPP2 messages.

The class of the cellular device that received the message.

The class of the cellular device that received the message.

The device ID of the device that received the message.

The device ID of the device that received the message.

The encoding used to send the message.

The encoding used to send the message.

The telephone number of the sender of the message.

The telephone number of the sender of the message.

Indicates whether an SMS delivery status report was sent by the SMSC.

For a received message, indicates whether an SMS delivery status report was sent by the SMSC. For a sent message, determines whether an SMS delivery status report is requested.

The message class of the message.

The message class of the message.

The message type of the message.

The message type of the message.

The port number of the message.

The port number of the message.

The Protocol identifier for the message.

The Protocol identifier for the message. (3GPP2 only.)

The retry attempt count for the message.

The retry attempt count for the message. Set the maximum number of retries for outgoing messages, or get the number of retries for a received message.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

The Teleservice identifier for the message.

The Teleservice identifier for the message.

The timestamp of the message.

The timestamp of the message. If the message is constructed locally, then the **Timestamp** value is determined locally. If the message was received from the network, the value is determined by the service center.

The telephone number of the recipient of this message.

The telephone number of the recipient of this message.

Represents a broadcast SMS message.

Gets the body of the broadcast SMS message.

The body of the broadcast SMS message.

Gets the type of this broadcast SMS message.

An enumeration value describing the type of the message.

Gets the cellular class of this broadcast message.

An enumeration value describing the cellular class of the message.

Gets the channel associated with the broadcast SMS message.

The channel for this message.

Gets the device ID of the device that received the broadcast SMS message.

The unique device ID of the device that received the message.

Gets the geographical scope associated with this broadcast SMS message.

An enumeration value describing the geographical scope associated with this message.

True when the broadcast SMS message is an emergency alert.

True when the broadcast SMS message is an emergency alert.

True when a user popup is requested by this broadcast SMS message.

True when a user popup is requested by this broadcast SMS message.

Gets the message class associated with this broadcast SMS message.

Enumeration value describing the message class of this message.

Gets a code value associated with this broadcast SMS message.

The code value associated with this message.

Gets the message type of the broadcast SMS message.

An enumeration value describing the message type.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

Gets the timestamp of the broadcast SMS message.

The timestamp of the message. Timestamp value is specified by the service center.

Gets the recipient phone number of the broadcast SMS message.

A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on.

Gets the update number associated with this broadcast SMS message.

The update number of the message.

Values that describe the type of a broadcast (emergency alert) message.

A CMAS Amber alert message.

A CMAS Extreme alert message.

A Commercial Mobile Alert System (CMAS) Presidential alert message.

A CMAS Severe alert message.

A CMAS Test message.

An Earthquake and Tsunami Warning System (ETWS) earthquake alert message.

An ETWS tsunami alert message.

An ETWS tsunami and earthquake alert message.

An EU Alert 1 message.

An EU Alert 2 message.

An EU Alert 3 message.

An EU Amber Alert message.

An EU informational message.

A local LAT alert broadcast message.

An unknown broadcast type.

This enumerated type identifies the format of a given protocol description unit (PDU) buffer.

The data format is CDMA WMT format of type deliver.

The data format is CDMA WMT format of type submit.

The data format is GSM of type deliver.

The data format is GSM of type submit.

The data format is unknown.

Extends the SmsDevice class, and supports the operation of a mobile broadband SMS device.

Gets the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox.

A string representation of the account phone number.

Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect.

An enumerated value indicating the device's cellular class.

The device ID of the device represented by this instance.

String representation of the device ID.

Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready.

An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations.

The parent device ID of this device.

A string representation of the device ID of the parent to this device.

Gets or sets the SMSC address of this device.

A string representation of the SMSC address of this device.

Sets an event handler to be called when the status of the SMS device changes.

Estimates the transmitted message length of the specified text message. The estimate can be useful to clients that want to give an indication of how many messages will be sent on the network to carry the text of the full message.

A reference to the SMS text message to measure. A reference to an SmsEncodedLength structure that is populated with the length information.

Creates an instance of SmsDevice2 for a device that received an SMS message.

A string representation of the device ID of the device that received an SMS message. An instance of SmsDevice2 initialized for the device with the given ID.

Creates an instance of SmsDevice2 for a device, given the device ID of the parent device.

The device ID of the parent device. An instance of SmsDevice2 initialized for the device with the given parent ID.

Creates an instance of SmsDevice2 associated with the default SMS device.

An instance of SmsDevice2 initialized for the default SMS device.

Retrieves the class selection string that can be used to enumerate SMS devices.

A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device.

Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately.

A reference to an object that implements the ISmsMessageBase interface. The message can be in text or binary format. The message operation object.

Contains values that indicate the readiness of an SMS device to engage in cellular network traffic operations.

The SIM is invalid; PIN unblock key retrials have exceeded the limit.

The device is blocked by a PIN or password that prevents the device from initializing and registering on the nework.

General device failure.

The device is locked by a PIN or password that prevents the device from initializing and registering on the network.

The device is powered off.

The device is powered on and ready to be used.

The SIM card is not inserted into the device.

The service subscription is not activated.

This structure represents information about the length of an SmsTextMessage object when it is encoded as a PDU.

The number of bytes in the last segment of the encoded message.

The number of bytes in each segment of the message.

The number of characters in the last segment of the encoded message.

The estimated number of characters that can fit in one segment of the message.

The number of segments needed to encode the message.

This enumerated type is used to determine the encoding algorithm to send or calculate the length of an SmsTextMessage object.

Standard eight bit encoding.

Standard 7-bit GSM encoding.

IA5 encoding.

Korean encoding.

Latin encoding.

Latin Hebrew encoding.

7-bit encoding if all characters can be represented, otherwise 2-byte Universal Character Set (UCS-2) encoding.

Seven-bit ASCII encoding.

Shift-JIS encoding for the Japanese language.

Unicode encoding.

The data encoding is unknown.

Values that describe the action to be taken on a message filter.

Filters with this action type are applied after **Peek** filters. Messages filtered on this action type are delivered to your app. A copy of the message can also be delivered to the messaging application to be shown to the user if appropriate. Note that if multiple applications register the same filter with this action type, each application gets its own copy of the message.

The first action type to be taken. Messages filtered on this action type are delivered to your application and are not delivered to the messaging application to be shown to the user. Note that if multiple applications register the same filter with this action type, each application gets its own copy of the message.

Filters with this action type are applied after **AcceptImmediately** filters. Messages filtered on this action type are dropped, and neither your app nor the messaging app receive the message or any notification that a message arrived and was dropped.

Filters with this action type are applied after **Drop** filters. This action type allows your application to inspect each message, and decide which are dropped and which continue on to be processed or shown to the user.

Describes an SMS filtering rule.

Creates a new, empty SmsFilterRule.

An enumeration value specifying the message type that will match this rule.

A list of broadcast channels that match this rule.

List of broadcast channel identifiers that match this rule.

Gets a list of broadcast types for an SMS message that matches this rule.

Enumeration values for broadcast types that match this rule.

The cellular class identifier for SMS messages that match this rule.

The enumeration value for the cellular class that matches this rule.

Gets a list of device identifiers for an SMS message that matches this rule.

List of device identifiers for the message.

Gets the IMSI prefixes for an SMS message that matches this rule.

A list of IMSI prefixes.

Gets the message type of an SMS message that matches this filter rule.

An enumeration value specifying the message type.

Gets a list of port numbers associated with the SMS message that matches this rule.

List of port numbers.

Gets a list of protocol identifiers associated with the SMS message that matches this rule..

List of protocol identifiers.

Gets the sender numbers associated with an SMS message that matches this rule.

List of sender numbers.

Gets the list of teleservice identifiers for an SMS message that matches this rule.

Teleservice identifiers.

Gets a list of the text message prefixes for an SMS message that matches this filter.

List of text message prefixes.

Gets a list of WAP application identifiers for the SMS message that matches this rule.

List of WAP application identifiers.

Gets a list of WAP content types for the SMS message that matches this rule.

List of WAP content types.

A collection of SmsFilterRule instances.

Creates an instance of SmsFilterRules.

An enumeration value that specifies which action type is to be associated with the rules for this instance. Action type determines the order in which rules are evaluated, as well as the action to be taken when a rule is matched.

The SmsFilterActionType for this set of filter rules.

Specifies when and how the set of rules in this SmsFilterRules collection are to be applied to incoming SMS messages.

Gets the list of rules in this SmsFilterRules instance.

A list of SMS filter rules.

Values that describe the geographical scope of a cell broadcast message.

Scope is a single cell tower.

Scope is a single cell tower, with immediate display.

Scope is a Location Area.

An undefined or unknown geographical scope.

Scope is the entire Public Land Mobile Network (PLMN).

This enumerated type specifies the message class of a message. The message class typically originates on the network, not the mobile device.

Message should be immediately displayed.

Mobile equipment (ME) specific message.

SIM specific message.

Terminal equipment (TE) specific message. Note that this message type is not currently supported.

No class was specified.

Contains event details for the event raised when an SMS message is received.

When MessageType is **App**, the message details for the message.

Message details for the received message, when it is an app message.

When MessageType is **Broadcast**, the message details for the message.

Message details for the received message, when it is a broadcast message.

The SmsMessageType of the received message.

The type of the received message. Use this value to determine which of the other properties of this instance is valid.

When MessageType is **Status**, the message details for the message.

Message details for the received message, when it is a status message.

When MessageType is **Text**, the message details for the message.

Message details for the received message, when it is a text message.

When MessageType is **Voicemail**, the message details for the message.

Message details for the received message, when it is a voicemail message.

When MessageType is **Wap**, the message details for the message.

Message details for the received message, when it is a WAP message.

Delivers the filtered message to the messaging app.

Drops the filtered message, so that it is not passed on to the messaging app.

Class used to represent registered message filters.

Static property that gets a list of currently registered message filters..

A list of current registrations.

Gets an identifier for this registered message filter.

The identifier specified at registration.

Event signaled when a message has been received that meets the filter criteria set in a registered message filter.

Registers a message filter.

Identifier used to describe this message filter. An object that represents the filter rules to be used for this registered message filter. On successful completion, the SmsMessageRegistration object that represents this registered message filter.

Unregisters a previously-registered message filter. The filter will no longer be applied to incoming messages.

This enumerated type defines the format of the SMS message.

An application-directed message (a visual voicemail message on a specific port, for example). This value is supported on UWP app and Windows Phone 8.x app on Windows 10.

The SMS message is in binary format.

A cell broadcast message. This value is supported on UWP app and Windows Phone 8.x app on Windows 10.

A send status message. This value is supported on UWP app and Windows Phone 8.x app on Windows 10.

The SMS message is in text format.

A legacy voicemail message waiting indication message.

A WAP Push message (an MMS message, for example). This value is supported on UWP app and Windows Phone 8.x app on Windows 10.

Values that describe error codes from the SMS modem in an SmsSendMessageResult.

The device failed.

The device was not ready to send SMS.

The device is restricted to a fixed dialing number list, and the number used was not in the list.

The SMSC address was not valid.

The message was not encoded properly.

The message was too large.

A network error.

There was a network failure.

The network was not ready to send SMS.

An unknown error.

SMS is not supported by the device.

SMS is not supported by the network.

Encapsulates the results of calling SmsDevice2.SendMessageAndGetResultAsync.

Gets the cellular class used in the send operation.

An enumeration value giving the cellular class used in the send operation.

Gets a boolean value indicating whether the send operation has encountered a transient error.

When true, the send resulted in an transient error.

Gets a value indicating whether the send operation was successful.

When true, the send operation has completed successfully.

Gets a list of message numbers sent.

A list of message numbers that were sent.

Gets the error code for a modem error associated with the send operation.

An enumeration value describing the error that occurred.

Gets the error code for a network error associated with the send operation.

Network-specific error codes.

Gets the error code for a transport failure associated with the send operation.

Transport-specific error code.

Encapsulates an SMS status message.

Gets the body of the status message.

The plain text body of the message.

Gets the cellular class of the message.

An enumeration value describing the message's cellular class.

Gets the device identifier associated with the status message.

The unique device identifier, as a string.

The discharge time of the status message.

The discharge time.

Gets the phone number that sent the status message.

The sending phone number, as a string.

Gets the message class of the status message.

An enumeration value giving the message class of the status message.

Gets the reference number of the status message.

The message number.

Gets the message type of the status message.

An enumeration value giving the message type of this message.

Gets the service center timestamp of the status message.

The service center date and time when the status message was sent.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

The status code associated with this message.

The status in this status message.

Gets the phone number the status message was sent to.

The phone number, as a string.

Encapsulates a decoded SMS text message. Prefer this class to the older SmsTextMessage class.

Constructs a new, default instance of this class.

Gets or sets the body of the text message.

The plain text body of the message, as a string.

Gets or sets the callback number for the message.

The callback number as a string.

Gets the cellular class of the message.

An enumeration value specifying the cellular class of the message (GSM or CDMA).

Gets the device identifier for the device associated with the SMS text message.

The device identifier.

Gets or sets the encoding scheme used for the message.

An enumeration value specifying the encoding scheme used in a received message, or the scheme to be used in a message that will be sent.

gets the phone number of the sender of the message.

The sender's phone number, as a string.

Gets or sets whether text message delivery notification is enabled for this message.

True indicates that text message delivery notification is enabled. False indicates no notification.

Gets the message class of the message.

An enumeration value, set according to the network, for the message class of the message.

Gets the message type of the message.

An enumeration value indicating the message type.

Gets the protocol identifier for the message.

Gets an integer which identifies the protocol.

Gets or sets the number of retry attempts for the message.

The number of retry attempts to be attempted for a sent message, or that were required to send a received message.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

Gets the teleservice identifier associated with this message.

The teleservice identifier.

The timestamp of this message.

The timestamp. Based on local time for a constructed message, or on the service center timestamp for a received message.

Gets or sets the recipient phone number for the message.

The destination phone number.

Encapsulates an SMS voicemail message.

Gets the body of the voicemail message.

The body of the message.

Gets the cellular class of the message.

An enumeration value specifying the cellular class of the message.

Gets the unique device identifier associated with the message.

A device identifier.

Gets the message class of the message.

An enumeration value specifying the message class of this message.

Gets the number of available messages.

The number of available voicemail messages.

Gets the type of the message.

An enumeration value specifying the message type.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

The timestamp of the message.

Received message timestamps are set by the service center.

The phone number the message was sent to.

The phone number the message was sent to.

Represents an SMS WAP push message.

Gets the value of the X-Wap-Application-Id header of the SmsWapMessage.

The value of the X-Wap-Application-Id header.

Gets the binary body of the blob in the SmsWapMessage.

The binary body of the blob in the message.

Gets the cellular class of the SMS device that received the message.

The cellular class of the SMS device that received the message.

Gets the value of the **Content-Type** header in the SmsWapMessage. Header parameters can be found in the Headers property.

The value of the **Content-Type** header in the message.

Gets the device information ID of the SmsDevice that receives the SmsWapMessage.

The device information ID of the SmsDevice that receives the SmsWapMessage.

Gets the phone number of the sender of the SmsWapMessage.

The phone number of the sender of the message.

Gets the header name-value pairs of the WAP push message.

The header name-value pairs of the WAP push message.

Gets the message class of the SmsWapMessage.

The message class of the SmsWapMessage.

Gets the message type of the SmsWapMessage.

The message type.

Gets the ICCID (Integrated Circuit Card Identifier) of the SIM that received the message.

The ICCID of the SIM.

Gets the timestamp of the SmsWapMessage.

The timestamp of the message.

Gets the recipient phone number of this SmsWapMessage.

The recipient phone number of this message.

The endpoint descriptor for a USB bulk IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer.

Gets the USB endpoint number of the bulk IN endpoint.

The endpoint number of the bulk IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the maximum number of bytes that can be sent to or received from this endpoint, in a single packet.

Indicates the maximum packet size of the endpoint. This value is derived from the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint.

An UsbBulkInPipe object that is the pipe for the bulk IN endpoint.

Represents the pipe that the underlying USB driver opens to communicate with a USB bulk IN endpoint of the device. The app can get an input stream from the pipe and access data is being read from the endpoint.

Gets the object that represents endpoint descriptor associated with the USB bulk IN endpoint.

A UsbBulkInEndpointDescriptor object that represents endpoint descriptor associated with the USB bulk IN endpoint.

Input stream that stores the data that the bulk IN pipe received from the endpoint.

Input stream that contains data read from the endpoint.

Gets the maximum number of bytes that can be read from the bulk IN pipe in a single transfer.

The maximum number of bytes that can be read from the bulk IN pipe in a single transfer.

Gets or sets configuration flags that controls the behavior of the pipe that reads data from a USB bulk IN endpoint.

A UsbReadOptions value that indicates the pipe policy.

Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk IN endpoint that is associated with the pipe.

An IAsyncAction object that is used to control the asynchronous operation.

Discards any data that is cached in the bulk IN pipe.

The endpoint descriptor for a USB bulk OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer.

Gets the USB endpoint number of the bulk OUT endpoint.

The endpoint number of the bulk OUT endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the maximum number of bytes that can be sent to or received from this endpoint.

Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the object that represents the pipe that the host opens to communicate with the bulk IN endpoint.

A UsbBulkOutPipe object that is the pipe for the bulk OUT endpoint.

Represents the pipe that the underlying USB driver opens to communicate with a USB bulk OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint.

Gets the object that represents the endpoint descriptor associated with the USB bulk OUT endpoint.

A UsbBulkOutEndpointDescriptor that represents the endpoint descriptor associated with the USB bulk OUT endpoint.

Gets an output stream to which the app can write data to send to the endpoint.

The output steam that contains the transfer data.

Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB bulk IN endpoint.

A UsbWriteOptions constant that indicates the pipe policy.

Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB bulk OUT endpoint that is associated with the pipe.

An IAsyncAction object that is used to control the asynchronous operation.

Provides information about a USB configuration, its descriptors and the interfaces defined within that configuration. For an explanation of a USB configuration, see Section 9.6.3 in the Universal Serial Bus (USB) specification.

Gets the object that contains the first 9 bytes of the descriptor associated with the USB configuration.

A UsbConfigurationDescriptor object that represents the first 9 bytes of the descriptor associated with the USB configuration.

Gets an array of objects that represent the full set of descriptors associated with a USB configuration.

An array of UsbDescriptor objects that contains the full set of descriptors associated with a USB configuration.

Gets an array of USB interfaces available in the USB configuration.

An array of UsbInterface objects.

Derives information from the first 9 bytes of a USB configuration descriptor. The information includes the power capabilities of the device when the configuration is active and the number of interfaces included in that configuration. For an explanation of a configuration descriptor, Section 9.6.3 Universal Serial Bus Specification. For information about descriptor fields, see:

Gets the **bConfigurationValue** field of a USB configuration descriptor. The value is the number that identifies the configuration.

The number that identifies the configuration.

Gets the **bMaxPower** field of a USB configuration descriptor. The value indicates the maximum power (in milliamp units) that the device can draw from the bus, when the device is bus-powered.

The maximum power (in milliamp units) that the device can draw from the bus.

Gets the D5 bit value of the **bmAttributes** field in the USB configuration descriptor. The value indicates whether the device can send a resume signal to wake up itself or the host system from a low power state.

True, if the device supports remote wakeup; otherwise false.

Gets the D6 bit of the **bmAttributes** field in the USB configuration. This value indicates whether the device is drawing power from a local source or the bus.

True, if the device is drawing power from a local source; false indicates that the device is only drawing power from the bus.

Parses the specified USB descriptor and returns fields of a USB configuration descriptor.

A UsbDescriptor object that contains first 9 bytes of the USB configuration descriptor. A UsbConfigurationDescriptor object that contains fields of a USB configuration descriptor.

Retrieves the first 9 bytes of a USB configuration descriptor in a UsbConfigurationDescriptor object that is contained in a UsbDescriptor object.

The UsbDescriptor object to parse. Receives a UsbConfigurationDescriptor object. True, if a UsbConfigurationDescriptor object was found in the specified UsbDescriptor object. Otherwise, false.

Defines constants that indicate the recipient of a USB control transfer. The recipient is defined in the setup packet of the control request. See Table 9.2 of section 9.3 of the Universal Serial Bus (USB) specification (www.usb.org).

The recipient of the control transfer is the default (or the first) USB interface in the selected configuration of the device.If the recipient is the first interface of the active configuration (DefaultInterface ), SendControlInTransferAsync and SendControlOutTransferAsync methods overwrite the low byte of UsbSetupPacket.Index with the interface number of the default interface.

The recipient of the control transfer is the device.

The recipient of the control transfer is an endpoint.

The recipient of the control transfer is other.

The recipient of the control transfer is the USB interface that is specified in the request.

Provides information about the USB control transfer, the type of control request, whether the data is sent from or to the host, and the recipient of the request in the device.

Creates a UsbControlRequestType object.

Gets or sets the **bmRequestType** value as a byte.

The entire **bmRequestType** value in a byte.

Gets or sets the type of USB control transfer: standard, class, or vendor.

The type of USB control transfer: standard, class, or vendor.

Gets or sets the direction of the USB control transfer.

The direction of the USB control transfer.

Gets or sets the recipient of the USB control transfer.

The recipient of the USB control transfer.

Defines constants that indicate the type of USB control transfer: standard, class, or vendor.

Indicates a class-specific USB control request described by a specific device class specification.

Indicates a standard USB control request that the app can send to obtain information about the device, its configurations, interfaces, and endpoints. The standard requests are described in section 9.4 of the Universal Serial Bus (USB) specification (www.usb.org).

Indicates a vendor-specified USB control request and depends on the requests supported by the device.

Provides information about the type of descriptor, its size (in bytes), and gets the descriptor data.

Gets the type of descriptor.

The type of descriptor.

Gets the length of the descriptor.

The length of the descriptor.

Reads descriptor data in the caller-supplied buffer.

A caller-supplied buffer that receives descriptor data.

Represents a USB device. The object provides methods and properties that an app can use to find the device (in the system) with which the app wants to communicate, and sends IN and OUT control transfers to the device.

Gets an object that represents a USB configuration including all interfaces and their endpoints.

A UsbConfiguration object that contains information about a USB configuration including the configuration descriptor and array of all USB interfaces in that configuration.

Gets the object that represents the default or the first interface in a USB configuration.

A UsbInterface object that represents the default or the first interface in a USB configuration.

Gets the object that represents the USB device descriptor.

A UsbDeviceDescriptor that represents the USB device descriptor.

Releases the reference to the UsbDevice object that was previously obtained by calling FromIdAsync.

Starts an asynchronous operation that creates a UsbDevice object.

The device instance path of the device. To obtain that value, get the DeviceInformation.Id property value. Returns an IAsyncOperation(UsbDevice) object that returns the results of the operation.

Gets an Advanced Query Syntax (AQS) string that the app can pass to DeviceInformation.FindAllAsync in order to find a specific type of USB device.

A UsbDeviceClass object for the device class specified by the app. String formatted as an AQS query.

Gets an Advanced Query Syntax (AQS) string, based on the device interface GUID identifier, specified by the app. The app passes the string to DeviceInformation.FindAllAsync in order to find a specific type of USB device.

The device interface GUID exposed by the Winusb.sys driver. See the remarks section. String formatted as an AQS query.

Gets an Advanced Query Syntax (AQS) string, based on vendor and product identifiers, specified by the app. The app passes the string to DeviceInformation.FindAllAsync in order to find a specific type of USB device.

Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. String formatted as an AQS query.

Gets an Advanced Query Syntax (AQS) string, based on vendor, product, and device interface GUID identifiers, specified by the app. The app passes the string to DeviceInformation.FindAllAsync in order to find a specific type of USB device.

Specifies the vendor identifier for the device as assigned by the USB specification committee. Possible values are 0 through 0xffff. Specifies the product identifier. This value is assigned by the manufacturer and is device-specific. Possible values are 0 through 0xffff. The device interface GUID exposed by the Winusb.sys driver. See the remarks section. String formatted as an AQS query.

Starts a zero-length USB control transfer that reads from the default control endpoint of the device.

A UsbSetupPacket object that contains the setup packet for the control transfer. Returns an IAsyncOperation(IBuffer) object that returns the results of the operation.

Starts a USB control transfer to receive data from the default control endpoint of the device.

A UsbSetupPacket object that contains the setup packet for the control transfer. A caller-supplied buffer that contains transfer data. Returns an IAsyncOperation(IBuffer) object that returns the results of the operation.

Starts a zero-length USB control transfer that writes to the default control endpoint of the device.

A UsbSetupPacket object that contains the setup packet for the control transfer. Returns an IAsyncOperation(UInt32) object that returns the results of the operation.

Starts a USB control transfer to send data to the default control endpoint of the device.

A UsbSetupPacket object that contains the setup packet for the control transfer. A caller-supplied buffer that contains the transfer data. Returns an IAsyncOperation(UInt32) object that returns the results of the operation.

Provides a way for the app to get an Advanced Query Syntax (AQS) string by specifying the class code, subclass code, and the protocol code defined by the device. The properties in this class are passed in the call to GetDeviceClassSelector.

Creates a UsbDeviceClass object.

Gets or sets the class code of the device.

The device class code.

Gets or sets the protocol code of the device.

The protocol code of the device.

Gets or sets the subclass code of the device.

The subclass code of the device.

Provides a way for the app to create a UsbDeviceClass object by specifying the USB device class of the device. The properties defined in this class represent the supported USB device classes and are passed in the constructor call to instantiate UsbDeviceClass. For information about USB device classes, see the official USB Website for Approved Class Specification Documents.

Gets the device class object for the device that conforms to the Active Sync device class.

A UsbDeviceClass object for the Active Sync device class.

Gets the device class object for the device that conforms to the Communication Device Class (CDC).

A UsbDeviceClass object for the CDC-compliant device.

Gets the device class object for the device that conforms to the Device Firmware Update device class.

A UsbDeviceClass object for the Device Firmware Update device class.

Gets the device class object for an infrared transceiver that conforms to the IrDA class defined as per the IrDA Bridge Device Definition 1.0 specification.

A UsbDeviceClass object for the IrDA class.

Gets the device class object for a device that conforms to the USB test and measurement class (USBTMC).

A UsbDeviceClass object for the USBTMC-compliant device.

Gets the device class object for the device that conforms to the Palm Sync device class.

A UsbDeviceClass object for the Palm Sync device class.

Gets the device class object for a device that conforms to the USB Personal Healthcare Device Class (PHDC).

A UsbDeviceClass object for a PHDC-compliant healthcare device.

Gets the device class object for a device that conforms to the Physical Interface Devices (PID) specification.

A UsbDeviceClass object for a PID-compliant device.

Gets the device class object for a custom device that has 0xFF class code. This indicates that the device does not belong to a class approved by USB-IF.

A UsbDeviceClass object for a custom device.

Derives information from the USB device descriptor of the device. For an explanation of the device descriptor, see Table 9.8 in the Universal Serial Bus Specification.

Gets the **bcdDeviceRevision** field of the USB device descriptor. The value indicates the revision number defined by the device and is a binary-coded decimal number.

The revision number defined by the device.

Gets the **bcdUSB** field of the USB device descriptor. The value indicates the version of the USB specification to which the device conforms.

The version of the USB specification to which the device conforms.

Gets the **bMaxPacketSize0** field of the USB device descriptor. The value indicates the maximum packet size, in bytes, for endpoint zero of the device. This value can be 8, 16, 32, or 64.

The maximum packet size, in bytes, for endpoint zero of the device.

Gets the **bNumConfigurations** field of the USB device descriptor. The value indicates the total count of USB configurations supported by the device.

A number that indicates the total count of USB configurations supported by the device.

Gets the **idProduct** field of the USB device descriptor. This value indicates the device-specific product identifier and is assigned by the manufacturer.

The device-defined product identifier.

Gets the **idVendor** field of the USB device descriptor. The value indicates the vendor identifier for the device as assigned by the USB specification committee.

The vendor identifier for the device as assigned by the USB specification committee.

Derives information from the USB endpoint descriptor of the endpoint, such as type, direction, and endpoint number. This object also gets the specific endpoint descriptors based on the type of endpoint. For an explanation of an endpoint descriptor, see Section 9.6.5 in the Universal Serial Bus Specification:

Gets an object that represents the endpoint descriptor for the USB bulk IN endpoint.

A UsbBulkInEndpointDescriptor object that describes the USB bulk IN endpoint.

Gets an object that represents the endpoint descriptor for the USB bulk OUT endpoint.

A UsbBulkOutEndpointDescriptor that describes the USB bulk OUT endpoint.

Gets an object that represents the endpoint descriptor for the USB interrupt IN endpoint.

An UsbInterruptInEndpointDescriptor that describes the USB interrupt IN endpoint.

Gets an object that represents the endpoint descriptor for the USB interrupt OUT endpoint.

An UsbInterruptOutEndpointDescriptor object that describes the interrupt OUT endpoint.

Gets the direction of the USB endpoint.

A UsbTransferDirection value that indicates the direction of the endpoint. This value is Bit 7 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the USB endpoint number.

The USB endpoint number. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the type of USB endpoint.

A UsbEndpointType constant that indicates the type of USB endpoint. This value is Bit 1...0 of the **bmAttributes** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Parses the specified USB descriptor and returns the USB endpoint descriptor in a UsbEndpointDescriptor object.

A UsbDescriptor object that contains the USB endpoint descriptor. A UsbEndpointDescriptor object that contains the USB endpoint descriptor.

Retrieves the USB endpoint descriptor in a UsbEndpointDescriptor object that is contained in a UsbDescriptor object.

The UsbDescriptor object to parse. Receives a UsbEndpointDescriptor object. True, if the specified UsbDescriptor object is a USB endpoint descriptor. Otherwise, false.

Defines constants that indicate the type of USB endpoint: control, bulk, isochronous, or interrupt.

Indicates a USB bulk endpoint.

Indicates a USB control endpoint (Endpoint 0).

Indicates a USB interrupt endpoint.

Indicates a USB isochronous endpoint.

Provides information about the USB interface including its endpoints, the number of alternate settings the interface supports, and gets the entire descriptor set for those settings. It also obtains pipes associated with the endpoints that the interface supports.

Gets an array of objects that represent pipes that the host opened to communicate with bulk IN endpoints defined in the current setting of the USB interface setting.

An array of UsbBulkInPipe objects.

Gets an array of objects that represent pipes that the host opened to communicate with bulk OUT endpoints defined in the current setting of the USB interface.

An array of UsbBulkOutPipe objects.

Gets an array of objects that represent descriptors for all alternate settings that are part of this USB interface.

An array of UsbDescriptor objects.

Gets the interface number that identifies the USB interface. This value is the **bInterfaceNumber** field of a standard USB interface descriptor.

The interface number that identifies the USB interface.

Gets an array of objects that represent alternate settings defined for the USB interface.

An array of UsbInterfaceSetting objects.

Gets an array of objects that represent pipes that the host opened to communicate with interrupt IN endpoints defined in the current setting of the USB interface.

An array of UsbInterruptInPipe objects. The objects are in the same order as they are defined in the interface descriptor.

Gets an array of objects that represent pipes that the host opened to communicate with interrupt OUT endpoints defined in the current setting of the USB interface.

An array of UsbInterruptOutPipe objects.

Describes a USB alternate setting (of an interface) in an interface descriptor. For an explanation of an interface descriptor, see Section 9.6.5 in the Universal Serial Bus Specification:

Gets the **bAlternateSetting** field of the USB interface descriptor. The value is a number that identifies the alternate setting defined by the interface.

A number that identifies the alternate setting defined by the interface.

Gets the **bInterfaceClass** field of the USB interface descriptor. The value indicates the USB-defined class to which the interface conforms.

The USB-defined class to which the interface conforms.

Gets the **bInterfaceNumber** field of the USB interface descriptor. The value is the index that identifies the interface.

The index that identifies the interface.

Gets the **bInterfaceProtocol** field of the interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms.

A USB-assigned identifier that specifies a USB-defined protocol to which the interface conforms.

Gets the **bInterfaceSubClass** field of the USB interface descriptor. The value is a USB-assigned identifier that specifies a USB-defined subclass to which the interface.

A USB-assigned identifier that specifies a USB-defined subclass to which the interface.

Parses the specified USB descriptor and returns alternate setting information in a UsbInterfaceDescriptor object.

A UsbDescriptor object that contains the USB interface descriptor. A UsbInterfaceDescriptor object describes the alternate setting.

Retrieves information about the alternate setting in a UsbInterfaceDescriptor object that is contained in a UsbDescriptor object.

The UsbDescriptor object to parse. Receives a UsbInterfaceDescriptor object. True, if the specified UsbDescriptor object is USB interface descriptor. Otherwise, false.

Provides information about an alternate setting and select that setting. The app can get the USB interface descriptors for the setting and its endpoints, and determine whether this setting is currently selected.

Gets an array of objects that represent descriptors associated with USB bulk IN endpoints that are defined in the alternate setting.

An array of UsbBulkInEndpointDescriptor objects.

Gets an array of objects that represent descriptors associated with USB bulk OUT endpoints that are defined in the alternate setting.

An array of UsbBulkOutEndpointDescriptor objects.

Gets an array of objects that represent descriptors associated with the alternate setting.

An array of UsbDescriptor objects that represent the interface descriptor associated with the alternate setting.

Gets an object that represents the descriptor that describes the alternate setting.

A UsbInterfaceDescriptor object that has the full descriptor for the alternate setting. Requirements

Gets an array of objects that represent descriptors associated with USB interrupt IN endpoints that are defined in the alternate setting.

An array of UsbInterruptInEndpointDescriptor objects.

Gets an array of objects that represent descriptors associated with USB interrupt OUT endpoints that are defined in the alternate setting.

An array of UsbInterruptInEndpointDescriptor objects.

Determines whether the alternate setting is currently selected.

True, if the alternate setting is currently selected; otherwise, false.

Selects the alternate setting as the current setting in the USB interface.

An IAsyncAction object that is used to control the asynchronous operation.

The endpoint descriptor for a USB interrupt IN endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be read from the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint for data.

Gets the USB endpoint number of the interrupt IN endpoint.

The endpoint number of the interrupt IN endpoint. That number is in Bit 3...0 of the **bEndpointAddress** field of an endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the poling interval of the USB interrupt endpoint.

The poling interval of the USB interrupt endpoint.

Gets the maximum number of bytes that can be sent to or received (in a packet) from this endpoint.

Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the object that represents the pipe that the host opens to communicate with the interrupt IN endpoint.

An UsbInterruptInPipe object that is the pipe for the interrupt IN endpoint.

Represents the object that is passed as a parameter to the event handler for the DataReceived event.

Gets data from the interrupt IN endpoint.

An IBuffer object that contains data that was read from the interrupt IN endpoint.

Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt IN endpoint of the device. The object also enables the app to specify an event handler. That handler that gets invoked when data is read from the endpoint.

Gets the object that represents the endpoint descriptor associated with the USB interrupt IN endpoint.

A UsbInterruptInEndpointDescriptor object that represents the endpoint descriptor associated with the USB interrupt IN endpoint.

Raised when the interrupt pipe receives data from the interrupt IN endpoint.

Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt IN endpoint that is associated with the pipe.

An IAsyncAction object that is used to control the asynchronous operation.

The endpoint descriptor for a USB interrupt OUT endpoint. The descriptor specifies the endpoint type, direction, number and also the maximum number of bytes that can be written to the endpoint, in a single transfer. The app can also get information about how often the host polls the endpoint to send data.

Gets the USB endpoint number of the interrupt OUT endpoint.

The USB endpoint number.

Gets the poling interval of the USB interrupt endpoint.

The poling interval of the USB interrupt endpoint.

Gets the maximum number of bytes that can be sent to or received from this endpoint.

Indicates the maximum packet size of the endpoint. This value is the **wMaxPacketSize** field value of the endpoint descriptor. For information, see Table 9-13 in the Universal Serial Bus Specification (version 2.0) or Table 9-18 in the Universal Serial Bus 3.0 Specification.

Gets the object that represents the pipe that the host opens to communicate with the interrupt OUT endpoint.

An UsbInterruptInPipe object that is the pipe for the interrupt OUT endpoint.

Represents the pipe that the underlying USB driver opens to communicate with a USB interrupt OUT endpoint of the device. The object provides access to an output stream to which the app can write data to send to the endpoint.

Gets the object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint.

A UsbInterruptOutEndpointDescriptor object that represents the endpoint descriptor associated with the USB interrupt OUT endpoint.

Gets an output stream to which the app can write data to send to the endpoint.

Output stream that contains data to write to the endpoint.

Gets or sets configuration flags that controls the behavior of the pipe that writes data to a USB interrupt OUT endpoint.

A UsbWriteOptions constant that indicates the pipe policy.

Starts an asynchronous operation to clear a stall condition (endpoint halt) on the USB interrupt OUT endpoint that is associated with the pipe.

An IAsyncAction object that is used to control the asynchronous operation.

Defines constants for configuration flags that can be set for a USB pipe that the host opens for a USB bulk IN endpoint.

Allows read requests from a device that returns more data than requested by the caller.

Automatically clears a stalled pipe without stopping the data flow.

The host does not complete a read request when a short packet is received. The read request is completed only when an error occurs, the request is canceled, or all requested bytes have been read.

Clear all flags.

Bypasses queuing and error handling to boost performance for multiple read requests. Read operations must be done in multiples of MaxPacketSize.

Describes the setup packet for a USB control transfer. For an explanation of the setup packet, see Table 9.2 in the Universal Serial Bus (USB) specification.

Creates a UsbSetupPacket object.

Creates a UsbSetupPacket object from a formatted buffer (eight bytes) that contains the setup packet.

A caller-supplied buffer that contains the setup packet formatted as per the standard USB specification. The length of the buffer must be eight bytes because that is the size of a setup packet on the bus.

Gets or sets the **wIndex** field in the setup packet of the USB control transfer.

The **wIndex** field in the setup packet. For an explanation of this field, see section 9.3.4 of the Universal Serial Bus (USB) specification.

Gets the length, in bytes, of the setup packet.

The length, in bytes, of the setup packet.

Gets or sets the **bRequest** field in the setup packet of the USB control transfer.

The **bRequest** field in the setup packet. For an explanation of this field, see section 9.3.2 of the Universal Serial Bus (USB) specification.

Gets or sets the **bmRequestType** field in the setup packet of the USB control transfer. That field is represented by a UsbControlRequestType object.

The **bmRequestType** field in the setup packet. The values that are assigned to this field are described in Table 9.2 and section 9.3.1 of the Universal Serial Bus (USB) specification.

Gets or sets the **wValue** field in the setup packet of the USB control transfer.

The **wValue** field in the setup packet and the value varies according to the request. For an explanation of this field, see section 9.3.3 of the Universal Serial Bus (USB) specification.

Defines constants that indicate the direction of USB transfer: IN or OUT transfers.

Indicates an IN transfer from the device to the host.

Indicates an OUT transfer from the host to the device.

Defines constants for configuration flags that can be set for a USB pipe that the host opens for a USB OUT endpoint.

Automatically clears a stalled pipe without stopping the data flow.

Clear all flags.

Sends a zero length packet for a write request in which the buffer is a multiple of the maximum packet size supported by the endpoint.

Used to report the results of an attempt to request access to a Wi-Fi adapter.

Access has been allowed.

Access has been denied by the system.

Access has been denied by the user, through the user interface.

The asynchronous request has not completed yet.

Use this class to enumerate local Wi-Fi adapters, initiate Wi-Fi scans, enumerate scan results, and to connect or disconnect individual adapters.

Gets information about a Wi-Fi adapter.

An instance of Windows.Networking.Connectivity.NetworkAdapter representing this adapter.

Gets a list of available networks populated by the last Wi-Fi scan on this WiFiNetworkAdapter.

A list of available networks.

Event raised when a scan completes on this Wi-Fi adapter. This event cannot be raised from a background task.

Connect this Wi-Fi device to the specified network, with the specified reconnection policy.

Describes the Wi-Fi network to be connected. Specifies how to reconnect if the connection is lost. An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation.

Connect this Wi-Fi device to the specified network, with the specified passphrase and reconnection policy.

Specifies the Wi-Fi network to connect to. Describes how to reconnect to the network if connection is lost. The passphrase to be used to connect to the access point. An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation.

Connect this Wi-Fi device to a hidden network, with the given passphrase and reconnection policy.

Describes the Wi-Fi network to connect to. Describes how to reconnect to the network if connection is lost. Password or other credential to use to connect to the network. When the network SSID is hidden, use this parameter to provide the SSID. An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation.

Connect this Wi-Fi device to a hidden network, with the given passphrase, connection method, and reconnection policy.

Specifies the Wi-Fi network to connect to. Specifies how to reconnect if the connection is lost. The passphrase to be used to connect to the access point. When the network SSID is hidden, use this parameter to provide the SSID. A WiFiConnectionMethod enumeration member indicating the connection method. An asynchronous connect operation. On successful conclusion of the operation, returns an object that describes the result of the connect operation.

Disconnects any active Wi-Fi connection through this adapter.

A static method that initiates an asynchronous operation to enumerate all Wi-Fi adapters in the system.

An asynchronous enumeration operation. On successful completion, returns a list of available Wi-Fi adapters.

A static method that initiates an asynchronous operation to get a WiFiAdapter object.

The Device ID of the Wi-Fi adapter to be retrieved. Obtain a Device ID through the Windows.Devices.Enumeration namespace. An asynchronous get operation. On successful completion, returns a WiFiAdapter object specific to the requested Device ID.

A static method that returns an Advanced Query Syntax (AQS) string to be used to enumerate Wi-Fi adapters using Windows.Devices.Enumeration.DeviceInformation.FindAllAsync and related methods.

An identifier to be used to enumerate Wi-Fi devices.

Performs WPS discovery to query the WPS methods supported by the network.

An available Wi-Fi network. See WiFiAvailableNetwork class. On successful completion, returns a WiFiWpsConfigurationResult.

A static method for determining whether the current user can access any of the Wi-Fi adapters on this device.

An asynchronous access operation. On successful completion, returns a status enumeration value describing whether the current user can access any Wi-Fi adapter.

Directs this adapter to initiate an asynchronous network scan.

An asynchronous scan operation. On successful completion, returns a list of networks scanned by this adapter.

Describes an available Wi-Fi network.

Gets the interval between 802.11 Beacon frames used by this network.

A TimeSpan representing the interval between beacons on this network.

Gets the MAC address of the access point.

The MAC address of the access point, formatted as xx:xx:xx:xx:xx:xx with always lower-case characters.

Gets the channel center frequency of the band on which the 802.11 Beacon or Probe Response was received.

The channel center frequency of the band on which the 802.11 Beacon or Probe Response frame was received. The value of this property is in units of kilohertz (kHz). Note that this member is only valid for PHY types that are not frequency-hopping spread spectrum (FHSS). In all other cases the value returned is zero.

Gets a value indicating whether this network originates from a Wi-Fi Direct access point.

When true, the network is originated by a Wi-Fi Direct access point. Otherwise, it is not.

Gets a value describing the kind of network being described.

A WiFiNetworkKind enumeration member indicating the BSS network type.

Gets the signal strength of the network.

The signal strength, expressed in dBm.

Gets a value describing the kind of PHY used by this network.

A WiFiPhyKind value indicating the PHY kind of the network.

Gets the security configuration of the network.

An Instance of Windows.Networking.Connectivity.NetworkSecuritySettings describing the security configuration of the network.

Gets the strength of the signal as a number of bars.

The current number of signal bars displayed by the Windows UI for the network.

Gets the SSID (name) of the network.

The network SSID.

Gets the uptime value reported by the network.

TimeSpan value representing the value of the Timestamp field from the 802.11 Beacon or Probe Response frame received by the wireless LAN interface.

Describes the kinds of connection methods.

Default.

WPS pin.

WPS protected setup.

Describes the results of an attempt to connect to a Wi-Fi network.

Gets the connection result value.

Value describing the current status of the connection attempt.

Status of the connection attempt.

Connection failed because access to the network has been revoked.

Connection failed because an invalid credential was presented.

Connection failed because the network is not available.

Connection succeeded.

Connection failed because the connection attempt timed out.

Connection failed for a reason other than those in this list.

Connection failed because the authentication protocol is not supported.

Describes the kinds of Wi-Fi networks.

An independent (IBSS) network.

Either an infrastructure or independent network.

An infrastructure network.

Contains the result of a network scan operation.

A list of available networks.

A list of available networks.

Contains the result of a network scan operation.

The date and time that the scan operation finished.

Describes PHY types supported by standard 802.11.

Directional multi-gigabit (DMG) PHY for 802.11ad.

Direct sequence, spread-spectrum (DSSS) PHY.

Extended Rate (ERP) PHY.

Frequency-hopping, spread-spectrum (FHSS) PHY.

High-Efficiency Wireless (HEW) PHY for 802.11ax.

High-rated DSSS (HRDSSS) PHY.

High Throughput (HT) PHY for 802.11n PHY.

Infrared (IR) baseband PHY.

Orthogonal frequency division multiplex (OFDM) PHY.

Unspecified PHY type

Very High Throughput (VHT) PHY for 802.11ac PHY.

Describes whether to automatically reconnect to this network.

Reconnect automatically.

Allow user to reconnect manually.

Wifi configuration result returned by a call to GetWpsConfigurationAsync.

The status of a GetWpsConfigurationAsync call.

A WiFiWpsConfigurationStatus enumeration member indicating the status of the call.

A list of supported WPS connection methods.

A list of supported WPS connection methods.

Describes the status of the GetWpsConfigurationAsync call.

Connection succeeded.

Connection failed because the connection attempt timed out.

Connection failed for a reason other than those in this list.

Describes the kinds of WPS connection methods.

Not used.

Near field communication.

WPS pin.

WPS push button.

Unknown.

Not used.

Represents a Wi-Fi Direct advertisement and allows the app to control the listen state and custom information elements in the advertisement.

Information elements to advertise in the Wi-Fi Direct advertisement.

Information elements to advertise.

Whether autonomous group owner will be enabled.

Whether autonomous group owner will be enabled.

Gets the settings object for "legacy" (non-Wi-Fi Direct) connections.

The legacy settings object.

Gets or sets the listen state and whether the Wi-Fi Direct device is discoverable.

The listen state and whether the Wi-Fi Direct device is discoverable.

Gets a device's supported configuration methods.

A list of WiFiDirectConfigurationMethod values representing supported configuration methods.

Specifies whether the Wi-Fi Direct device is listening and discoverable.

The device is discoverable when the app is in the foreground or in the background.

The device is not discoverable.

The device is highly discoverable so long as the app is in the foreground.

An object to publish Wi-Fi Direct advertisements.

Creates a new WiFiDirectAdvertisementPublisher object.

Gets the Wi-Fi Direct advertisement to publish.

The Wi-Fi Direct advertisement to publish.

Gets the current status of the WiFiDirectAdvertisementPublisher.

The current status of the WiFiDirectAdvertisementPublisher.

Notification that the status of the WiFiDirectAdvertisementPublisher has changed.

Starts the Wi-Fi Direct advertisement.

Stops the Wi-Fi Direct advertisement.

Represents the possible states of the WiFiDirectAdvertisementPublisher.

The publisher is aborted due to error.

The initial status of the publisher.

The publisher is started and advertisements are being published.

The publisher is stopped.

Provides data for a StatusChanged event on a WiFiDirectAdvertisementPublisher.

Gets the error status for a StatusChanged event on a WiFiDirectAdvertisementPublisher.

The error status for a StatusChanged event on a WiFiDirectAdvertisementPublisher.

Gets the new status of the WiFiDirectAdvertisementPublisher.

The new status of the WiFiDirectAdvertisementPublisher.

Specifies a Wi-Fi Direct configuration method. Configuration is how a user tells one piece of Wi-Fi Direct equipment to connect to another piece of Wi-Fi Direct equipment.

This device accepts connections from devices that provide the PIN this device currently displays.

This device accepts entry of the PIN being displayed on the accepting device.

This device uses the pushbutton method for pairing. A user pushes a button on both the connecting device and the accepting device in order to establish a connection between them.

Class used to listen for incoming Wi-Fi Direct connection requests.

Creates a new WiFiDirectConnectionListener object.

Notification on an incoming Wi-Fi Direct connection request.

Used by an app to specify the connection parameters for a Wi-Fi Direct connect/pairing operation.

Creates a new WiFiDirectConnectionParameters object.

The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation.

The group owner intent value used for group owner negotiation in a Wi-Fi Direct connect/pairing operation.

Gets a list of supported configuration methods, in order of preference.

A list of WiFiDirectConfigurationMethod values representing supported configuration methods, in order of preference (most preferred first.)

Gets or sets a value specifying a device's preferred pairing procedure.

The preferred pairing procedure.

Gets a list of the DevicePairingKinds supporting the given configuration method.

A value specifying a configuration method. A value specifying a pairing kind, for use with the pairing functionality in the Windows.Devices.Enumeration API.

A Wi-Fi Direct connection request received by a WiFiDirectConnectionListener.

Gets device information for the endpoint making the Wi-Fi Direct connection request.

Device information for the endpoint making the Wi-Fi Direct connection request.

Closes the WiFiDirectConnectionRequest object.

Provides data for a ConnectionRequested event on a WiFiDirectConnectionListener.

Retrieves the WiFiDirectConnectionRequest received on a ConnectionRequested event by a WiFiDirectConnectionListener.

The Wi-FI Direct connection request.

Describes the connection status of a WiFiDirectDevice object.

The device is connected to an associated Wi-Fi Direct device.

The device is not connected.

Manages connections to associated Wi-Fi Direct devices.

Gets the connection status for the WiFi-Direct device.

The connection status for the WiFi-Direct device.

Gets the DeviceInformation Id for the Wi-Fi Direct device.

The DeviceInformation Id for the Wi-Fi Direct device.

Occurs when a Wi-Fi Direct device connection is connected or disconnected.

Close the active Wi-Fi Direct device connection.

Creates an instance of the WiFiDirectDevice class for the specified device interface id.

The DeviceInformation Id of a Wi-Fi Direct device. An asynchronous operation to retrieve the WiFiDirectDevice that was created.

Creates an instance of the WiFiDirectDevice class for the specified device interface id with specific connection parameters.

The DeviceInformation Id of a Wi-Fi Direct device. Connection parameters for a Wi-Fi Direct connect/pairing operation. An asynchronous operation to retrieve the WiFiDirectDevice that was created.

Gets a collection of network addresses for the Wi-Fi Direct device as endpoint pairs.

A collection of network addresses for the Wi-Fi Direct device as endpoint pairs.

Returns the class selection string that you can use to enumerate Wi-Fi Direct devices.

The class selection string that you can use to enumerate Wi-Fi Direct devices.

Returns the class selection string that you can use to enumerate Wi-Fi Direct devices for a specific Wi-Fi Direct device selector type.

A specific Wi-Fi Direct device selector type. The class selection string that you can use to enumerate Wi-Fi Direct devices.

Specifies the device selector type for Wi-Fi Direct.

An associated endpoint. This includes other PC, tablets, and phones.

A device interface.

Specifies some common Wi-Fi Direct error cases.

The Wi-Fi Direct radio was not available. This error occurs when the Wi-Fi Direct radio has been turned off.

The operation cannot be serviced because the necessary resources are currently in use.

The operation was successfully completed or serviced.

Represents information elements in a Wi-Fi Direct packet.

Creates a new WiFiDirectInformationElement object.

A three-byte organization identifier used to indicate the organization which defined a vendor extension information element (IE).

A three-byte organization identifier used to indicate the organization which defined a vendor extension IE.

A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization.

A one byte type value used in a vendor extension information element (IE) to distinguish between different IE formats defined by the same organization.

The value of the information element.

The value of the information element.

Create an array of information elements from a data buffer.

The data buffer that contains a information element. A array of information elements created from the buffer.

Create an array of information elements from a DeviceInformation object.

The device information object that contains the information elements. A array of information elements created from the device information object.

Settings governing "legacy" mode (non-Wi-Fi Direct connections to the access point being advertised.)

Gets or sets a value specifying whether "legacy mode" is enabled. When enabled, this mode causes this device to act as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct.

When true, "legacy mode" is enabled.

Gets or sets the pass phrase used by non-Wi-Fi Direct clients to connect to this access point in "legacy mode".

The pass phrase for the Wi-Fi network. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct.

Gets or sets the Service Set Identifier (SSID, or "access point ID").

The SSID for the access point. This access point functions as a normal Wi-Fi access point, and is intended to support devices which do not support connection via Wi-Fi Direct.

Specifies a direct pairing procedure.

Group Owner Negotiation. The connecting device chooses the configuration method.

P2P Invitation. The accepting device chooses the configuration method.

Represents a Wi-Fi Direct service. This class is used by code on a device that seeks to use a Wi-Fi Direct Service, to establish a Wi-Fi Direct Service session with the service provider.

Gets or sets a value specifying whether the service instance should choose Wi-Fi Direct Point to Point (P2P) Group Owner (GO) mode.

When true, prefer GO mode.

Gets the service information blob from this service instance.

A buffer of up to 255 bytes with information from the server. The format of this blob is determined by the individual service.

Error information about the latest attempt to connect to the service.

An enumeration value specifying the detailed reason for the failure.

Gets or sets app-specific session information passed to the server when initiating a session.

Session information. Format is determined by the individual service. Set this property before calling ConnectAsync.

Gets a list of supported configuration methods, ordered by preference. Your code uses IVector operations to modify the contents of the list.

Ordered list of configuration method enumeration values.

Event raised when a session request has been deferred. Note that this does not mean that the request has failed or been denied. It is a notification that the server is performing a long operation, such as waiting for a user to enter a PIN. The seeker that receives this message should begin a 120-second wait before it times out the session request, to give the server time to complete its operation.

Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance.

An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established.

Initiates the establishment of a service session with the Wi-Fi Direct Service represented by this instance, using a PIN to configure the session.

The PIN to be used to configure the connection. An asynchronous connection operation. When successfully completed, returns an object that represents the session that has been established.

Static method that retrieves a WiFiDirectService instance for a Wi-Fi Direct Service offered by the device with a given device ID.

Device ID of the device that advertises the desired Wi-Fi Direct Service. An asynchronous retrieval operation. On successful completion, returns an instance of WiFiDirectService specific to the desired service instance, advertised by the indicated device.

Asynchronously retrieves Wi-Fi Direct Service session provisioning information.

The preferred method of configuring the session. An asynchronous retrieval operation. On successful completion, returns provisioning information.

Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service.

The service name to be found. The AQS string for the requested advertiser query.

Gets an Advanced Query Syntax (AQS) string to be used to find Wi-Fi Direct Service advertisers for a particular service, where a given byte sequence appears in the advertiser's service information blob.

The service name to be found. A byte sequence that must be found in the advertiser's service information blob. The AQS string for the requested advertiser query.

Values used for WiFiDirectServiceAdvertiser.AdvertisementStatus.

Advertiser has been aborted. The advertiser object's ServiceError property has a specific error code describing the reason.

Advertiser has been created.

Advertiser has been started.

Advertiser has been stopped.

Represents a Service Advertiser. This class is used by code on a device that advertises Wi-Fi Direct Services, to advertise the service.

Creates an instance of the WiFiDirectServiceAdvertiser class. To start advertising a Wi-Fi Direct Service, create an instance of this class, set its properties appropriately for your service, and then call its Start method.

The name of the service to be advertised. Service names are UTF-8 strings no more than 255 characters long. It is recommended that names use reverse domain name notation, where the service owner's DNS name (such as "contoso.com") is reversed and used as the beginning of the service name (such as "com.contoso.serviceX"). This convention is intended to make it easy to choose unique service names.

Gets a value that describes the current status of the advertisement.

An enumeration value that describes current status.

Gets or sets the Auto Accept property for this service advertisement.

When true, then the service automatically accepts all requests from service seekers to establish a session. If this value is false, then the service must actively accept a session request when the SessionRequested event is raised.

Gets or sets a custom service status code. Only valid if the ServiceStatus property value is **Custom**.

If ServiceStatus is set to **Custom**, this property is the custom status value. Custom values must be in the range 2 - 255.

Gets or sets the service-specific information that is passed to a session requester when establishing a session will not be completed immediately, as when, for example, the service is waiting for user input to complete the request. A requester should implement a 120 second timeout when its request is deferred.

The information to be sent to the session requester. Format is service-specific, and total size cannot exceed 144 bytes.

Gets or sets a value indicating whether the service requires that it be the Wi-Fi Direct Peer to Peer (P2P) Group Owner.

If true, the service must be the Group Owner (GO) of the Peer to Peer (P2P) connection between seeker and service. If false, the service will accept connections whether it is the GO or not.

Gets a list (that implements the IVector interface) of preferred session configuration methods. Your code uses IVector operations on the list to add or remove elements from the list.

An ordered list of enumeration values indicating preferred configuration methods. The earlier a configuration method appears in the list, the higher the preference for using that method when configuring sessions with this advertiser.

Gets a specific error code when AdvertisementStatus is **Aborted**.

An enumeration value that gives a more specific cause for AdvertisementStatus being **Aborted**.

Gets or sets the service information blob. The format and contents of the blob are determined by the individual service, and are intended to be used by Seekers during service discovery.

The service information blob.

Gets the service name.

The service name.

Gets a list of service name prefixes that should match this service when a seeker is using prefix searching. Your code uses IVector methods to add or remove elements from the list.

The list of prefixes. Prefix values

Gets or sets the service status.

An enumeration value that corresponds to the service status. Note that if this value is **Custom**, then the CustomServiceStatusCode property gives the actual custom status code value.

Event raised when the AdvertisementStatus property value changes.

Event raised when the service has automatically accepted a session request. Your event handler should establish socket connections for the endpoint pairs listed in the event arguments object.

Event raised when a Seeker has requested that a session be established with the service associated with this WiFiDirectServiceAdvertiser instance. To accept the request, call WiFiDirectServiceAdvertiser.ConnectAsync in your event handler.

Accepts a session request without requiring a PIN.

Describes the device to be connected. Pass in the WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation property value. An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created.

Accepts a session request by connecting with the given PIN.

Describes the device to be connected. Pass in the WiFiDirectServiceSessionRequestedEventArgs.DeviceInformation property value. The PIN to be used to configure the session. An asynchronous connection operation. On successful completion, returns an object that describes the session that has been created.

Starts advertising the service, using current property values to set the parameters of the advertisement.

Stops advertising the service. This does not affect existing sessions that are connected to the service.

Returned when a WiFiDirectServiceAdvertiser.AutoAcceptSessionConnected event is raised.

Gets the WiFiDirectServiceSession that was created when the connection was automatically accepted.

The session object corresponding to this automatically accepted connection.

Gets the session information buffer that corresponds to this automatically accepted connection.

Service-specific session information, up to 144 bytes. Can be NULL if the service provides no session information.

Values describing how service configuration is performed when a session is being established. Typically, either no input is required, or one device in the session displays a PIN and the other device requires that the PIN be entered.

Do not require input at configuration.

Display a PIN at configuration.

Request PIN entry at configuration.

Values used for the WiFiDirectServiceAdvertiser.ServiceError property.

No Wi-Fi adapter is found.

The Wi-Fi Direct radio is not available.

A required resource is in use.

No error.

The Wi-Fi adapter does not support Wi-Fi Direct.

Defines constants that specify the IP protocol of the new port when a WiFiDirectServiceSession.RemotePortAdded event is raised.

Specifies the TCP protocol.

Specifies the UDP protocol.

Contains provisioning information about a Wi-Fi Direct Service.

Gets a value indicating whether Wi-Fi Direct Point to Point (P2P) group formation is needed.

When true, group formation is needed.

Gets a value describing the configuration method in use.

Enumeration value representing the configuration method in use.

Returned when a WiFiDirectServiceSession.RemotePortAdded event is raised. Your event handler should use this information to establish new socket connections to the new port.

Gets the endpoint pairs associated with the new remote port.

New endpoint pairs.

Gets the protocol used to communicate with the new remote port.

An enumeration value corresponding to the IP protocol to use for the new remote port.

Represents a Wi-Fi Direct Services (WFDS) session.

Gets the advertisement ID for the session.

The advertisement ID.

Gets the error status of the session.

An enumeration value giving session error status.

Gets the service address for this session.

The service address.

Gets the service name of the advertiser service involved in the session.

The service name of the advertiser service.

Gets the session address for the session.

The session address.

Gets the session ID.

A unique session identifier.

Gets the session status.

An enumeration value describing the current session status.

Event raised when a new remote port is added to the session. Your event handler should respond by establishing the appropriate socket connection to the new remote port.

Event raised when the session status changes.

Adds a DatagramSocket to the session. Your code creates the DatagramSocket before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a RemotePortAdded event is raised on each remote device in the session, specifying the UDP protocol.) A remote device can use that information to open a socket and connect back to the local machine.

The DatagramSocket instance to associate with this session. An asynchronous association action. Returns on successful completion of the association.

Adds a StreamSocketListener to the session. Your code creates the StreamSocketListener before calling this method. Associating a socket to the session causes port information to be sent to the remote device(s) in the session. (In terms of this API, a RemotePortAdded event is raised on each remote device in the session, specifying the TCP protocol.) A remote device can use that information to open a socket and connect back to the local machine.

The StreamSocketListener instance to be associated with the session. An asynchronous association action. Returns on successful completion of the association.

Closes the session.

Gets a list of connection endpoint pairs for the session. Your code uses IVectorView operations to enumerate the endpoint pairs in the list.

An immutable snapshot list of endpoint pairs involved in the session.

Returned when a WiFiDirectService.SessionDeferred event is raised.

Gets the service-defined session information returned by the service when it sends a deferral in response to a connection request. Note that a deferral does not indicate that the connection is refused. Rather, it indicates that the server is performing a time-consuming operation such as requesting user input. A seeker should implement a 120-second timeout after getting a deferral before giving up on the request.

A byte sequence of deferred session information, up to 144 bytes. Format is defined by the service.

Values used in the WiFiDirectServiceSession.ErrorStatus property.

The L2 connection was disassociated unexpectedly.

The session was closed from the local side of the session.

Session timed out due to no response from the remote side of the session.

Session status is OK.

The session was closed from the remote side of the session.

A general system failure has occurred.

Describes a Wi-Fi Direct Service session request.

Gets device information for the requesting device.

Describes the requesting device.

Gets information about how provisioning should be performed if the session is established.

Provisioning information.

Gets the session information blob associated with this request.

A byte sequence, up to 144 bytes. The format is defined by the service.

Closes the session request. Your server code calls this method to reject a session request.

Returned when a WiFiDirectServiceAdvertiser.SessionRequested event is raised.

Gets information about the session request that raised a WiFiDirectServiceAdvertiser.SessionRequested event.

Information about a new session request.

Values used to describe the status of a Wi-Fi Direct Service Session.

The session has been closed.

The session has been initiated.

The session is open.

A session has been requested.

Values used to describe the service status.

The service is available.

The service is not currently accepting connections.

The service is returning service-defined custom status values. Get the status value from the WiFiDirectServiceAdvertiser.CustomServiceStatusCode property.

A class containing static helper methods for working with the **Guid** type.

Gets an empty, zeroed **Guid**.

A **Guid** value that is empty, and zeroed.

Creates a new, unique **Guid**.

A new, unique **Guid**.

Compares two **Guid** values for equality.

A **Guid** value to compare with the other argument. A **Guid** value to compare with the other argument. `true` if the two **Guid** values are equal, otherwise `false`.

Defines the implementation for a type that retrieves activation factories.

Retrieves the implementation of an activation factory.

The Activation ID (ACID) of the activatable type produced by the factory. An instance of an activation factory type. This type must implement IActivationFactory.

Represents a reference counted memory buffer.

Returns a new managed object that implements the IMemoryBufferReference interface.

A new managed object that implements the IMemoryBufferReference interface.

Represents a reference to an IMemoryBuffer object.

Gets the size of the memory buffer in bytes.

The size of the memory buffer in bytes.

Occurs when MemoryBuffer.Close has been called, but before this IMemoryBufferReference has been closed.

Represents a name-value pair in a URL query string.

Represents the name of a parameter in a URL query string.

The name of a query string parameter. The Value property represents the corresponding value.

Represents a named value in a URL query string.

The value of a query parameter that corresponds with the Name property.

Represents a reference counted memory buffer.

Initializes a new MemoryBuffer instance with the specified capacity.

The desired size of the new memory buffer.

Disconnects this MemoryBuffer object from the actual memory buffer.

Returns a new managed object that implements the IMemoryBufferReference interface.

A new managed object that implements the IMemoryBufferReference interface.

Defines an object that represents a Uniform Resource Identifier (URI) value and parses it into components. The Uri object is used by many other Windows Runtime APIs that are not necessarily confined to web browser scenarios.

Initializes a new Uri object from the specified Uniform Resource Identifier (URI) string. Initializing the Uri also parses the string and populates the Uri properties that represent Uniform Resource Identifier (URI) components.

The string from which the new Uri object is created.

Initializes a new Uri by combining a base Uniform Resource Identifier (URI) and a relative Uniform Resource Identifier (URI). Initializing the Uri also parses the combined string and populates the Uri properties that represent Uniform Resource Identifier (URI) components.

The base Uniform Resource Identifier (URI). The relative Uniform Resource Identifier (URI).

Gets a fully canonical RFC-compliant representation of the current URI.

The canonical URI.

Gets the entire, non-canonical URI (It is non-canonical because it might actually be an IRI, per the Windows.Foundation.Uri encoding behavior; see Remarks.).

The entire, non-canonical URI.

Gets the decoded unicode characters that make up the current URI.

The decoded unicode characters, when possible. Unsafe values are renamed as percent-encoded UTF-8. Characters in the hostname are decoded if they were encoded using*Punycode*.

Gets a representation of the Uniform Resource Identifier (URI) that can be used for display purposes.

The Uniform Resource Identifier (URI) for display.

Gets the domain name component, including top-level domain, from a Uniform Resource Identifier (URI).

The domain name.

Gets the file name extension of the resource that is referenced in the Uri.

The file name extension including the dot (.), if applicable.

Gets the text following a fragment marker (#), including the fragment marker itself.

The text that represents the fragment.

Gets the fully qualified domain name.

The fully qualified domain name.

Gets the password component of the Uniform Resource Identifier (URI) as stored in this Uri instance.

The password.

Gets the path and resource name component of the Uniform Resource Identifier (URI) as stored in this Uri instance.

The path, including the resource name, and including the extension. Does not include query or fragment.

Gets the port number component of the Uniform Resource Identifier (URI) as stored in this Uri instance

The port number.

Gets the query string component of the Uniform Resource Identifier (URI) as stored in this Uri instance.

The query string.

Gets a parsed Uniform Resource Identifier (URI) query string.

The parsed query, as a new WwwFormUrlDecoder object. This is a read-only list of all name-value pairs (the form entries) as found in the query string after parsing.

Gets the entire original Uniform Resource Identifier (URI) string as used to construct this Uri object, before parsing, and without any encoding applied.

The raw Uniform Resource Identifier (URI) string.

Gets the protocol scheme name component of the Uniform Resource Identifier (URI) as stored in this Uri instance

The protocol scheme name.

Gets a value that indicates whether parsing determined that the Uniform Resource Identifier (URI) is not well-formed.

**true** if the Uniform Resource Identifier (URI) is flagged as suspicious; otherwise, **false**.

Gets the user name component of the Uniform Resource Identifier (URI) as stored in this Uri instance.

The user name.

Adds the specified Uniform Resource Identifier (URI) to the current Uri.

A relative Uniform Resource Identifier (URI) specified as a string. This relative path is evaluated using the host/authority of the Uri instance where this method is called. The combined Uri value.

Determines whether the specified Uri object is equal to the current Uri object.

The Uri object to be compared. **true** if the two Uri values are the same; otherwise, **false**.

Converts a Uniform Resource Identifier (URI) string to its escaped representation.

The string to convert. The escaped representation of *toEscape*.

Gets a canonical string representation for the current Uri.

The unescaped canonical representation of the current Uri. All characters are unescaped, except #, ?, and %.

Converts the specified string by replacing any escape sequences with their unescaped representation.

The string to convert. The unescaped representation of *stringToUnescape*.

Parses a URL query string, and exposes the results as a read-only vector (list) of name-value pairs from the query string.

Creates and initializes a new instance of the WwwFormUrlDecoder class.

The URL to parse.

Gets the number of the name-value pairs in the current URL query string.

The number of the name-value pairs.

Gets an iterator that represents the first name-value pair in the current URL query string.

The first name-value pair.

Gets the name-value pair at the specified index in the current URL query string.

The index of the name-value pair. The name-value pair at the position specified by *index*.

Gets the first name-value pair that has the specified name, as obtained from the constructing Uniform Resource Identifier (URI) query string.

The name of the value to get. The first value in list order that corresponds with *name*.

Gets name-value pairs starting at the specified index in the current URL query string.

The index to start getting name-value pairs at. The name-value pairs. The number of name-value pairs in *items*.

Gets a value indicating whether the specified IWwwFormUrlDecoderEntry is at the specified index in the current URL query string.

The name-value pair to get the index of. The position in *value*. **true** if *value* is at the position specified by *index*; otherwise, **false**.

Represents a name-value pair in a URL query string. Use the IWwwFormUrlDecoderEntry interface instead; see Remarks.

Represents the name of a parameter in a URL query string. Use the IWwwFormUrlDecoderEntry interface version (IWwwFormUrlDecoderEntry.Name ) instead; see Remarks.

The name of a query string parameter. The Value property represents the corresponding value.

Represents a named value in a URL query string. Use the IWwwFormUrlDecoderEntry interface version (IWwwFormUrlDecoderEntry.Value ) instead; see Remarks.

The value of a query parameter that corresponds with the Name property.

Enables tracing control flow across asynchronous operations.

Raised when a client starts listening to the causality trace.

Indicates that a previously created asynchronous operation has completed all of its asynchronous work.

The trace level. The trace source. Identifier for the operation type. The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. The completion status of the asynchronous operation.

Logs the creation of an asynchronous operation.

The trace level. The trace source. Identifier for the operation type. An identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. A human-readable description of the asynchronous work. Additional information related to this operation.

Logs the relation between the currently running synchronous work item and a specific asynchronous operation that it's related to.

The trace level. The trace source. Identifier for the operation type. The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. The relationship between the synchronous work item and asynchronous operation identified by *operationId*.

Indicates that the most recently created synchronous work item running on the thread that the TraceSynchronousWorkCompletion method is called on has completed.

The trace level. The trace source. Indicates the type of completion.

Indicates that the specified asynchronous operation is scheduling synchronous work on the thread that the TraceSynchronousWorkStart method is called on.

The trace level. The trace source. Identifier for the operation type. The identifier for the asynchronous operation that's unique within the platform for the operation's lifetime. The relationship between the work item and the asynchronous operation.

Tracks ways that synchronous work items may interact with asynchronous operations.

Indicates that a synchronous work items has assigned a callback or continuation to be run by an asynchronous operation.

Indicates that a synchronous work item was canceled.

Indicates that a synchronous work item has satisfied a choice asynchronous operation.

Indicates that a synchronous work item caused an error in an asynchronous operation.

Indicates that a synchronous work item has satisfied part of a join asynchronous operation.

Provides flags that listeners use to filter tracing events.

Indicates causality information generated by app-defined asynchronous operations.

Indicates causality information generated by language projections or asynchronous infrastructure libraries.

Indicates causality information generated by Windows.

Indicates the relationship between a work item and an asynchronous operation.

The work item being scheduled is running due to the completion of the asynchronous operation.

The work item being scheduled is part of the actual work of the asynchronous operation, like opening a file.

The work item being scheduled is running due to reaching a milestone within the asynchronous operation.

Specifies a logging level that listeners can use for trace filtering.

Tracks operations that are not necessary to construct a causality chain but are interesting for developers.

Indicates all operations that are necessary to construct a causality chain, including all operations for job creation and completion and work item creation and completion.

Indicates operations that influence causality but are likely to be less interesting for developers, including actions like registering progress delegates.

Provides information about an error that occurred.

Gets a short description of the error.

A short description of the error.

Gets the address to a help page about the error.

The address to a help page about the error.

Gets a detailed description of the error.

A detailed description of the error.

Asynchronously creates an ErrorDetails object based on an **HRESULT** error code.

The unique code representing the error. The newly created ErrorDetails object representing the error.

Specifies the type of diagnostic error reporting for a thread.

Exceptions are reported.

No error reporting occurs for the thread.

Exceptions are suppressed and not reported.

Error information for SetErrorInfo is suppressed and not reported.

Error information for SetErrorInfo is used.

Represents the destination of logged messages from LoggingChannel instances.

Initializes a new instance of the FileLoggingSession class.

The name of the logging session.

Gets the name of the logging session.

The session name.

Raised when a log file is saved.

Adds a logging channel to the current logging session.

The logging channel to add.

Adds a logging channel to the current logging session. The logging channel only accepts events that have a logging level at or above the specified logging level.

The logging channel to add. The *minimum* logging level that an event must have to be accepted by the session.

Ends the current logging session.

Ends the current logging session and saves it to a file.

When this method completes, it returns the new file as a StorageFile. Returns **NULL** if there are no events in the session or if logging has just rolled over into a new file that doesn't contain events yet.

Removes the specified logging channel from the current logging session.

The logging channel to remove.

Represents diagnostic error reporting settings.

Gets the type of error reporting for the error object.

One of the enumeration values.

Sets the type of error reporting for the error object.

One of the enumeration values.

Represents the destination of logged messages from LoggingChannel instances.

Gets the name of the logging session.

The session name.

Raised when a log file is saved.

Adds a logging channel to the current logging session.

The logging channel to add.

Adds a logging channel with the specified logging level to the current logging session.

The logging channel to add. The logging level for *loggingChannel*.

Ends the current logging session and saves it to a file.

When this method completes, it returns the new file as a StorageFile.

Removes the specified logging channel from the current logging session.

The logging channel to remove.

Represents a source of log messages.

Gets a value that indicates whether messages are being logged on the current LoggingChannel.

**True** if messages are being logged on the current channel; otherwise, **false**.

Gets the level of detail for messages from the current LoggingChannel.

The level of detail for messages.

Gets the name of the current LoggingChannel.

The name.

Raised when the logging channel is attached to a LoggingSession or other event tracing and debugging tools.

Logs a message to the current LoggingChannel.

The message to log.

Logs a message to the current LoggingChannel with the specified LoggingLevel.

The message to log. The logging level.

Logs data to the current LoggingChannel.

The string to associate with *value2*. The value to associate with *value1*.

Logs data to the current LoggingChannel with the specified LoggingLevel.

The string to associate with *value2*. The value to associate with *value1*. The logging level.

Represents the destination of logged messages from LoggingChannel instances.

Gets the name of the logging session.

The session name.

Adds a logging channel to the current logging session.

The logging channel to add.

Adds a logging channel with the specified logging level to the current logging session.

The logging channel to add. The logging level for *loggingChannel*.

Removes the specified logging channel from the current logging session.

The logging channel to remove.

Save the current logging session to a file.

The folder to save the log file in. The name of the file. When this method completes, it returns the new file as a StorageFile.

Logs events.

Indicates whether at least one session is listening for events from the channel.

Returns **true** if at least one session is listening for events from the channel, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified event severity level from the channel.

The event severity level. Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified level and keywords from this channel.

The event severity level. The keywords. Each bit of the keywords value represents an event category. Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**.

Logs an event with the specified name.

The name for this event.

Logs an event with the specified name and fields.

The name for this event. The fields for this event. May be **null**.

Logs an event with the specified name, fields, and level.

The name for this event. The fields for this event. May be **null**. The level of detail for this event.

Logs an event with the specified name, fields, level, and options.

The name for this event. The fields for this event. May be **null**. The level of detail for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events.

Writes an activity start event and creates a **LoggingActivity** object.

The name for this event. An object that represents the new activity.

Writes an activity start event with fields and creates a **LoggingActivity** object.

The name for this event. The fields for this event. An object that represents the new activity.

Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object.

The name for this event. The fields for this event. May be **null **. The level of detail for this event. An object that represents the new activity.

Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object.

The name for this event. The fields for this event. May be **null**. The level of detail for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. An object that represents the new activity.

Provides data for the LogFileGenerated event.

Gets the log file.

The log file.

Creates Event Tracing for Windows (ETW) events that mark the start and end of a group of related events.

Initializes a new instance of the LoggingActivity class for the specified LoggingChannel in Windows 8.1 compatibility mode.

The name of the logging activity. The logging channel.

Initializes a new instance of the LoggingActivity class for the specified LoggingChannel and LoggingLevel in Windows 8.1 compatibility mode.

The name of the logging activity. The logging channel. The logging level.

Returns the channel associated with this activity.

The channel associated with this activity.

Gets the identifier for the current logging activity.

The identifier.

Gets the name of the current logging activity.

The name.

Ends the current logging activity.

Indicates whether at least one session is listening for events from the channel associated with this activity.

Returns **true** if at least one session is listening for events from the channel associated with this activity, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified event severity level from the channel associated with this activity.

The event severity level. Returns **true** if at least one session is listening for events with the specified level from the channel associated with this activity, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified level and keywords from the channel associated with this activity.

The event severity level. The keywords. Each bit of the keywords value represents an event category. Returns **true** if at least one session is listening for events with the specified level and keywords from the channel associated with this activity, and otherwise **false**.

Logs an event with the specified name.

The name for this event.

Logs an event with the specified name and fields.

The name for this event. The fields for this event. May be **null**.

Logs an event with the specified name, fields, and level.

The name for this event. The fields for this event. May be **null**. The severity level for this event.

Logs an event with the specified name, fields, level, and options.

The name for this event. The fields for this event. May be **null**. The severity level for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events.

Writes an activity start event and creates a **LoggingActivity** object.

The name for the start event. An object the represents the new activity.

Writes an activity start event with fields and creates a **LoggingActivity** object.

The name for the start event. The fields for this event. An object that represents the new activity.

Writes an activity start event with the specified fields and level and creates a **LoggingActivity** object.

The name for the start event. The fields for this event. May be **null **. The level of detail for this event. An object that represents the new activity.

Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object.

The name for this event. The fields for this event. May be **null**. The level of detail for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. An object that represents the new activity.

Marks the activity as closed/disposed and generates a stop event with the specified event name.

The name for the stop event.

Marks the activity as closed/disposed and generates a stop event with the specified event name and fields.

The name for this event. The fields for this event. May be **null**.

Marks the activity as closed/disposed and generates a stop event with the specified event name, fields, and options.

The name for the stop event. The fields for this event. May be **null**. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events.

Represents a source of log messages.

This constructor creates a **LoggingChannel** in Windows 8.1 compatibility mode.

This constructor creates a LoggingChannel in Windows 8.1 compatibility mode. Prefer the two-parameter constructor. The name of the logging channel.

Initializes a new instance of the LoggingChannel class with the specified options.

The name of the logging channel. The channel options. Pass **null** to specify the default options.

Initializes a new instance of the LoggingChannel class with the specified options and channel ID.

The name of the logging channel. The channel options. Pass **null** to specify the default options. The channel identifier to use instead of the automatically generated identifier.

Gets a value that indicates whether at least one session is logging events from this channel.

Returns **true** if at least one session is listening for events from the channel, and otherwise **false**.

Returns the provider identifier for this channel.

The provider identifier for this channel.

Gets the minimum level at which any session is listening to events from this channel.

The event level required for the session to listen to an event from this channel.

Gets the name of the current LoggingChannel.

The name.

Raised when the logging channel is attached to a LoggingSession or other event tracing and debugging tools.

Ends logging on the current logging channel.

Indicates whether at least one session is listening for events from the channel.

Returns **true** if at least one session is listening for events from the channel, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified event severity level from the channel.

The event severity level. Returns **true** if at least one session is listening for events with the specified level from the channel, and otherwise **false**.

Indicates whether at least one session is listening for events with the specified level and keywords from this channel.

The event severity level. The keywords. Each bit of the keywords value represents an event category. Returns **true** if at least one session is listening for events with the specified level and keywords from the channel, and otherwise **false**.

Logs an event with the specified name.

The name for this event.

Logs an event with the specified name and fields.

The name for this event. The fields for this event. May be **null**.

Logs an event with the specified name, fields, and level.

The name for this event. The fields for this event. May be **null**. The level of detail for this event.

Logs an event with the specified name, fields, level, and options.

The name for this event. The fields for this event. May be **null**. The level of detail for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events.

Logs a message to the current LoggingChannel.

The message to log.

Logs a message to the current LoggingChannel with the specified LoggingLevel.

The message to log. The logging level.

Logs data to the current LoggingChannel.

The string to associate with *value2*. The value to associate with *value1*.

Logs data to the current LoggingChannel with the specified LoggingLevel.

The string to associate with *value2*. The value to associate with *value1*. The logging level.

Writes an activity start event and creates a **LoggingActivity** object.

The name for this event. Returns an object that represents the new activity.

Writes an activity start event with the specified fields and creates a **LoggingActivity** object.

The name for this event. The fields for this event. Returns an object that represents the new activity.

Writes an activity start event with the specified fields and level, and creates a **LoggingActivity** object.

The name for this event. The fields for this event. May be **null **. The level of detail for this event. Returns an object that represents the new activity.

Writes an activity start event with the specified fields, level, and options, and creates a **LoggingActivity** object.

The name for this event. The fields for this event. May be **null**. The level of detail for this event. The options for this event. Pass **null** to use the default options. The options are for advanced scenarios. The default values are designed to work well for most events. Returns an object that represents the new activity.

Represents advanced settings that you can use to configure a LoggingChannel object.

Creates a LoggingChannelOptions object with all options set to default values.

Creates a LoggingChannelOptions object with all properties set to default values except for the specified group.

The group identifier.

Gets or sets the channel group identifier.

The group identifier.

Specifies the format of an event field.

A boolean field.

No format is specified.

A 64-bit FILETIME value.

A hexadecimal field.

The field is hidden.

A 32-bit Windows **HRESULT** value.

An Internet Protocol version 4 (IPv4) field.

An Internet Protocol version 6 (IPv6) field.

A JavaScript Object Notation (JSON) field.

A 32-bit Windows **NTSTATUS** value.

A port number field.

A process identifier field.

A signed value.

A socket address field.

The field contains a MBCS (8-bit character) string.

A thread identifier field.

An unsigned value.

A 32-bit **Win32** error code.

An Extensible Markup Language (XML) field.

Represents a sequence of event fields and provides methods for adding fields to the sequence.

Initializes a new **LoggingFields** instance.

Adds a boolean field with the specified field name.

Name of the event field. Value of the event field.

Adds a boolean field with the specified field name and format.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a boolean field with the specified field name, format, and tags.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a boolean array field with the specified field name.

The name of the event field. The array values for the event field.

Adds a boolean array field with the specified field name and format.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a boolean array field with the specified field name, format, and tag.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 16-bit character field with the specified field name.

The name of the event field. The value of the event field.

Adds a 16-bit character field with the specified field name and format.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit character field with the specified field name, format, and tag.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 16-bit character array field with the specified field name.

The name of the event field. The array of values for the event field.

Adds a 16-bit character array field with the specified field name and format.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit character array field with the specified field name and format, and tags.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a DateTime field with the specified field name.

The name of the event field. The value of the event field.

Adds a DateTime field with the specified field name and format.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a DateTime field with the specified field name, format, and tags.

The name of the event field. The value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a DateTime array field with the specified field name.

The name of the event field. The array of values for the event field.

Adds a DateTime array field with the specified field name and format.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a DateTime array field with the specified field name, format, and tags.

The name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Double field with the specified field name.

Name of the event field. Value of the event field.

Adds a Double field with the specified field name and format.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Double field with the specified field name, format, and tags.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Double array field with the specified field name.

Name of the event field. The array of values for the event field.

Adds a Double array field with the specified field name and format.

Name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Double array field with the specified field name, format, and tags.

Name of the event field. The array of values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds an empty field.

Name of the event field.

Adds an empty field.

Name of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds an empty field.

Name of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a GUID field with the specified field name.

Name of the event field. Value of the event field.

Adds a GUID field with the specified field name and format.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a GUID field with the specified field name, format, and tags.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a GUID array field with the specified field name.

Name of the event field. The array values for the event field.

Adds a GUID array field with the specified field name and format

Name of the event field. The array values for the event field. The format of the event field.

Adds a GUID array field with the specified field name, format, and tags.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 16-bit integer field with the specified field name.

Name of the event field. Value of the event field.

Adds a 16-bit integer field with the specified field name and format.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit integer field with the specified field name, format, and tags.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 16-bit integer array field with the specified field name.

Name of the event field. Value of the event field.

Adds a 16-bit integer array field with the specified field name and format.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit integer array field with the specified field name, format, and tags.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 32-bit integer array field with the specified field name.

Name of the event field. Value of the event field.

Adds a 32-bit integer array field with the specified field name and format.

Name of the event field. Value of the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 32-bit integer array field with the specified field name, format, and tags.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 32-bit integer array field with the specified field name.

Name of the event field. The array values for the event field.

Adds a 32-bit integer array field with the specified field name and format.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 32-bit integer array field with the specified field name, format, and tags.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 64-bit integer array field with the specified field name.

Name of the event field. The array values for the event field.

Adds a 64-bit integer array field with the specified field name and format.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 64-bit integer field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 64-bit integer array field with the specified field name.

Name of the event field. The array values for the event field.

Adds a 64-bit integer array field with the specified field name and format.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 64-bit integer array field with the specified field name, format, and tags.

Name of the event field. The array values for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Point field with the specified name.

Name of the event field. The value for the event field.

Adds a Point field with the specified name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Point field with the specified name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Point array field with the specified field name.

Name of the event field. The value for the event field.

Adds a Point array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Point array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Rect field with the specified field name.

Name of the event field. The value for the event field.

Adds a Rect field with the specified field name, and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Rect field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Rect array field with the specified field name.

Name of the event field. The value for the event field.

Adds a Rect array field with the specified field name and format.

Name of the event field. The value for the event field. The value for the event field.

Adds a Rect array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Single field with the specified field name.

Name of the event field. The value for the event field.

Adds a Single field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Single field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Single array field with the specified field name.

Name of the event field. The value for the event field.

Adds a Single array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Single array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Size field with the specified field name.

Name of the event field. The value for the event field.

Adds a Size field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Size field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a Size array field with the specified field name.

The name of the field. The value for the event field.

Adds a Size array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a Size array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a String field with the specified field name.

Name of the event field. The value for the event field.

Adds a String field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a String field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a String array field with the specified field name.

Name of the event field. The value for the event field.

Adds a String array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a String array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a time span field with the specified field name.

Name of the event field. The value for the event field.

Adds a time span field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a time span field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a time span array field with the specified field name.

Name of the event field. The value for the event field.

Adds a time span array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a time span array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 16-bit unsigned integer field with the specified field name.

Name of the event field. The value for the event field.

Adds a 16-bit unsigned integer field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit unsigned integer field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a16-bit unsigned integer field with the specified field name.

Name of the event field. The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified.

Adds a 16-bit unsigned integer array field with the specified field name and format.

Name of the event field. The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 16-bit unsigned integer array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 32-bit unsigned integer field with the specified field name.

Name of the event field. The value for the event field.

Adds a 32-bit unsigned integer field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 32-bit unsigned integer field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 32-bit unsigned integer array field with the specified field name.

Name of the event field. The value for the event field.

Adds a 32-bit unsigned integer array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 32-bit unsigned integer array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 64-bit unsigned integer field with the specified field name.

Name of the event field. The value for the event field.

Adds a 64-bit unsigned integer field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 64-bit unsigned integer field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds a 64-bit unsigned integer array field with the specified field name.

Name of the event field. The value for the event field.

Adds a 64-bit unsigned integer array field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds a 64-bit unsigned integer array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds an 8-bit unsigned integer field with the specified field name.

Name of the event field. The value for the event field.

Adds an 8-bit unsigned integer field with the specified field name and format.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds an 8-bit unsigned integer field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Adds an 8-bit unsigned integer array field with the specified field name.

Name of the event field. The value for the event field. The format for the array is binary.

Adds an 8-bit unsigned integer array field with the specified field name and format.

Name of the event field. The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools.

Adds an 8-bit unsigned integer array field with the specified field name, format, and tags.

Name of the event field. The value for the event field. The default format for the array is binary. See the remarks section for other formats that may be specified. The format of the event field. Specifies an optional formatting hint that may be used by Event Tracing for Windows (ETW) tools. The user-defined tag for the event field. Specifies up to twenty-eight bits of user-defined field processing metadata for use by a custom ETW processing tool. The top four bits are reserved and must be set to zero (0).

Begins a new structured field with the specified field name.

Name of the structured field.

Begins a new structured field with the specified field name and tags.

Name of the structured field. Specifies up to twenty-eight bits of user-defined field metadata. The top four bits are reserved and must be set to zero (0).The metadata may be used by a custom Event Tracing for Windows (ETW) processing tool. For example, you might define a tag that indicates that a field might contain personally-identifiable information.

Removes all fields stored in the object and resets the object to its newly-constructed state.

Ends a structured field.

Specifies the severity level of an event.

Log only critical messages.

Log messages of error level and higher.

Log messages of information level and higher.

Log all messages.

Log messages of warning level and higher.

Specifies an event opcode. Opcodes represent an operation within a component of an application and are used to logically group events.

An informational event.

A reply event.

An event that represents an activity resuming after being suspended.

An event that represents transferring activity to another component.

An event that represents the start of an activity.

An event that represents the end of an activity. The event corresponds to the last unpaired **Start** event.

An event that represents the activity being suspended pending another activity's completion.

Represents advanced event settings.

Initializes a new **LoggingOptions** instance with default option values.

Initializes a new **LoggingOptions** instance with the specified keyword value.

The keyword value.

Gets or sets the unique identifier associated with an activity.

The activity unique identifier.

Gets or sets the keyword value that represents the different categories that an event belongs to.

The keyword value.

Gets or sets the operation code value for an event.

The operation code.

Gets or sets a value that uniquely identifies the parent activity to which this activity is related.

A value that uniquely identifies the parent activity to which this activity is related.

Gets or sets the user-defined metadata value attached to an event.

The tag.

Gets or sets the user-defined value that identifies a larger unit of work within an application or component.

The task value.

Represents the destination of logged messages from LoggingChannel instances.

Initializes a new instance of the LoggingSession class.

The name of the logging session.

Gets the name of the logging session.

The session name.

Adds a logging channel to the current logging session.

The logging channel to add.

Adds a logging channel with the specified logging level to the current logging session.

The logging channel to add. The logging level for *loggingChannel*.

Ends the current logging session.

Removes the specified logging channel from the current logging session.

The logging channel to remove.

Saves the current logging session to a file.

The folder that contains the log file. The name of the log file. When this method completes, it returns the new file as a StorageFile.

Represents diagnostic error reporting settings.

Creates and initializes a new instance of the RuntimeBrokerErrorSettings.

Gets the type of error reporting for the error object.

One of the enumeration values.

Sets the type of error reporting for the error object.

One of the enumeration values.

Provides data for the TracingStatusChanged event.

Gets a value that indicates whether tracing is active.

**True**, if tracing is active, otherwise **false**.

Gets the trace level for the current tracing session.

The trace level.

Create from string attribute.

Create from string attribute.

Describes a 3*2 floating point matrix.

The row one and column one element of the matrix.

The row one and column two element of the matrix.

The row two and column one element of the matrix.

The row two and column two element of the matrix.

The row three and column one element of the matrix.

The row three and column two element of the matrix.

Describes a 4*4 floating point matrix.

The row one and column one element of the matrix.

The row one and column two element of the matrix.

The row one and column three element of the matrix.

The row one and column four element of the matrix.

The row two and column one element of the matrix.

The row two and column two element of the matrix.

The row two and column three element of the matrix.

The row two and column four element of the matrix.

The row three and column one element of the matrix.

The row three and column two element of the matrix.

The row three and column three element of the matrix.

The row three and column four element of the matrix.

The row four and column one element of the matrix.

The row four and column two element of the matrix.

The row four and column three element of the matrix.

The row four and column four element of the matrix.

Describes a plane (a flat, two-dimensional surface).

A floating-point value for a point on the plane but not on the **Normal** vector.

A vector of three floating-point components on the plane.

Describes a quaternion, which is an abstract representation of an orientation in space that is based on complex numbers.

The *w* component of the quaternion, which is the real number part of the quaternion.

The *x* component of the quaternion, which is the coefficient of the **i** unit vector in the quaternion.

The *y* component of the quaternion, which is the coefficient of the **j** unit vector in the quaternion.

The *z* component of the quaternion, which is the coefficient of the **k** unit vector in the quaternion.

Describes a number that can be created by the division of 2 integers.

The number below the line in a fraction.

The number above the line in a fraction.

Describes a vector of two floating-point components.

The x component of the vector.

The y component of the vector.

Describes a vector of three floating-point components.

The x component of the vector.

The y component of the vector.

The z component of the vector.

Describes a vector of four floating-point components.

The w component of the vector.

The x component of the vector.

The y component of the vector.

The z component of the vector.

Represents an arcade stick.

The list of all connected arcade sticks.

The list of all connected arcade sticks.

The audio headset attached to the arcade stick.

The audio headset attached to the arcade stick.

Gets a value that indicates the wireless state of the arcade stick.

True if the arcade stick is wireless. Otherwise, false.

The user associated with the arcade stick.

The user associated with the arcade stick.

Signals when a new arcade stick is connected.

Signals when an arcade stick is disconnected.

Signals when a headset is attached to the arcade stick.

Signals when a headset is disconnected from the arcade stick.

Signals when the user associated with the arcade stick has changed.

Returns the given game controller as an arcade stick.

The game controller to be returned as an arcade stick. The arcade stick that was returned from the given game controller.

Retrieves the button label for the specified button.

The button for which to retrieve the label. Returns the label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned.

Gets a snapshot of the arcade stick state.

The current state of the arcade stick.

Gets information about the arcade stick's current battery state.

Information about the arcade stick's current battery state.

Specifies the button type for an arcade stick.

The first action button.

The second action button.

The third action button.

The fourth action button.

The fifth action button.

The sixth action button.

No button.

The first special button.

The second special button.

The stick is pressed down.

The stick is pressed left.

The stick is pressed right.

The stick is pressed up.

The current state of the arcade stick.

The state of the arcade stick's buttons.

Time when the state was retrieved from the arcade stick.

Represents a flight stick.

The list of all connected flight sticks.

The list of all connected flight sticks.

The type of hat switch on the flight stick.

The type of hat switch on the flight stick.

The audio headset attached to the flight stick.

The audio headset attached to the flight stick.

Gets a value that indicates the wireless state of the flight stick.

True if the flight stick is wireless. Otherwise, false.

The user associated with the flight stick.

The user associated with the flight stick.

Signals when a new flight stick is connected.

Signals when a flight stick is disconnected.

Signals when a headset is attached to the flight stick.

Signals when a headset is disconnected from the flight stick.

Signals when the user associated with the flight stick has changed.

Returns the given game controller as a flight stick.

The game controller to be returned as a flight stick. The flight stick that was returned from the given game controller.

Retrieves the button label for the specified button.

The button for which to retrieve the label. The label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned.

Gets a snapshot of the flight stick state.

The current state of the flight stick.

Gets information about the flight stick's current battery state.

Information about the flight stick's current battery state.

Specifies the type of flight stick button.

The primary fire button.

The secondary fire button.

No button.

The current state of the flight stick.

The button currently being pressed.

The position of the hat switch.

The amount of pitch (rotation around the X-axis; forward and backward movement on the flight stick).

The amount of roll (rotation around the Z-axis; left and right movement on the flight stick).

The position of the throttle.

The time that the reading was reported from the hardware.

The amount of yaw (rotation around the Y-axis; usually read from twisting the joystick or from some other input).

Label that appears on the physical controller button.

Back button.

Circle button.

Cross button.

Dial left.

Dial right.

Down button.

Down left arrow.

Left button.

Left 1.

Left 2.

Left 3.

Left bumper.

Left stick button.

Left trigger.

Letter A.

Letter B.

Letter C.

Letter L.

Letter R.

Letter X.

Letter Y.

Letter Z.

Menu button.

Minus.

Mode button.

No button.

Options button.

Paddle 1.

Paddle 2.

Paddle 3.

Paddle 4.

Plus.

Right button.

Right 1.

Right 2.

Right 3.

Right bumper.

Right stick button.

Right trigger.

Select button.

Share button.

Square button.

Start button.

Suspension.

Triangle button.

Up button.

View button.

A button.

B button.

Back button.

Down button.

Left button.

Left bumper.

Left stick button.

Left trigger.

Menu button.

Paddle 1.

Paddle 2.

Paddle 3.

Paddle 4.

Right button.

Right bumper.

Right stick button.

Right trigger.

Start button.

Up button.

View button.

X button.

Y button.

The type of switch on the game controller.

An eight-way switch, which has all positions in the **GameControllerSwitchPosition** enumeration.

A four-way switch, which has **Up**, **Down**, **Left**, **Right**, and **Center** positions.

A two-way switch, which has **Up**, **Down**, and **Center** positions.

The position of the game controller's switch.

The center position.

The bottom position.

The bottom left position.

The bottom right position.

The left position.

The right position.

The top position.

The top-left position.

The top-right position.

Represents a gamepad.

The list of all connected gamepads.

The list of all connected gamepads.

The audio headset attached to the gamepad.

The audio headset attached to the gamepad.

Gets a value that indicates the wireless state of the gamepad.

True if the gamepad is wireless. Otherwise, false.

The user associated with the gamepad.

The user associated with the gamepad.

Describes the gamepad motor speed.

Describes the gamepad motor speed.

Signals when a new gamepad is connected.

Signals when a gamepad is disconnected.

Signals when a headset is attached to the gamepad.

Signals when a headset is disconnected from the gamepad.

Signals when the user associated with the gamepad has changed.

Returns the given game controller as a gamepad.

The game controller to be returned as a gamepad. The gamepad that was returned from the given game controller.

Retrieves the button label for the specified button.

The button for which to retrieve the label. The label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned.

Gets a snapshot of the gamepad state.

The current state of the gamepad.

Gets information about the gamepad's current battery state.

Information about the gamepad's current battery state.

Specifies the button type.

A button.

B button.

D-pad down.

D-pad left.

D-pad right.

D-pad up.

Left bumper.

Left stick.

Menu button.

No button.

The first paddle.

The second paddle.

The third paddle.

The fourth paddle.

Right bumper.

Right stick.

View button.

X button.

Y button.

Represents the current state of the gamepad.

The state of the gamepad's buttons. This will be a combination of values in the GamepadButtons enumeration.

The position of the left thumbstick on the X-axis. The value is between -1.0 and 1.0.

The position of the left thumbstick on the Y-axis. The value is between -1.0 and 1.0.

The position of the left trigger. The value is between 0.0 (not depressed) and 1.0 (fully depressed).

The position of the right thumbstick on the X-axis. The value is between -1.0 and 1.0.

The position of the right thumbstick on the Y-axis. The value is between -1.0 and 1.0.

The position of the right trigger. The value is between 0.0 (not depressed) and 1.0 (fully depressed).

Time when the state was retrieved from the gamepad.

Describes the speed of the gamepad's four available vibration motors.

The level of the left vibration motor. Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration.

The left trigger vibration level. Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration.

The level of the right vibration motor. Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration.

The right trigger vibration level. Valid values are between 0.0 and 1.0, where 0.0 signifies no motor use and 1.0 signifies max vibration.

Contains information about an audio headset attached to a gamepad.

The XAudio endpoint ID for the headset's audio capture device.

The XAudio endpoint ID for the headset's audio capture device.

The XAudio enpoint ID for the headset's audio render device.

The XAudio enpoint ID for the headset's audio render device.

Gets information about the headset's current battery state.

Information about the headset's current battery state.

The core interface required to be implemented by all controller devices, regardless of their actual type (gamepad, racing wheel, flight stick, and so on). This interface exists mainly to support extensibility for game controllers, which allows OEMs (Original Equipment Manufacturers) to publish WinRT (Windows Runtime) classes that provide rich access to their device's features, while integrating into the underlying game controller device enumeration framework.

The audio headset attached to the controller.

The audio headset attached to the controller.

Gets a value that indicates the wireless state of the gamepad.

True if the gamepad is wireless. Otherwise, false.

The user associated with the controller.

The user associated with the controller.

Signals when a headset is attached to the controller.

Signals when a headset is disconnected from the controller.

Signals when the user associated with the controller has changed.

Interface that allows game controller (or headset) classes to query for information about the current battery state, regardless of their actual type (gamepad, racing wheel, flight stick, and so on).

Gets information about the game controller's current battery state.

Information about the game controller's current battery state.

Specifies additional buttons that may be available on a controller that appears as a navigation controller.

Context1 button.

Context2 button.

Context3 button.

Context4 button.

No buttons.

Page down button.

Page left button.

Page right button.

Page up button.

Scroll down button.

Scroll left button.

Scroll right button.

Scroll up button.

Represents a racing wheel.

Boolean indicating whether the racing wheel has a clutch.

Boolean indicating whether the racing wheel has a clutch.

Boolean indicating whether the racing wheel has a handbrake.

Boolean indicating whether the racing wheel has a handbrake.

Boolean indicating whether the racing wheel has a pattern shifter.

Boolean indicating whether the racing wheel has a pattern shifter.

The audio headset attached to the racing wheel.

The audio headset attached to the racing wheel.

Gets a value that indicates the wireless state of the racing wheel.

True if the gamepad is wireless. Otherwise, false.

The highest gear of the shifter.

The highest gear of the shifter.

The maximum angle, in degrees, of the racing wheel.

The maximum angle, in degrees, of the racing wheel.

The list of all connected racing wheels.

The list of all connected racing wheels.

The user associated with the racing wheel.

The user associated with the racing wheel.

The force feedback motor for the racing wheel.

The force feedback motor for the racing wheel. If the controller does not support force feedback, this property will be **null**.

Signals when a headset is attached to the racing wheel.

Signals when a headset is disconnected from the racing wheel.

Signals when a new racing wheel is connected.

Signals when a racing wheel is disconnected.

Signals when the user associated with the racing wheel has changed.

Returns the given game controller as a racing wheel.

The game controller to be returned as a racing wheel. The racing wheel that was returned from the given game controller.

Retrieves the button label for the specified button.

The button for which to retrieve the label. Returns the button label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned.

Gets a snapshot of the racing wheel's state.

The current state of the racing wheel.

Gets information about the racing wheel's current battery state.

Information about the racing wheel's current battery state.

Specifies the racing wheel button type.

Button 1.

Button 10.

Button 11.

Button 12.

Button 13.

Button 14.

Button 15.

Button 16.

Button 2.

Button 3.

Button 4.

Button 5.

Button 6.

Button 7.

Button 8.

Button 9.

D-pad down.

D-pad left.

D-pad right.

D-pad up.

Gear shifted up.

No button.

Gear shifted down.

Represents the current state of the racing wheel.

The position of the brake.

The state of the racing wheel buttons.

The position of the clutch.

The position of the handbrake.

The gear the pattern shifter is in.

The position of the throttle.

Time when the state was retrieved from the racing wheel.

The angle of the wheel.

Represents any type of game controller.

The number of axes on the raw game controller.

The number of axes on the raw game controller.

The number of buttons on the raw game controller.

The number of buttons on the raw game controller.

The name of the controller, provided by the hardware.

The name of the controller, provided by the hardware.

The list of force feedback motors in the raw game controller.

The list of force feedback motors in the raw game controller.

The hardware product ID of the raw game controller.

The hardware product ID of the raw game controller.

The hardware vendor ID of the raw game controller.

The hardware vendor ID of the raw game controller.

The audio headset attached to the raw game controller.

The audio headset attached to the raw game controller.

Gets a value that indicates the wireless state of the raw game controller.

True if the raw game controller is wireless. Otherwise, false.

A unique ID that identifies the controller. As long as the controller is connected, the ID will never change.

A unique ID that identifies the controller. As long as the controller is connected, the ID will never change.

The list of all connected raw game controllers.

The list of all connected raw game controllers.

A collection of SimpleHapticsController objects representing all available haptic feedback motors available on the device.

A collection of SimpleHapticsController objects representing all available haptic feedback motors available on the device.

The number of switches on the raw game controller.

The number of switches on the raw game controller.

The user associated with the raw game controller.

The user associated with the raw game controller.

Signals when a headset is attached to the raw game controller.

Signals when a headset is disconnected from the raw game controller.

Signals when a new raw game controller is connected.

Signals when a raw game controller is disconnected.

Signals when the user associated with the raw game controller has changed.

Returns the given game controller as a raw game controller.

The game controller to be returned as a raw game controller. The raw game controller that was returned from the given game controller.

Retrieves the button label for the specified button.

The button for which to retrieve the label. The label for the specified button. If the button label is blank or there is no known label for the controller’s button, then **None** is returned.

Gets a snapshot of the raw game controller's state.

The button array for the raw game controller to be populated with the current state of each button. The switch array for the raw game controller to be populated with the current state of each switch. The axis array for the raw game controller to be populated with the current state of each axis. The timestamp of when the reading was retrieved from the raw game controller.

Gets the type of the specified switch on the raw game controller.

The index in the raw game controller's switch array of the switch whose type you are querying. The type of the given switch on the raw game controller.

Gets information about the raw game controller's current battery state.

Information about the raw game controller's current battery state.

Specifies the buttons that are required to be available on a controller that appears as a navigation controller.

Accept button is required.

Cancel button is required.

Down button is required.

Left button is required.

Menu button is required.

No required buttons.

Right button is required.

Up button is required.

View button is required.

Represents a controller of any type that can be used for UI navigation. Most gamepads, arcade sticks, and racing wheels can also be accessed as a **UINavigationController**. It is recommended that games use the controller-specific class during gameplay and the **UINavigationController** class for UI menus.

The audio headset attached to the UI navigation controller.

The audio headset attached to the UI navigation controller.

Gets a value that indicates the wireless state of the UI navigation controller.

True if the UI navigation controller is wireless. Otherwise, false.

The list of all connected UI navigation controllers.

The list of all connected UI navigation controllers.

The user associated with the UI navigation controller.

The user associated with the UI navigation controller.

Signals when a headset is attached to the UI navigation controller.

Signals when a headset is disconnected from the UI navigation controller.

Signals when a new UI navigation controller is connected.

Signals when a UI navigation controller is disconnected.

Signals when the user associated with the UI navigation controller has changed.

Returns the given game controller as a UI navigation controller.

The game controller to be returned as a UI navigation controller. The UI navigation controller that was returned from the given game controller.

Gets a snapshot of the UI navigation controller's state.

The state of the UI navigation controller.

Retrieves a label for an optional UI navigation button.

Enumeration indicating the UI navigation button whose label to retrieve. The label of the specified button.

Retrieves a label for a required UI navigation button.

Enumeration indicating the UI navigation button whose label to retrieve. The label of the specified button.

Gets information about the UI navigation controller's current battery state.

Information about the UI navigation controller's current battery state.

Represents the current state of the UI navigation controller.

The state of the optional UI navigation controller buttons.

The state of the required UI navigation controller buttons.

Time when the state was retrieved from the UI navigation controller.

Manages factories for custom controllers.

Registers a factory for a custom Gip controller.

The factory to register. The interface ID of the factory.

Registers a factory for a custom hardware ID controller.

The factory to register. The hardware vendor ID. The hardware product ID.

Registers a factory for a Xusb type controller.

The factory to register. The Xusb device type. The Xusb device subtype.

Tries to get a game controller that belongs to the specified factory and references the same underlying game controller as the one that was specified.

The factory for the type of game controller that you want to get. The game controller that references the underlying device for which you want to get another game controller representation. If found, a game controller that belongs to the specified factory and references the same underlying device as the specified game controller; otherwise, **null**.

Contains information on the game controller version.

Build number.

Major version number.

Minor version number.

Revison number.

Indicates the progress of a firmware update operation.

The ID of the current component being updated.

Percentage of the operation that is complete.

The result of an update operation.

The extended error code for the update operation.

The extended error code for the update operation.

The ID of the final updated component.

The ID of the final updated component.

Indicates the status of the firmware update operation.

Indicates the status of the firmware update operation.

Indicates the state of a firmware update operation.

The update is complete.

The update failed.

The firmware is already up to date.

Represents a physical game controller connected to the system using GIP.SYS (for Xbox One accesories).

The firmware version of the controller.

The firmware version of the controller.

The hardware product ID of the controller.

The hardware product ID of the controller.

The hardware vendor ID of the controller.

The hardware vendor ID of the controller.

Contains information on the hardware version of the controller.

Contains information on the hardware version of the controller.

Boolean value indicating whether the controller is connected.

Boolean value indicating whether the controller is connected.

Sends a message.

The class of the message. The ID of the message. A buffer holding the message contents.

Sends a request for a message.

The class of the message. The ID of the message. A buffer containing the request. A buffer that will contain the request response.

Attempts to asynchronously update the firmware for the controller.

A stream pointing to the firmware image with which to update the controller. Returns the result of the asynchronous operation.

The class of a Gip message.

A command message.

A low latency message.

A standard latency message.

Represents the underlying device for a HID (Human Interface Device) game controller.

The firmware version of the controller.

The firmware version of the controller.

The hardware product ID of the controller.

The hardware product ID of the controller.

The hardware vendor ID of the controller.

The hardware vendor ID of the controller.

Contains information on the hardware version of the controller.

Contains information on the hardware version of the controller.

Boolean value indicating whether the controller is connected.

Boolean value indicating whether the controller is connected.

The usage ID of the top-level collection.

The usage ID of the top-level collection.

The usage page of the top-level collection.

The usage page of the top-level collection.

Gets the specified HID (Human Interface Device) feature report from the controller.

The ID of the report to get. The buffer in which the report data is returned.

Sends the specified HID (Human Interface Device) feature report to the device.

The ID of the report to send. The buffer containing the report data to send.

Sends the specified HID (Human Interface Device) output report to the device.

The ID of the report to send. The buffer containing the report data to send.

Represents a factory for creating a custom controller type.

Creates an instance of a game controller.

The controller provider for the controller. The created object.

Event raised when the controller is added.

The added controller.

Event raised when the controller is removed.

The removed controller.

Base interface that defines the interfaces necessary to write a custom game controller class.

Event raised when input for the controller is resumed.

Timestamp for the event.

Event raised when input for the controller is suspended.

Timestamp of the event.

Base interface that represents the physical game controller devices connected to the system.

Contains information on the firmware version of the controller.

Information on the firmware version of the controller.

The hardware product ID of the controller.

The hardware product ID of the controller.

The hardware vendor ID of the controller.

The hardware vendor ID of the controller.

Contains information on the hardware version.

Information on the hardware version.

Boolean value indicating whether the controller is connected.

Boolean value indicating whether the controller is connected.

Defines the methods necessary for a custom Gip controller interface.

Event raised when a key is received.

Timestamp for the event. The key code for the button that raised the event. Boolean indicating whether the key is pressed or released.

Event raised when a message is received.

Timestamp of the event. The class of the message. The ID of the message. Sequence ID of the message. Buffer containing the message.

Defines the methods necessary for a custom HID (Human Interface Device) controller interface.

Event raised when input is received.

Timestamp of the event. The ID of the report. Buffer containing the received input.

Defines the methods necessary for a custom Xusb controller interface.

Event raised when input is received.

Timestamp of the event. ID of the report. Buffer containing the received input.

The device subtype of the controller.

The device subtype is arcadepad.

The device subtype is arcadestick.

The device subtype is dancepad.

The device subtype is drumkit.

The device subtype is flightstick.

The device subtype is gamepad.

The device subtype is guitar.

The device subtype is guitaralternate.

The device subtype is guitarbass.

The device subtype is unknown.

The device subtype is wheel.

The device type of the controller.

The controller device type is gamepad.

The controller device type is unknown.

Represents the physical game controller devices connected to the system using XUSB22.SYS (for Xbox 360 accessories).

The firmware version of the controller.

The firmware version of the controller.

The hardware product ID of the controller.

The hardware product ID of the controller.

The hardware vendor ID of the controller.

The hardware vendor ID of the controller.

Contains information on the hardware version of the controller.

Information on the hardware version of the controller.

Boolean indicating whether the controller is connected.

Boolean indicating whether the controller is connected.

Sets the speed on the controller's vibration motor.

The low frequency motor speed. The high frequency motor speed.

Conditional force effects are forces applied in response to current sensor values within the device. In other words, conditional force effects require information about device motion, such as position or velocity of a joystick handle. In general, conditional force effects are not associated with individual events during a game or other application. A conditional force effect does not have a predefined magnitude.

Creates an instance of ConditionForceEffect.

The type of effect to create.

Specifies the percentage by which to reduce the force of the effect.

Specifies the percentage by which to reduce the force of the effect.

The type of force feedback effect.

The type of force feedback effect.

The current state of the effect.

The current state of the effect.

Sets the parameters for the conditional force feedback effect.

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. The slope of the line describing how rapidly the force increases as the input moves away from the center point in the positive direction along the specified axis. Range is from -infinity to +infinity. The slope of the line describing how rapidly the force increases as the input moves away from the center point in the negative direction along the specified axis. Range is from -infinity to +infinity. The maximum magnitude of the force feedback as the input moves away from the center point in the positive direction along the specified axis. Range is from 0 to 1.0. The maximum magnitude of the force feedback as the input moves away from the center point in the negative direction along the specified axis. Range is from 0 to 1.0. Specifies the value below which the force feedback is not applied. Range is from 0.0 to 1.0 and is applied asymmetrically around the center point. The offset to the center point in effect calculations. Range is from -1.0 to 1.0.

Starts the force feedback effect.

Stops the force feedback effect.

The type of the force feedback effect.

The force increases in proportion to the velocity with which the user moves the axis.

The force is applied when the axis is moved and depends on the defined friction coefficient.

The force increases in proportion to the acceleration of the axis.

The force increases in proportion to the distance of the axis from a defined neutral point.

A force feedback effect which applies a constant force along a vector.

Creates an instance of ConstantForceEffect.

Specifies the percentage by which to reduce the force of the effect.

Specifies the percentage by which to reduce the force of the effect.

The current state of the force feedback effect.

The current state of the force feedback effect.

Sets the parameters for the constant force feedback effect.

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. The duration of the effect.

Sets the parameters for the effect and sets an envelope for the effect.

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. Percentage by which to reduce the strength of the effect when it is ramping up. Percentage by which to reduce the strength of the effect when it is sustaining. Percentage by which to reduce the strength of the effect when it is ramping down. Time to delay the effect before starting. Time to ramp up to the effect's full strength. Time to maintain the effect at full strength. Time to ramp down from full strength to zero. The number of times to repeat the effect.

Starts the force feedback effect.

Stops the force feedback effect.

The axes the force feedback effect applies to.

The force feedback effect doesn't apply to any axes.

The force feedback effect applies to the x-axis.

The force feedback effect applies to the y-axis.

The force feedback effect applies to the z-axis.

The current state of a force feedback effect.

The effect has faulted.

The effect is paused.

The effect is running.

The effect is stopped.

The results of an attempt to load a force feedback effect.

The effect is not supported.

The effect was not loaded because storage is full.

The effect was successfully loaded.

Encapsulates the force feedback hardware for a given input device.

Boolean indicating whether force feedback effects are paused.

Boolean indicating whether force feedback effects are paused.

Boolean indicating whether the force feedback motor is enabled.

Boolean indicating whether the force feedback motor is enabled.

Specifies the percentage by which to reduce the force of all effects on the controller.

Specifies the percentage by which to reduce the force of all effects on the controller.

The axes supported by the force feedback motor.

The axes supported by the force feedback motor.

Attempts to asynchronously load a feedback effect to the device's internal memory.

The effect to load. Returns the result of the asynchronous operation.

Pauses all force feedback effects being executed.

Resumes all force feedback effects being executed.

Stops all force feedback effects.

Attempts to asynchronously disable the force feedback motor.

Returns the result of the asynchronous operation.

Try to asynchronously enable the force feedback motor of the device.

Returns the result of the asynchronous operation.

Attempts to asynchronously reset the device back to its initial state.

Returns the result of the asynchronous operation.

Attempts to asynchronously unload a feedback effect from the device's internal memory.

The effect to unload. Returns the result of the asynchronous operation.

Describes a force feedback effect.

Specifies the percentage by which to reduce the force of the effect.

Specifies the percentage by which to reduce the force of the effect.

The state of the effect.

The state of the effect.

Starts the effect.

Stops the effect.

A force feedback effect which applies a varying force, defined by a waveform, along a vector.

Creates an instance of PeriodicForceEffect.

The type of effect to create.

Specifies the percentage by which to reduce the force of the effect.

Specifies the percentage by which to reduce the force of the effect.

The type of periodic force feedback effect.

The type of periodic force feedback effect.

The current state of the force feedback effect.

The current state of the force feedback effect.

Sets the parameters for the force feedback effect.

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. The number of times the periodic wave occurs in one second. The phase offset from the origin of the periodic waveform, where 0.0 equals zero degrees of offset, and 1.0 equals 360 degrees of offset. For example, a phase value of 0.25 would correspond to a phase offset of 90 degrees. The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. The duration of the effect.

Sets the parameters for the effect and sets an envelope for the effect.

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. The number of times the periodic wave occurs in one second. The phase offset from the origin of the periodic waveform, where 0.0 equals zero degrees of offset, and 1.0 equals 360 degrees of offset. For example, a phase value of 0.25 would correspond to a phase offset of 90 degrees. The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1. Percentage by which to reduce the strength of the effect when it is ramping up. Percentage by which to reduce the strength of the effect when it is sustaining. Percentage by which to reduce the strength of the effect when it is ramping down. Time to delay the effect before starting. Time to ramp up to the effect's full strength. Time to maintain the effect at full strength. Time to ramp down from full strength to zero. The number of times to repeat the effect.

Starts the force feedback effect.

Stops the force feedback effect.

The type of the periodic force feedback effect.

The waveform rises vertically after it reaches maximum negative force.

The waveform drops vertically after it reaches maximum positive force.

The waveform is a sine wave.

The waveform is a square.

The waveform is a triangle.

A force feedback effect which applies a linearly increasing or decreasing force along a vector.

Creates an instance of RampForceEffect.

Specifies the percentage by which to reduce the force of the effect.

Specifies the percentage by which to reduce the force of the effect.

The current state of the effect.

The current state of the effect.

Sets the parameters for the ramp force feedback effect.

A vector describing the direction and magnitude of the effect on each axis when the effect is starting. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. A vector describing the direction and magnitude of the effect on each axis when the effect is ending. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis. The duration of the effect.

Sets the parameters for the effect and sets an envelope for the effect.

The start vector of the effect. The end vector of the effect. Percentage by which to reduce the strength of the effect when it is ramping up. Percentage by which to reduce the strength of the effect when it is sustaining. Percentage by which to reduce the strength of the effect when it is ramping down. Time to delay the effect before starting. Time to ramp up to the effect's full strength. Time to maintain the effect at full strength. Time to ramp down from full strength to zero. The number of times to repeat the effect.

Starts the force feedback effect.

Stops the effect.

Provides notifications and information about the visibility and input redirection state of Game bar.

Indicates whether input is currently redirected to Game bar.

**true** if input is currently redirected to Game bar; **false** otherwise.

Indicates whether Game bar is currently visible.

**true** if Game bar is currently visible; **false** otherwise.

Occurs when input is redirected to Game bar or input is restored to the game.

Occurs when Game bar is shown or dismissed.

Indicates the origin of the source message.

The message was a typed text message.

The message was transcribed through speech-to-text.

Represents the game chat overlay.

The desired position of the game chat overlay.

The desired position of the game chat overlay.

Render a message in the game chat overlay.

The name of the account that sent the message. In most cases, this should be the gamertag. The contents of the message. The origin of the message (voice or text).

Gets the default game chat overlay instance.

The default game chat overlay instance.

Indicates the game chat overlay's position on the screen.

The bottom center position.

The bottom left position.

The bottom right position.

The middle left position.

The middle right position.

The top center position.

The top left position.

The top right position.

Specifies the language-related preferences that the app can use and maintain.

Gets the ranked list of current runtime language values preferred by the user.

A computed list of languages that merges the app's declared supported languages (ApplicationLanguages.ManifestLanguages ) with the user's ranked list of preferred languages.

Gets the app's declared list of supported languages.

The list of supported languages declared in the app's manifest.

Gets or sets an override for the app's preferred language, expressed as a BCP-47 language tag. This setting is persisted.

A BCP-47 language tag. The app can set it to override the top language of the user's ranked list of preferred languages (ApplicationLanguages.Languages ), and its value will persist between app sessions. It must be a single language tag; a delimited list of language tags will fail.

Retrieves the language preferences of the specified user. This API is part of support for multi-user apps (MUA).

The user to retrieve preferences for. A list of normalized BCP-47 language tags representing the language preferences of the specified user.

Manipulates the representation of a DateTime within a given calendar and clock.

Creates a Calendar object and initializes it to the current DateTime.

Creates a Calendar object that is initialized with a language list.

The list of language identifiers, in priority order, that represents the choice of languages. These are used for resolving patterns to strings. See Remarks for Calendar.

Creates a Calendar object that is initialized with a language list, calendar, and clock.

The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks for Calendar. The calendar identifier to use. The clock identifier to use.

Creates a Calendar object that is initialized with a language list, calendar, clock, and time zone.

The list of language identifiers, in priority order, representing the choice of languages. These are used for resolving patterns to strings. See Remarks for Calendar. The calendar identifier to use. The clock identifier to use. An identifier from the IANA Time Zone Database which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time).

Gets or sets the day.

The day.

Gets the day of the week.

The day of the week.

Gets or sets the era.

The integer that represents the era.

Gets the first Day of the current Month.

The first Day of the current Month.

Gets the first Era available in the calendar.

The first Era in the calendar.

Gets the first Hour of the current Period.

The first Hour of the current Period.

Gets the first Minute of the current Hour.

The first Minute of the current Hour.

Gets the first Month of the current Year.

The first Month of the current Year.

Gets the first Period of the current Day.

The first Period of the current Day.

Gets the first Second of the current Minute.

The first Second of the current Minute.

Gets the first Year of the current Era.

The first Year of the current Era.

Gets or sets the hour.

The hour.

Gets a Boolean indicating if Daylight Saving Time is in effect for the date of this Calendar object.

**True** if Daylight Saving Time is in effect for the date; otherwise, **False**.

Gets the priority list of language identifiers that is used when formatting components as strings.

The list of language identifiers.

Gets the last Day of the current Month.

The last Day of the current Month.

Gets the last Era available in the calendar.

The last Era in the calendar.

Gets the last Hour of the current Period.

The last Hour of the current Period.

Gets the last Minute of the current Hour.

The last Minute of the current Hour.

Gets the last Month of the current Year.

The last Month of the current Year.

Gets the last Period of the current Day.

The last Period of the current Day.

Gets the last Second of the current Minute.

The last Second of the current Minute.

Gets the last Year of the current Era.

The last Year of the current Era.

Gets or sets the minute.

The minute.

Gets or sets the month.

The month.

Gets or sets the nanosecond.

The nanosecond.

Gets the number of days in the current month of this Calendar object.

The number of days in the current month, or – 1 if the number of days in the current month is unknown.

Gets the number of eras in this Calendar object.

The number of eras in the Calendar, or – 1 if the number of eras in the Calendar is unknown.

Gets the number of hours in the current day period of this Calendar object.

The number of hours in the current day period, or – 1 if the number of hours in the current day period is unknown.

Gets the number of Minute s in the current Hour.

The number of Minute s in the current Hour.

Gets the number of months in the current year of this Calendar object.

The number of months in the current year, or – 1 if the number of months in the current year is unknown.

Gets the number of periods in the current day of this Calendar object.

The number of periods in the current day, or – 1 if the number of periods in the current day is unknown.

Gets the number of Second s in the current Minute.

The number of Second s in the current Minute.

Gets the number of years in the current era of this Calendar object.

The number of years in the current era, or – 1 if there is no known bound to the number of years in the current era.

Gets or sets the numbering system that is used when formatting components as strings.

A string that indicates the numeral system of the calendar, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets or sets the period of the current day.

A numeric representation of the current day period. With a 12-hour clock, for example, the first period of the day is 1, representing AM, and the second period is 2, representing PM.

Gets the language that was most recently used to perform calendar formatting or operations.

The language from the priority list of language identifiers that was most recently used to perform calendar formatting or operations.

Gets or sets the second.

The second.

Gets or sets the year.

The year.

Increments or decrements the day.

The number of days by which to increment the day (if the value is positive) or decrement the day (if the value is negative).

Increments or decrements the era.

The number of eras by which to increment the era (if the value is positive) or decrement the era (if the value is negative).

Increments or decrements the hour.

The number of hours by which to increment the hour (if the value is positive) or decrement the hour (if the value is negative).

Increments or decrements the minute.

The number of minutes by which to increment the minute (if the value is positive) or decrement the minute (if the value is negative).

Increments or decrements the month.

The number of months by which to increment the month (if the value is positive) or decrement the month (if the value is negative).

Increments or decrements the nanosecond.

The number of nanoseconds by which to increment the nanosecond (if the value is positive) or decrement the nanosecond (if the value is negative).

Increments or decrements the period.

The number of periods by which to increment the period (if the value is positive) or decrement the period (if the value is negative).

Increments or decrements the second.

The number of seconds by which to increment the second (if the value is positive) or decrement the second (if the value is negative).

Increments or decrements the day by the specified number of weeks.

The number of weeks by which to increment the day (if the value is positive) or decrement the day (if the value is negative).

Increments or decrements the year.

The number of years by which to increment the year (if the value is positive) or decrement the year (if the value is negative).

Sets a new calendar system to be used by this Calendar object.

The calendar identifier to use.

Sets a new clock to be used by this Calendar object.

The clock identifier to use.

Sets a new time zone to be used by this Calendar object.

An identifier from the IANA Time Zone Database which identifies the time zone that should be used (for example, "America/Los_Angeles" for Pacific Time).

Creates a copy of the Calendar object.

A copy of the Calendar.

Compares this calendar to another Calendar object and indicates whether the DateTime of one is earlier, equal to, or later than that of the other.

The Calendar object to compare to the current calendar. One of the following values:

Compares this calendar to a DateTime object and indicates whether the date and time of one is earlier, equal to, or later than that of the other.

The DateTime object to compare to the current calendar. One of the following values:

Copies the values from another Calendar object into this Calendar.

The Calendar object to be copied.

Returns a string representation of the day, optionally zero-padded.

The minimum number of integer digits to be displayed. If the day does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the day 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. A string representation of the day.

Returns a string that contains the numeric representation of the day.

A string representation of the day.

Returns a string representation of the day of the week suitable for stand-alone display.

A string representation of the day of the week, using the most common abbreviation available.

Returns a string representation of the day of the week suitable for stand-alone display.

A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. A string representation of the day of the week.

Returns a string representation of the day of the week suitable for inclusion with other date components.

A string representation of the day of the week, using the most common abbreviation available.

Returns a string representation of the day of the week suitable for inclusion with other date components.

A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. A string representation of the day of the week.

Returns a string representation of the era.

A string representation of the era, using the most common abbreviation available.

Returns a string representation of the era. The string chosen is closest in length to the ideal length.

A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. A string representation of the era.

Gets the calendar system that is used by this Calendar object.

The identifier of the calendar system.

Gets the clock that is used by this Calendar object.

The identifier of the clock.

Builds a date and time, given the components of this Calendar object.

The DateTime representing the date and time of this Calendar.

Gets the identifier that identifies the time zone that is used by this Calendar object.

The identifier from the IANA Time Zone Database that identifies the time zone that is used by this Calendar object. (An example is "America/Los_Angeles" for Pacific Time.)

Returns a string representation of the hour, optionally zero-padded.

The minimum number of integer digits to be displayed. If the hour does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the hour 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. A string representation of the hour.

Returns a string that contains the numeric representation of the hour.

A string representation of the hour.

Returns a string representation of the minute, optionally zero-padded.

The minimum number of integer digits to be displayed. If the minute does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the minute 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. A string representation of the minute.

Returns a string that contains the numeric representation of the minute.

A string representation of the minute.

Returns a string that contains the numeric representation of the month.

A string representation of the month.

Returns a string representation of the month, optionally zero-padded.

The minimum number of integer digits to be displayed. If the month does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the month 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. A string representation of the month.

Returns a string representation of the month suitable for stand-alone display.

A string representation of the month, using the most common abbreviation available.

Returns a string representation of the month suitable for stand-alone display.

A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. A string representation of the month.

Returns a string representation of the month suitable for inclusion with other date components.

A string representation of the month, using the most common abbreviation available.

Returns a string representation of the month suitable for inclusion with other date components.

A positive integer specifying the ideal length, in characters, for the returned string, or 0 specifying the most common abbreviation available. A string representation of the month.

Returns a string representation of the nanosecond, optionally zero-padded.

The minimum number of integer digits to be displayed. If the nanosecond does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the nanosecond 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. A string representation of the nanosecond.

Returns a string that contains the numeric representation of the nanosecond.

A string representation of the nanosecond.

Returns a string representation of the day period, such as AM or PM, that uses the most common abbreviation available.

A string representation of the day period.

Returns a string representation of the day period, such as AM or PM.

A positive integer that specifies the ideal length, in characters, for the returned string; or a zero that specifies the most common abbreviation available. A string representation for the day period.

Returns a string representation of the second, optionally zero-padded.

The minimum number of integer digits to be displayed. If the second does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the second 3, a parameter of 1 returns 3, and a parameter of 2 returns 03. A string representation of the second.

Returns a string that contains the numeric representation of the second.

A string representation of the second.

Sets all the date and time fields to the date and time represented by the DateTime parameter.

The DateTime that is used to set all of the date and time fields.

Sets the components of this Calendar object to the latest DateTime supported.

Sets the components of this Calendar object to the earliest DateTime supported.

Sets the components of this Calendar object to the current DateTime.

Returns the full time zone name applicable at the instant of time that this Calendar object represents.

The full time zone name. This usually differs depending on whether the time zone is observing Daylight Saving Time or not. It also may differ due to historical changes. (An example is "America/Los_Angeles" for Pacific Time.)

Returns the abbreviated time zone name applicable at the instant of time that this Calendar object represents.

The desired length of the abbreviation to be returned. Use 0 to request the abbreviation in most common use. The time zone abbreviation that is closest in length to *idealLength*. If there is a tie, the shorter abbreviation is returned. If *idealLength* is 0, the abbreviation in most common use is returned. (An example is "America/Los_Angeles" for Pacific Time.)

Returns a string representation of the year, optionally zero-padded.

The minimum number of integer digits to be displayed. If the year does not have enough integer digits, it will be padded with zeros to the correct amount. For example, for the year 42, a parameter of 1 or 2 returns 42, and a parameter of 3 returns 042. A string representation of the year.

Returns a string representation of the year without any initial zero padding.

A string representation of the year.

Returns a string representation of the year, optionally truncated.

A positive integer that represents the number of least significant digits that should be included. For example, for the year 1234, a parameter of 2 returns 34, and a parameter of 4 or larger returns 1234. A string representation of the year.

Contains the calendar identifiers for the supported calendars, as static properties.

Gets the identifier for the Chinese lunisolar calendar.

The string "ChineseLunarCalendar", which is the identifier for the Chinese lunar calendar.

Gets the identifier for the Gregorian calendar.

The string "GregorianCalendar", which is the identifier for the Gregorian calendar.

Gets the identifier for the Hebrew calendar.

The string "HebrewCalendar", which is the identifier for the Hebrew calendar.

Gets the identifier for the Hijri calendar.

The string "HijriCalendar", which is the identifier for the Hijri calendar.

Gets the identifier for the Japanese calendar.

The string "JapaneseCalendar", which is the identifier for the Japanese calendar.

This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown.

The string "JapaneseLunarCalendar", which is the identifier for the Japanese lunar calendar.

Gets the identifier for the Julian calendar.

The string "JulianCalendar", which is the identifier for the Julian calendar.

Gets the identifier for the Korean calendar.

The string "KoreanCalendar", which is the identifier for the Korean calendar.

This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown.

The string "KoreanLunarCalendar", which is the identifier for the Korean lunar calendar.

Gets the identifier for the Persian calendar.

The string "PersianCalendar", which is the identifier for the Persian calendar.

Gets the identifier for the Taiwan calendar.

The string "TaiwanCalendar", which is the identifier for the Taiwan calendar.

This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown.

The string "TaiwanLunarCalendar", which is the identifier for the Taiwan Lunar calendar.

Gets the identifier for the Thai calendar.

The string "ThaiCalendar", which is the identifier for the Thai calendar.

Gets the identifier for the Um Al-Qura calendar.

The string "UmAlQuraCalendar", which is the identifier for the Um Al-Qura calendar.

This name is reserved for a future update. Do not access or use this property in your code, as accessing the property will result in errors or exceptions being thrown.

The string "VietnameseLunarCalendar", which is the identifier for the Vietnamese lunar calendar.

Contains the clock identifiers for the supported clocks, as static properties.

Gets the identifier for a 12-hour clock.

The string "12HourClock", which is the identifier for a 12-hour clock.

Gets the identifier for a 24-hour clock.

The string "24HourClock", which is the identifier for a 24-hour clock.

Defines properties for specifying a currency and its amount.

Creates a new CurrencyAmount object (in the specified amount and currency).

A string containing a decimal number in the invariant culture format (for example, a culture-insensitive amount such as "100.00"). A string containing a CurrencyIdentifiers value (such as USD ), other **ISO 4217** alphabetic currency code, "vendor-specific" code prefixed with *"X-"* (for example, *"X-ContosoPoints"*) or other currency name (including cryptocurrency, such as *"Bitcoin"* or *"TRON"*).

An amount.

A string containing a decimal number in the invariant culture format (for example, a culture-insensitive amount such as "100.00").

A currency in general use in a specific country.

A string containing a value from CurrencyIdentifiers (such as USD, or other **ISO 4217** alphabetic currency code), vendor-specific code prefixed with *"X-"* (for example, *"X-ContosoPoints"*), or another currency name (including cryptocurrency, such as *"Bitcoin"* or *"TRON"*).

Contains the currency identifiers for the supported currencies, as static properties.

Gets the currency identifier for the United Arab Emirates Dirham.

The string "AED", which identifies the United Arab Emirates Dirham.

Gets the currency identifier for the Afghan Afghani.

The string "AFN", which identifies the Afghan Afghani.

Gets the currency identifier for the Albanian Lek.

The string "ALL", which identifies the Albanian Lek.

Gets the currency identifier for the Armenian Dram.

The string "AMD", which identifies the Armenian Dram.

Gets the currency identifier for the Netherlands Antillean Guilder.

The string "ANG", which identifies the Netherlands Antillean Guilder.

Gets the currency identifier for the Angolan Kwanza.

The string "AOA", which identifies the Angolan Kwanza.

Gets the currency identifier for the Argentine Peso.

The string "ARS", which identifies the Argentine Peso.

Gets the currency identifier for the Australian Dollar.

The string "AUD", which identifies the Australian Dollar.

Gets the currency identifier for the Aruban Florin.

The string "AWG", which identifies the Aruban Florin.

Gets the currency identifier for the Azerbaijani Manat.

The string "AZN", which identifies the Azerbaijani Manat.

Gets the currency identifier for the Bosnia and Herzegovina Convertible Mark.

The string "BAM", which identifies the Bosnia and Herzegovina Convertible Mark.

Gets the currency identifier for the Barbados Dollar.

The string "BBD", which identifies the Barbados Dollar.

Gets the currency identifier for the Bangladeshi Taka.

The string "BDT", which identifies the Bangladeshi Taka.

Gets the currency identifier for the Bulgarian Lev.

The string "BGN", which identifies the Bulgarian Lev.

Gets the currency identifier for the Bahraini Dinar.

The string "BHD", which identifies the Bahraini Dinar.

Gets the currency identifier for the Burundian Franc.

The string "BIF", which identifies the Burundian Franc.

Gets the currency identifier for the Bermuda Dollar.

The string "BMD", which identifies the Bermuda Dollar.

Gets the currency identifier for the Brunei Dollar.

The string "BND", which identifies the Brunei Dollar.

Gets the currency identifier for the Bolivian Boliviano.

The string "BOB", which identifies the Bolivian Boliviano.

Gets the currency identifier for the Brazilian Real.

The string "BRL", which identifies the Brazilian Real.

Gets the currency identifier for the Bahamian Dollar.

The string "BSD", which identifies the Bahamian Dollar.

Gets the currency identifier for the Bhutanese Ngultrum.

The string "BTN", which identifies the Bhutanese Ngultrum.

Gets the currency identifier for the Botswana Pula.

The string "BWP", which identifies the Botswana Pula.

Gets the currency identifier for the Belarusian Ruble.

The string "BYN", which identifies the Belarusian Ruble.

Gets the currency identifier for the Belarusian Ruble.

The string "BYR", which identifies the Belarusian Ruble.

Gets the currency identifier for the Belize Dollar.

The string "BZD", which identifies the Belize Dollar.

Gets the currency identifier for the Canadian Dollar.

The string "CAD", which identifies the Canadian Dollar.

Gets the currency identifier for the Congolese Franc.

The string "CDF", which identifies the Congolese Franc.

Gets the currency identifier for the Swiss Franc.

The string "CHF", which identifies the Swiss Franc.

Gets the currency identifier for the Chilean Peso.

The string "CLP", which identifies the Chilean Peso.

Gets the currency identifier for the Chinese Yuan.

The string "CNY", which identifies the Chinese Yuan.

Gets the currency identifier for the Colombian Peso.

The string "COP", which identifies the Colombian Peso.

Gets the currency identifier for the Costa Rican Colon.

The string "CRC", which identifies the Costa Rican Colon.

Gets the currency identifier for the Cuban Peso.

The string "yyy", which identifies the Cuban Peso.

Gets the currency identifier for the Cabo Verde Escudo.

The string "CVE", which identifies the Cabo Verde Escudo.

Gets the currency identifier for the Czech Koruna.

The string "CZK", which identifies the Czech Koruna.

Gets the currency identifier for the Djiboutian Franc.

The string "DJF", which identifies the Djiboutian Franc.

Gets the currency identifier for the Danish Krone.

The string "DKK", which identifies the Danish Krone.

Gets the currency identifier for the Dominican Peso.

The string "DOP", which identifies the Dominican Peso.

Gets the currency identifier for the Algerian Dinar.

The string "DZD", which identifies the Algerian Dinar.

Gets the currency identifier for the Egyptian Pound.

The string "EGP", which identifies the Egyptian Pound.

Gets the currency identifier for the Eritrean Nakfa.

The string "ERN", which identifies the Eritrean Nakfa.

Gets the currency identifier for the Ethiopian Birr.

The string "ETB", which identifies the Ethiopian Birr.

Gets the currency identifier for the Euro.

The string "EUR", which identifies the Euro.

Gets the currency identifier for the Fiji Dollar.

The string "FJD", which identifies the Fiji Dollar.

Gets the currency identifier for the Falkland Islands Pound.

The string "FKP", which identifies the Falkland Islands Pound.

Gets the currency identifier for the Pound Sterling.

The string "GBP", which identifies the Pound Sterling.

Gets the currency identifier for the Georgian Lari.

The string "GEL", which identifies the Georgian Lari.

Gets the currency identifier for the Ghanaian Cedi.

The string "GHS", which identifies the Ghanaian Cedi.

Gets the currency identifier for the Gibraltar Pound.

The string "GIP", which identifies the Gibraltar Pound.

Gets the currency identifier for the Gambian Dalasi.

The string "GMD", which identifies the Gambian Dalasi.

Gets the currency identifier for the Guinean Franc.

The string "GNF", which identifies the Guinean Franc.

Gets the currency identifier for the Guatemalan Quetzal.

The string "GTQ", which identifies the Guatemalan Quetzal.

Gets the currency identifier for the Guyanese Dollar.

The string "GYD", which identifies the Guyanese Dollar.

Gets the currency identifier for the Hong Kong Dollar.

The string "HKD", which identifies the Hong Kong Dollar.

Gets the currency identifier for the Honduran Lempira.

The string "HNL", which identifies the Honduran Lempira.

Gets the currency identifier for the Croatian Kuna.

The string "HRK", which identifies the Croatian Kuna.

Gets the currency identifier for the Haitian Gourde.

The string "HTG", which identifies the Haitian Gourde.

Gets the currency identifier for the Hungarian Forint.

The string "HUF", which identifies the Hungarian Forint.

Gets the currency identifier for the Indonesian Rupiah.

The string "IDR", which identifies the Indonesian Rupiah.

Gets the currency identifier for the Israeli New Shekel.

The string "ILS", which identifies the Israeli New Shekel.

Gets the currency identifier for the Indian Rupee.

The string "INR", which identifies the Indian Rupee.

Gets the currency identifier for the Iraqi Dinar.

The string "IQD", which identifies the Iraqi Dinar.

Gets the currency identifier for the Iranian Rial.

The string "IRR", which identifies the Iranian Rial.

Gets the currency identifier for the Icelandic Krona.

The string "ISK", which identifies the Icelandic Krona.

Gets the currency identifier for the Jamaican Dollar.

The string "JMD", which identifies the Jamaican Dollar.

Gets the currency identifier for the Jordanian Dinar.

The string "JOD", which identifies the Jordanian Dinar.

Gets the currency identifier for the Japanese Yen.

The string "JPY", which identifies the Japanese Yen.

Gets the currency identifier for the Kenyan Shilling.

The string "KES", which identifies the Kenyan Shilling.

Gets the currency identifier for the Kyrgyzstani Som.

The string "KGS", which identifies the Kyrgyzstani Som.

Gets the currency identifier for the Cambodian Riel.

The string "KHR", which identifies the Cambodian Riel.

Gets the currency identifier for the Comorian Franc.

The string "KMF", which identifies the Comorian Franc.

Gets the currency identifier for the North Korean Won.

The string "KPW", which identifies the North Korean Won.

Gets the currency identifier for the Korean Won.

The string "KRW", which identifies the Korean Won.

Gets the currency identifier for the Kuwaiti Dinar.

The string "KWD", which identifies the Kuwaiti Dinar.

Gets the currency identifier for the Cayman Islands Dollar.

The string "KYD", which identifies the Cayman Islands Dollar.

Gets the currency identifier for the Kazakhstani Tenge.

The string "KZT", which identifies the Kazakhstani Tenge.

Gets the currency identifier for the Lao Kip.

The string "LAK", which identifies the Lao Kip.

Gets the currency identifier for the Lebanese Pound.

The string "LBP", which identifies the Lebanese Pound.

Gets the currency identifier for the Sri Lankan Rupee.

The string "LKR", which identifies the Sri Lankan Rupee.

Gets the currency identifier for the Liberian Dollar.

The string "LRD", which identifies the Liberian Dollar.

Gets the currency identifier for the Lesotho Loti.

The string "LSL", which identifies the Lesotho Loti.

Gets the currency identifier for the Lithuanian Litas.

The string "LTL", which identifies the Lithuanian Litas.

Gets the currency identifier for the Latvian Lats.

The string "LVL", which identifies the Latvian Lats.

Gets the currency identifier for the Libyan Dinar.

The string "LYD", which identifies the Libyan Dinar.

Gets the currency identifier for the Moroccan Dirham.

The string "MAD", which identifies the Moroccan Dirham.

Gets the currency identifier for the Moldovan Leu.

The string "MDL", which identifies the Moldovan Leu.

Gets the currency identifier for the Malagasy Ariary.

The string "MGA", which identifies the Malagasy Ariary.

Gets the currency identifier for the Republic of North Macedonia Denar.

The string "MKD", which identifies the Republic of North Macedonia Denar.

Gets the currency identifier for the Myanmar Kyat.

The string "MMK", which identifies the Myanmar Kyat.

Gets the currency identifier for the Mongolian Tugrik.

The string "MNT", which identifies the Mongolian Tugrik.

Gets the currency identifier for the Macao SAR Pataca.

The string "MOP", which identifies the Macao SAR Pataca.

Gets the currency identifier for the Mauritania Ouguiya.

The string "MRO", which identifies the Mauritania Ouguiya.

Gets the currency identifier for the Mauritanian ouguiya.

The string "MRU", which identifies the Mauritanian ouguiya.

Gets the currency identifier for the Mauritian Rupee.

The string "MUR", which identifies the Mauritian Rupee.

Gets the currency identifier for the Maldives Rufiyaa.

The string "MVR", which identifies the Maldives Rufiyaa.

Gets the currency identifier for the Malawian Kwacha.

The string "MWK", which identifies the Malawian Kwacha.

Gets the currency identifier for the Mexican Peso.

The string "MXN", which identifies the Mexican Peso.

Gets the currency identifier for the Malaysian Ringgit.

The string "MYR", which identifies the Malaysian Ringgit.

Gets the currency identifier for the New Mozambican Metical.

The string "MZN", which identifies the New Mozambican Metical.

Gets the currency identifier for the Namibian Dollar.

The string "NAD", which identifies the Namibian Dollar.

Gets the currency identifier for the Nigerian Naira.

The string "NGN", which identifies the Nigerian Naira.

Gets the currency identifier for the Nicaraguan Cordoba Oro.

The string "NIO", which identifies the Nicaraguan Cordoba Oro.

Gets the currency identifier for the Norwegian Krone.

The string "NOK", which identifies the Norwegian Krone.

Gets the currency identifier for the Nepalese Rupee.

The string "NPR", which identifies the Nepalese Rupee.

Gets the currency identifier for the New Zealand Dollar.

The string "NZD", which identifies the New Zealand Dollar.

Gets the currency identifier for the Omani Rial.

The string "OMR", which identifies the Omani Rial.

Gets the currency identifier for the Panamanian Balboa.

The string "PAB", which identifies the Panamanian Balboa.

Gets the currency identifier for the Peruvian Nuevo Sol.

The string "PEN", which identifies the Peruvian Nuevo Sol.

Gets the currency identifier for the Papua New Guinea Kina.

The string "PGK", which identifies the Papua New Guinea Kina.

Gets the currency identifier for the Philippine Peso.

The string "PHP", which identifies the Philippine Peso.

Gets the currency identifier for the Pakistan Rupee.

The string "PKR", which identifies the Pakistan Rupee.

Gets the currency identifier for the Polish Zloty.

The string "PLN", which identifies the Polish Zloty.

Gets the currency identifier for the Paraguay Guarani.

The string "PYG", which identifies the Paraguay Guarani.

Gets the currency identifier for the Qatari Riyal.

The string "QAR", which identifies the Qatari Riyal.

Gets the currency identifier for the Romanian Leu.

The string "RON", which identifies the Romanian Leu.

Gets the currency identifier for the Serbian Dinar.

The string "RSD", which identifies the Serbian Dinar.

Gets the currency identifier for the Russian Ruble.

The string "RUB", which identifies the Russian Ruble.

Gets the currency identifier for the Rwandan Franc.

The string "RWF", which identifies the Rwandan Franc.

Gets the currency identifier for the Saudi Arabian Riyal.

The string "SAR", which identifies the Saudi Arabian Riyal.

Gets the currency identifier for the Solomon Islands Dollar.

The string "SBD", which identifies the Solomon Islands Dollar.

Gets the currency identifier for the Seychelles Rupee.

The string "SCR", which identifies the Seychelles Rupee.

Gets the currency identifier for the Sudanese Pound.

The string "SDG", which identifies the Sudanese Pound.

Gets the currency identifier for the Swedish Krona.

The string "SEK", which identifies the Swedish Krona.

Gets the currency identifier for the Singapore Dollar.

The string "SGD", which identifies the Singapore Dollar.

Gets the currency identifier for the Saint Helena Pound.

The string "SHP", which identifies the Saint Helena Pound.

Gets the currency identifier for the Sierra Leone Leone.

The string "SLL", which identifies the Sierra Leone Leone.

Gets the currency identifier for the Somali Shilling.

The string "SOS", which identifies the Somali Shilling.

Gets the currency identifier for the Suriname Dollar.

The string "SRD", which identifies the Suriname Dollar.

Gets the currency identifier for the South Sudanese pound.

The string "SSP", which identifies the South Sudanese pound.

Gets the currency identifier for the Sao Tome Dobra.

The string "STD", which identifies the Sao Tome Dobra.

Gets the currency identifier for the São Tomé and Príncipe dobra.

The string "STN", which identifies the São Tomé and Príncipe dobra.

Gets the currency identifier for the Syrian Pound.

The string "SYP", which identifies the Syrian Pound.

Gets the currency identifier for the Swazi Lilangeni.

The string "SZL", which identifies the Swazi Lilangeni.

Gets the currency identifier for the Thai Baht.

The string "THB", which identifies the Thai Baht.

Gets the currency identifier for the Tajikistani Somoni.

The string "TJS", which identifies the Tajikistani Somoni.

Gets the currency identifier for the Turkmenistan Manat.

The string "TMT", which identifies the Turkmenistan Manat.

Gets the currency identifier for the Tunisian Dinar.

The string "TND", which identifies the Tunisian Dinar.

Gets the currency identifier for the Tongan Pa'Anga.

The string "TOP", which identifies the Tongan Pa'Anga.

Gets the currency identifier for the Turkish Lira.

The string "TRY", which identifies the Turkish Lira.

Gets the currency identifier for the Trinidad and Tobago Dollar.

The string "TTD", which identifies the Trinidad and Tobago Dollar.

Gets the currency identifier for the New Taiwan Dollar.

The string "TWD", which identifies the New Taiwan Dollar.

Gets the currency identifier for the Tanzanian Shilling.

The string "TZS", which identifies the Tanzanian Shilling.

Gets the currency identifier for the Ukrainian Hryvnia.

The string "UAH", which identifies the Ukrainian Hryvnia.

Gets the currency identifier for the Uganda Shilling.

The string "UGX", which identifies the Uganda Shilling.

Gets the currency identifier for the United States Dollar.

The string "USD", which identifies the United States Dollar.

Gets the currency identifier for the Uruguayan Peso.

The string "UYU", which identifies the Uruguayan Peso.

Gets the currency identifier for the Uzbekistani Som.

The string "UZS", which identifies the Uzbekistani Som.

Gets the currency identifier for the Venezuelan Bolivar Fuerte.

The string "VEF", which identifies the Venezuelan Bolivar Fuerte.

Gets the currency identifier for the Venezuelan bolívar.

The string "VES", which identifies the Venezuelan bolívar.

Gets the currency identifier for the Viet Nam Dong.

The string "VND", which identifies the Viet Nam Dong.

Gets the currency identifier for the Vanuatu Vatu.

The string "VUV", which identifies the Vanuatu Vatu.

Gets the currency identifier for the Samoan Tala.

The string "WST", which identifies the Samoan Tala.

Gets the currency identifier for the Central African CFA.

The string "XAF", which identifies the Central African CFA.

Gets the currency identifier for the East Caribbean Dollar.

The string "XCD", which identifies the East Caribbean Dollar.

Gets the currency identifier for the West African CFA.

The string "XOF", which identifies the West African CFA.

Gets the currency identifier for the French Pacific Franc.

The string "XPF", which identifies the French Pacific Franc.

Gets the currency identifier that represents no currency.

The string "XXX", which represents no currency.

Gets the currency identifier for the Yemeni Rial.

The string "YER", which identifies the Yemeni Rial.

Gets the currency identifier for the South African Rand.

The string "ZAR", which identifies the South African Rand.

Gets the currency identifier for the Zambian Kwacha.

The string "ZMW", which identifies the Zambian Kwacha.

Gets the currency identifier for the Zimbabwean Dollar.

The string "ZWL", which identifies the Zimbabwean Dollar.

Identifies the day of the week.

Friday

Monday

Saturday

Sunday

Thursday

Tuesday

Wednesday

Describes a region. This is usually a country, but may be a macroregion.

Creates a GeographicRegion object that defaults to the user's home region.

Creates a GeographicRegion object.

One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region.

Gets the string that contains the best available identifier that represents the region.

Returns a string that contains:

Gets the three-digit identifier for this region, as a string.

Returns as a string the ISO-3166-1 numeric three-digit code for the region, or the UN-M49 code. If the region is unknown, returns "999".

Gets the three-letter identifier for this region.

Returns the three-letter ISO 3166-1 alpha-3 code for this region, if one exists; otherwise, returns "ZZZ".

Gets the two-letter identifier for this region.

Returns the two-letter ISO 3166-1 alpha-2 code for this region, if one exists; otherwise, returns "ZZ".

Gets the set of currencies in use in this region.

The set of ISO 4217 3-letter codes for the currencies that are used in the region.

Gets a localized string that is suitable for display to the user for identifying the region.

The localized name of the region.

Gets the name of the region in the primary language spoken in this region.

The name of the region in the primary language spoken in this region.

Determines whether a geographic region identifier is supported.

One of the ISO 3166-1 two-letter or three-letter codes that identify the country, or one of the three-digit UN-M49 codes that identify the geographical region. **True** if the ID is known; otherwise, ** false**. If this method returns **true**, an app can safely construct a region by using this region identifier. If it returns **false**, attempting to construct a region for the given code will throw an exception.

A class that provides information related to BCP-47 language tags such as the language name and the script.

Creates a Language object.

A BCP-47 language tag. See Remarks for Language.

Gets the three-letter abbreviation for a BCP-47 language tag. For example, "en-US" is converted to "eng".

The three letter abbreviation.

Gets the BCP-47 language tag for the currently enabled keyboard layout or Input Method Editor (IME).

The BCP-47 language tag.

Gets a localized string that is suitable for display to the user for identifying the language.

The localized name of the language.

Gets the normalized BCP-47 language tag for this language.

The normalized BCP-47 language tag.

Gets the content layout direction (for text and UI elements) most appropriate for a language.

A layout direction.

Gets the name of the language in the language itself.

The name of the language in the language itself.

Gets the four-letter ISO 15924 script code of the language.

A string with the script code of the language. If the script code cannot be identified or inferred from the language tag, "Zyyy" is returned.

Retrieves a vector of extension subtags in the current language for the given extension identified by singleton.

A single-character subtag for the LanguageTag of the current language. See BCP-47 language tags, Extensions and the Extensions Registry. The list of extension subtags identified by *singleton*.

Retrieves a set of Multilingual User Interface (MUI) tags derived from one or more BCP-47 language tags.

One or more BCP-47 language tags. A set of Multilingual User Interface (MUI) tags.

Determines whether a BCP-47 language tag is well-formed.

A BCP-47 language tag. **True** if the language tag is well-formed as defined by BCP-47, except when the language tag can never be valid according to BCP-47. Otherwise it returns **false**. If this method returns **true**, an application can safely construct a language by using this tag. If it returns **false**, attempting to construct a language for the given tag will throw an exception.

Tries to set the normalized BCP-47 language tag of this language.

The normalized BCP-47 language tag. **true** if the value is successfully set, otherwise **false**.

Defines constants that specify the content layout direction (for text and UI elements) most appropriate for a language.

Indicates a content layout direction of left to right.

Indicates a content layout direction of right to left (for example, for Arabic or other RTL languages).

Indicates a content layout direction that flows from the top to the bottom of the page; the first top-to-bottom column of content is on the left, and columns are added from left to right.

Indicates a content layout direction that flows from the top to the bottom of the page; the first top-to-bottom column of content is on the right, and columns are added from right to left.

Contains the numeral system identifiers for the supported numeral systems, as static properties.

Gets the identifier for the Arabic-Indic decimal numeral system.

The string "Arab", which identifies the Arabic-Indic decimal numeral system. This system has the digits ٠١٢٣٤٥٦٧٨٩ which correspond to the Latin digits 0-9.

Gets the identifier for the Extended Arabic-Indic decimal numeral system.

The string "ArabExt", which identifies the Extended Arabic-Indic decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9.

Gets the identifier for the Balinese decimal numeral system.

The string "Bali", which identifies the Balinese decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Bangla decimal numeral system.

The string "Beng", which identifies the Bangla decimal numeral system. This system has the digits ০১২৩৪৫৬৭৮৯ which correspond to the Latin digits 0-9.

Gets the identifier for the Brahmi decimal numeral system.

The string "Brah", which identifies the Brahmi decimal numeral system.

Gets the identifier for the Cham decimal numeral system.

The string "Cham", which identifies the Cham decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Devanagari decimal numeral system.

The string "Deva", which identifies the Devanagari decimal numeral system. This system has the digits ०१२३४५६७८९ which correspond to the Latin digits 0-9.

Gets the identifier for the Latin decimal numeral system using full-width characters.

The string "FullWide", which identifies the Latin decimal numeral system using full-width characters. This system has the digits ０１２３４５６７８９ which correspond to the Latin digits 0-9.

Gets the identifier for the Gujarati decimal numeral system.

The string "Gujr", which identifies the Gujarati decimal numeral system. This system has the digits ૦૧૨૩૪૫૬૭૮૯ which correspond to the Latin digits 0-9.

Gets the identifier for the Gurmukhi decimal numeral system.

The string "Guru", which identifies the Gurmukhi decimal numeral system. This system has the digits ੦੧੨੩੪੫੬੭੮੯ which correspond to the Latin digits 0-9.

Gets the identifier for the Han decimal numeral system.

The string "HaniDec", which identifies the Han decimal numeral system. This system has the digits 〇一二三四五六七八九 which correspond to the Latin digits 0-9.

Gets the identifier for the Javanese decimal numeral system.

The string "Java", which identifies the Javanese decimal numeral system. This system has the digits ꧐꧑꧒꧓꧔꧕꧖꧗꧘꧙ which correspond to the Latin digits 0-9.

Gets the identifier for the Kayah Li decimal numeral system.

The string "Kali", which identifies the Kayah Li decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Khmer decimal numeral system.

The string "Khmr", which identifies the Khmer decimal numeral system. This system has the digits ០១២៣៤៥៦៧៨៩ which correspond to the Latin digits 0-9.

Gets the identifier for the Kannada decimal numeral system.

The string "Knda", which identifies the Kannada decimal numeral system. This system has the digits ೦೧೨೩೪೫೬೭೮೯ which correspond to the Latin digits 0-9.

Gets the identifier for the Tai Tham Hora decimal numeral system.

The string "Lana", which identifies the Tai Tham Hora decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Tai Tham Tham decimal numeral system.

The string "LanaTham", which identifies the Tai Tham Tham decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Laoo decimal numeral system.

The string "Laoo", which identifies the Laoo decimal numeral system. This system has the digits ۰۱۲۳۴۵۶۷۸۹ which correspond to the Latin digits 0-9.

Gets the identifier for the Latin decimal numeral system.

The string "Latn", which identifies the Latin decimal numeral system. This system has the Latin digits 0123456789.

Gets the identifier for the Lepcha decimal numeral system.

The string "Lepc", which identifies the Lepcha decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Limbu decimal numeral system.

The string "Limb", which identifies the Limbu decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the decimal numeral system using MathBold characters.

The string "MathBold", which identifies the decimal numeral system using MathBold characters.

Gets the identifier for the decimal numeral system using MathDbl characters.

The string "MathDbl", which identifies the decimal numeral system using MathDbl characters.

Gets the identifier for the decimal numeral system using MathMono characters.

The string "MathMono", which identifies the decimal numeral system using MathMono characters.

Gets the identifier for the decimal numeral system using MathSanb characters.

The string "MathSanb", which identifies the decimal numeral system using MathSanb characters.

Gets the identifier for the decimal numeral system using MathSans characters.

The string "MathSans", which identifies the decimal numeral system using MathSans characters.

Gets the identifier for the Malayalam decimal numeral system.

The string "Mlym", which identifies the Malayalam decimal numeral system. This system has the digits ൦൧൨൩൪൫൬൭൮൯ which correspond to the Latin digits 0-9.

Gets the identifier for the Mongolian decimal numeral system.

The string "Mong", which identifies the Mongolian decimal numeral system. This system has the digits ᠐᠑᠒᠓᠔᠕᠖᠗᠘᠙ which correspond to the Latin digits 0-9.

Gets the identifier for the Meetei Mayek decimal numeral system.

The string "Mtei", which identifies the Meetei Mayek decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Myanmar decimal numeral system.

The string "Mymr", which identifies the Myanmar decimal numeral system. This system has the digits ၀၁၂၃၄၅၆၇၈၉ which correspond to the Latin digits 0-9.

Gets the identifier for the Myanmar Shan decimal numeral system.

The string "MymrShan", which identifies the Myanmar Shan decimal numeral system. This system has the digits ႐႑႒႓႔႕႖႗႘႙ which correspond to the Latin digits 0-9.

Gets the identifier for the Nko decimal numeral system.

The string "Nkoo", which identifies the Nko decimal numeral system. This system has the digits ߀߁߂߃߄߅߆߇߈߉ which correspond to the Latin digits 0-9.

Gets the identifier for the Ol Chiki decimal numeral system.

The string "Olck", which identifies the Ol Chiki decimal numeral system. This system has the digits ᱐᱑᱒᱓᱔᱕᱖᱗᱘᱙ which correspond to the Latin digits 0-9.

Gets the identifier for the Odia decimal numeral system.

The string "Orya", which identifies the Odia decimal numeral system. This system has the digits ୦୧୨୩୪୫୬୭୮୯ which correspond to the Latin digits 0-9.

Gets the identifier for the Osmanya decimal numeral system.

The string "Osma", which identifies the Osmanya decimal numeral system.

Gets the identifier for the Saurashtra decimal numeral system.

The string "Saur", which identifies the Saurashtra decimal numeral system. This system uses the following Unicode values:<table>

Gets the identifier for the Sundanese decimal numeral system.

The string "Sund", which identifies the Sundanese decimal numeral system. This system uses the following Unicode values:

Gets the identifier for the New Tai Lue decimal numeral system.

The string "Talu", which identifies the New Tai Lue decimal numeral system. This system has the digits ᧐᧑᧒᧓᧔᧕᧖᧗᧘᧙ which correspond to the Latin digits 0-9.

Gets the identifier for the Tamil decimal numeral system.

The string "TamlDec", which identifies the Tamil decimal numeral system. This system has the digits ௦௧௨௩௪௫௬௭௮௯ which correspond to the Latin digits 0-9.

Gets the identifier for the Telugu decimal numeral system.

The string "Telu", which identifies the Telugu decimal numeral system. This system has the digits ౦౧౨౩౪౫౬౭౮౯ which correspond to the Latin digits 0-9.

Gets the identifier for the Thai decimal numeral system.

The string "Thai", which identifies the Thai decimal numeral system. This system has the digits ๐๑๒๓๔๕๖๗๘๙ which correspond to the Latin digits 0-9.

Gets the identifier for the Tibetan decimal numeral system.

The string "Tibt", which identifies the Tibetan decimal numeral system. This system has the digits ༠༡༢༣༤༥༦༧༨༩ which correspond to the Latin digits 0-9.

Gets the identifier for the Vai decimal numeral system.

The string "Vaii", which identifies the Vai decimal numeral system. This system has the digits ꘠꘡꘢꘣꘤꘥꘦꘧꘨꘩ which correspond to the Latin digits 0-9.

Gets the identifier for the decimal numeral system using ZmthBold (Mathematical notation) characters.

The string "ZmthBold", which identifies the decimal numeral system using ZmthBold (Mathematical notation) characters.

Gets the identifier for the decimal numeral system using ZmthDbl (Mathematical notation) characters.

The string "ZmthDbl", which identifies the decimal numeral system using ZmthDbl (Mathematical notation) characters.

Gets the identifier for the decimal numeral system using ZmthMono (Mathematical notation) characters.

The string "ZmthMono", which identifies the decimal numeral system using ZmthMono (Mathematical notation) characters.

Gets the identifier for the decimal numeral system using ZmthSanb (Mathematical notation) characters.

The string "ZmthSanb", which identifies the decimal numeral system using ZmthSanb (Mathematical notation) characters.

Gets the identifier for the decimal numeral system using ZmthSans (Mathematical notation) characters.

The string "ZmthSans", which identifies the decimal numeral system using ZmthSans (Mathematical notation) characters.

A container for character group information. Characters are grouped in an index that enables an application to determine where the grouping boundaries are.

Gets the first item that appears in the grouping under this index.

The string that defines the start of the group that has the associated label. The start of the next group implicitly determines its end.

Gets the label that is associated with this index.

The string to use as the label for all strings of this group. This string may be empty, in which case the label is considered to be "other".

Contains the set of character groups and the functionality to get the label for any given string.

Create a CharacterGroupings object for the default collation.

Create a CharacterGroupings object for the collation belonging to the given language.

Gets the number of CharacterGrouping objects in the set of character groups.

The number of objects in the set.

Returns an iterator to enumerate the items in the set of character groups.

The iterator. The current position of the iterator is index 0, or the end of the set of character groups if the set is empty.

Returns the CharacterGrouping at the specified index in the set of character groups.

The zero-based index of the CharacterGrouping in the set to return. The CharacterGrouping at the specified index.

Returns the CharacterGrouping objects that start at the specified index in the set of character groups.

The zero-based index of the start of the CharacterGrouping objects in the set to return. The CharacterGrouping objects in the set that start at *startIndex*. The number of objects returned.

Returns the index of a specified CharacterGrouping object in the set of character groups.

The CharacterGrouping object to find in the set. The zero-based index of the CharacterGrouping object, if found. The method returns zero if the object is not found. True if the object is found, otherwise false.

Gets the label under which the provided text falls.

The string for which to get the label. If successful, this method returns the label. Otherwise, it returns the input value.

Formats dates and times.

Creates a DateTimeFormatter object that is initialized by a format template string.

A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the DateTimeFormatter class for a list of valid format templates and format patterns.

Creates a DateTimeFormatter object that is initialized by a format template string and language list.

A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the DateTimeFormatter class for a list of valid format templates and format patterns. The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks.

Creates a DateTimeFormatter object that is initialized by a format template string, language list, geographic region, calendar, and clock.

A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the DateTimeFormatter class for a list of valid format templates and format patterns. The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. The identifier for the geographic region. This identifier is used for resolving the template to a pattern. The calendar identifier to use. The clock identifier to use.

Creates a DateTimeFormatter object that is initialized with hour, minute, and second formats.

The desired hour format to include in the template. The desired minute format to include in the template. The desired second format to include in the template.

Creates a DateTimeFormatter object that is initialized with year, month, day, and day of week formats.

The desired year format to include in the template. The desired month format to include in the template. The desired day format to include in the template. The desired day of week format to include in the template.

Creates a DateTimeFormatter object that is initialized with year, month, day, day of week, hour, minute, and second formats, and a language list.

The year format to include in the template. The month format to include in the template. The day format to include in the template. The day of week format to include in the template. The hour format to include in the template. The minute format to include in the template. The second format to include in the template. The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern and for formatting. See Remarks.

Creates a DateTimeFormatter object with all formats and identifiers specified.

The desired year format to include in the template. The desired month format to include in the template. The desired day format to include in the template. The desired day of week format to include in the template. The desired hour format to include in the template. The desired minute format to include in the template. The desired second format to include in the template. The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks. The identifier for the geographic region. This identifier is used for resolving the template to a pattern. The calendar identifier to use. The clock identifier to use.

Gets the calendar that is used when formatting dates.

The calendar that is used.

Gets the clock that is used when formatting times.

The clock that is used.

Gets or sets the region that is used when formatting dates and times.

The region that is used.

Gets the DayFormat in the template.

Specifies whether the day is included. If it is, this property specifies the format for the day in the template.

Gets the DayOfWeekFormat in the template.

Specifies whether the day of week is included. If it is, this property specifies the format for the day of week in the template.

Gets the HourFormat in the template.

Specifies whether the hour is included. If it is, this property specifies the format for the hour in the template.

Gets the MinuteFormat in the template.

Specifies whether the minute is included. If it is, this property specifies the format for the minute in the template.

Gets the MonthFormat in the template.

Specifies whether the month is included. If it is, this property specifies the format for the month in the template.

Gets the SecondFormat in the template.

Specifies whether the second is included. If it is, this property specifies the format for the second in the template.

Gets the YearFormat in the template.

Specifies whether the year is included. If it is, this format specifies the format for the year in the template.

Gets the priority list of language identifiers that is used when formatting dates and times.

The list of languages that is used.

Gets the DateTimeFormatter object that formats dates according to the user's choice of long date pattern.

A DateTimeFormatter object equivalent to one constructed with the "longdate" template.

Gets the DateTimeFormatter object that formats times according to the user's choice of long time pattern.

A DateTimeFormatter object equivalent to one constructed with the "longtime" template.

Gets or sets the numbering system that is used to format dates and times.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥ ٦٧٨٩).

Gets the patterns corresponding to this template that are used when formatting dates and times.

The pattern that provides the requested components in the template. See the remarks for the DateTimeFormatter class for a list of valid format patterns.

Gets the geographic region that was most recently used to format dates and times.

The geographic region that was most recently used to format dates and times.

Gets the language that was most recently used to format dates and times.

The language from the priority list of language identifiers that was most recently used to format dates and times.

Gets the DateTimeFormatter object that formats dates according to the user's choice of short date pattern.

A DateTimeFormatter object equivalent to one constructed with the "shortdate" template.

Gets the DateTimeFormatter object that formats times according to the user's choice of short time pattern.

A DateTimeFormatter object equivalent to one constructed with the "shorttime" template.

Gets a string representation of this format template.

A string that represents this format template. If the DateTimeFormatter object was constructed with a format template or format enumerations, the string can be used to construct the same DateTimeFormatter. If a pattern was used to construct the DateTimeFormatter, this property returns the empty string. See the remarks for the DateTimeFormatter class for a list of valid format templates.

Returns a string representation of the provided date and time.

The DateTime to be formatted. A string that represents the date and time.

Returns a string that represents the given date and time in the given time zone, conforming to the template the formatter is currently using.

The DateTime to be formatted. An identifier from the IANA Time Zone Database that identifies the time zone to use (for example, "Americas/Los_Angeles" for Pacific Time). A string that represents the date, time, and time zone.

Specifies the intended format for the day in a DateTimeFormatter object.

Display the day in the most natural way. This will depend on the context, such as the language or calendar (for example, for the Hebrew calendar and Hebrew language, use the Hebrew numbering system).

Do not display the day.

Specifies the intended format for the day of the week in a DateTimeFormatter object.

Display an abbreviated version of the day of the week (for example, "Thur" for Thursday).

Display the day of the week in the most natural way. It may be abbreviated or full depending on the context, such as the language or calendar that is being used.

Display the day of the week in its entirety (for example, "Thursday").

Do not display the day of the week.

Specifies the intended format for the hour in a DateTimeFormatter object.

Display the hour in the most natural way. This will depend on the context, such as the language or clock that is being used.

Do not display the hour.

Specifies the intended format for the minute in a DateTimeFormatter object.

Display the minute in the most natural way. This will depend on the context, such as the language or clock that is being used.

Do not display the minute.

Specifies the intended format for the month in a DateTimeFormatter object.

Display an abbreviated version of the month (for example, "Sep" for September).

Display the month in the most natural way. It may be abbreviated, full, or numeric depending on the context, such as the language or calendar that is being used.

Display the month in its entirety (for example, "September").

Do not display the month.

Display the month as a number (for example, "9" for September).

Specifies the intended format for the second in a DateTimeFormatter object.

Display the second in the most natural way. This will depend on the context, such as the language or clock that is being used.

Do not display the second.

Specifies the intended format for the year in a DateTimeFormatter object.

Display an abbreviated version of the year (for example, "11" for Gregorian 2011).

Display the year in the most natural way. It may be abbreviated or full depending on the context, such as the language or calendar that is being used.

Display the year in its entirety (for example, "2011" for Gregorian 2011).

Do not display the year.

Provides data related to a particular font recommendation for a given language.

Gets the family name of the font.

The font family name.

Gets the FontStretch property of the font.

The FontStretch property.

Gets the FontStyle property of the font.

The FontStyle property.

Gets the weight of the font (FontWeight ).

The weight of the font.

Gets a recommended font size scaling factor for the font.

The recommended font size scaling factor.

Supplies a set of font recommendations for a given language or script for various usage cases.

Creates a LanguageFontGroup object for a given language or script.

A BCP-47 language tag, or an ISO 15924 script identifier.

Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by DocumentHeadingFont, ModernDocumentFont and TraditionalDocumentFont.

The recommended LanguageFont, or **NULL** if no font recommendation is available.

Gets a font that is recommended as an additional option for use in documents beyond the recommendations provided by DocumentHeadingFont, ModernDocumentFont and TraditionalDocumentFont.

The recommended LanguageFont, or **NULL** if no font recommendation is available.

Gets a font that is recommended for use in document headings.

The recommended LanguageFont.

Gets a font that is recommended for displaying fixed-width characters.

The recommended LanguageFont, or **NULL** if no font recommendation is available.

Gets a font that is recommended for typical document body text following modern style conventions.

The recommended LanguageFont.

Gets a font that is recommended for typical document body text following traditional style conventions.

The recommended LanguageFont.

Gets a font that is recommended for special UI elements, such as captions, that are displayed at sizes smaller than typical UI body text.

The recommended LanguageFont.

Gets a font that is recommended for special UI elements, such as headings, that are displayed at sizes somewhat larger than typical UI body text.

The recommended LanguageFont.

Gets a font that is recommended for special UI elements, such as headings in notifications or other app messages, that are displayed at UI  body text size or only slightly larger yet need to be differentiated from UI body text.

The recommended LanguageFont.

Gets a font that is recommended for typical UI body text.

The recommended LanguageFont.

Gets a font that is recommended for special UI elements set at sizes much larger than typical UI body text.

The recommended LanguageFont.

Formats and parses currencies.

Creates a CurrencyFormatter object that is initialized with a currency identifier.

The currency identifier to use when formatting and parsing currency values.

Creates a CurrencyFormatter object initialized with a currency identifier, language list, and geographic region.

The currency identifier to use when formatting and parsing currency values. The list of language identifiers, in priority order, representing the choice of languages. See Remarks. The identifier for the geographic region.

Gets the identifier for the currency to be used for formatting and parsing currency values.

The currency identifier to use when formatting and parsing currency values.

Gets or sets the minimum number of digits to display for the fraction part of the currency value.

The minimum number of digits to display.

Gets the region that is used when formatting and parsing currency values.

The region that is used.

Gets or sets the minimum number of digits to display for the integer part of the currency value.

The minimum number of digits to display.

Gets or sets whether the decimal point of the currency value should always be displayed.

**True** if the decimal point of the value should always be displayed, and **false** otherwise.

Gets or sets whether the integer part of the currency value should be grouped. The default value is `false`.

`true` if the integer part of the value should be grouped, otherwise `false`.

Gets or sets whether -0 is formatted using the conventions for negative numbers or for positive numbers. (In the Latin numeral system, the choice is "-0" or "0".)

**True** if -0 is formatted as a negative number, and **false** if -0 is formatted as a positive number ("-0" or "0" in the Latin numeral system).

Gets the priority list of language identifiers that is used when formatting and parsing currency values.

The priority list of language identifiers.

Gets or sets whether the currency is formatted with the currency symbol or currency code.

The CurrencyFormatterMode value which specifies how the currency is formatted.

Gets or sets the current rounding strategy to be used when formatting currency amounts.

A number rounder object: IncrementNumberRounder or SignificantDigitsNumberRounder.

Gets or sets the numbering system that is used to format and parse currency values.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the geographic region that was most recently used to format or parse currency values.

The geographic region that was most recently used to format or parse currency values.

Gets the language that was most recently used to format or parse currency values.

The language from the priority list of language identifiers that was most recently used to format or parse currency values.

Gets or sets the current padding to significant digits when a currency amount is formatted.

The number of significant digits.

Applies the specified rounding algorithm to the CurrencyFormatter.

A value of the RoundingAlgorithm enumeration.

Returns a string representation of a **Double** currency value.

The **Double** currency value to be formatted. A string that represents the value.

Returns a string representation of an **Int64** currency value.

The **Int64** currency value to be formatted. A string that represents the value.

Returns a string representation of a **UInt64** currency value.

The **UInt64** currency value to be formatted. A string that represents the value.

Returns a string representation of a **Double** currency value.

The **Double** currency value to be formatted. A string that represents the value.

Returns a string representation of an **Int64** currency value.

The **Int64** currency value to be formatted. A string that represents the value.

Returns a string representation of a **UInt64** currency value.

The **UInt64** currency value to be formatted. The **UInt64** currency value to be formatted.

Attempts to parse a string representation of a **Double** currency value.

The text to be parsed. If successful, a **Double** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an integer currency value.

The text to be parsed. If successful, an **Int64** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an unsigned integer currency value.

The text to be parsed. If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**.

Specifies the use of symbols or codes when currency is formatted.

Currencies are formatted with the Currency code provided to the CurrencyFormatter object (for example, 15 USD).

Default behavior. Currencies are formatted with the appropriate currency symbol (for example, $15).

Formats and parses decimal numbers.

Creates a DecimalFormatter object and initializes it to default values.

Creates a DecimalFormatter object initialized by a language list and a geographic region.

The list of language identifiers, in priority order, representing the choice of languages. See Remarks. The identifier for the geographic region.

Gets or sets the minimum number of digits to display for the fraction part of the number.

The minimum number of digits to display.

Gets the region that is used when formatting and parsing decimal numbers.

The region that is used.

Gets or sets the minimum number of digits to display for the integer part of the number.

The minimum number of digits to display.

Gets or sets whether the decimal point of the number should always be displayed.

**True** if the decimal point of the number should always be displayed, and **false** otherwise.

Gets or sets whether the integer part of the number should be grouped.

**True** if the integer part of the number should be grouped, and **false** otherwise.

Gets or sets whether -0 is formatted as "-0" or "0".

**True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0".

Gets the priority list of language identifiers that is used when formatting and parsing decimal numbers.

The priority list of language identifiers.

Gets or sets the current rounding strategy to be used when formatting numbers.

A number rounder object: IncrementNumberRounder or SignificantDigitsNumberRounder.

Gets or sets the numbering system that is used to format and parse decimal numbers.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the geographic region that was most recently used to format or parse decimal values.

The geographic region that was most recently used to format or parse decimal values.

Gets the language that was most recently used to format or parse decimal values.

The language from the priority list of language identifiers that was most recently used to format or parse decimal values.

Gets or sets the current padding to significant digits when a decimal number is formatted.

The number of significant digits.

Returns a string representation of a **Double** number.

The **Double** value to be formatted. A string that represents the number.

Returns a string representation of an **Int64** number.

The **Int64** value to be formatted. A string that represents the number.

Returns a string representation of a **UInt64** number.

The **UInt64** value to be formatted. A string that represents the number.

Returns a string representation of a **Double** number.

The **Double** value to be formatted. A string that represents the number.

Returns a string representation of an **Int64** number.

The **Int64** value to be formatted. A string that represents the number.

Returns a string representation of a **UInt64** number.

The **UInt64** value to be formatted. A string that represents the number.

Attempts to parse a string representation of a **Double** number.

The text to be parsed. If successful, a **Double** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an integer.

The text to be parsed. If successful, an **Int64** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an unsigned integer.

The text to be parsed. If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**.

Rounds numbers to a specified increment.

Creates an IncrementNumberRounder object.

Gets or sets the increment this IncrementNumberRounder object uses for rounding.

The increment used for rounding.

Gets or sets the rounding algorithm used when incrementing.

A value of the RoundingAlgorithm enumeration.

Rounds a **Double** number to the specified increment.

The **Double** value to be rounded. The rounded number. This result is a double precision floating point number, which is not necessarily an integer.

Rounds an **Int32** number to the specified increment.

The **Int32** value to be rounded. The rounded 32 bit integer.

Rounds an **Int64** number to the specified increment.

The **Int64** value to be rounded. The rounded 64 bit integer.

Rounds a **Single** number to the specified increment.

The **Single** value to be rounded. The rounded number. This result is a single precision floating point number, which is not necessarily an integer.

Rounds a **UInt32** number to the specified increment.

The **UInt32** value to be rounded. The rounded unsigned 32 bit integer.

Rounds a **UInt64** number to the specified increment.

The **UInt64** value to be rounded. The rounded unsigned 64 bit integer.

An interface that returns a string representation of a provided value, using an overloaded Format method to format several data types.

Returns a string representation of a **Double** value.

The **Double** value to be formatted. A string that represents the value.

Returns a string representation of an **Int64** value.

The **Int64** value to be formatted. A string that represents the value.

Returns a string representation of a **UInt64** value.

The **UInt64** value to be formatted. A string that represents the value.

An interface that returns a string representation of a provided value, using distinct format methods to format several data types.

Returns a string representation of a **Double** value.

The **Double** value to be formatted. A string that represents the value.

Returns a string representation of an **Int64** value.

The **Int64** value to be formatted. A string that represents the value.

Returns a string representation of a **UInt64** value.

The **UInt64** value to be formatted. A string that represents the value.

An interface that gets and sets options for formatting numbers.

Gets or sets the minimum number of digits to display for the fraction part of the number.

The minimum number of digits to display.

Gets the region that is used when formatting and parsing numbers.

The region that is used.

Gets or sets the minimum number of digits to display for the integer part of the number.

The minimum number of digits to display.

Gets or sets whether the decimal point of the number should always be displayed.

**True** if the decimal point of the number should always be displayed, and **false** otherwise.

Gets or sets whether the integer part of the number should be grouped.

**True** if the integer part of the number should be grouped, and **false** otherwise.

Gets the priority list of language identifiers that is used when formatting and parsing numbers.

The priority list of language identifiers.

Gets or sets the numbering system that is used to format and parse numbers.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the geographic region that was most recently used to format or parse numbers.

The geographic region that was most recently used to format or parse numbers.

Gets the language that was most recently used to format or parse numbers.

The language from the priority list of language identifiers that was most recently used to format or parse numbers.

An interface that parses a string representation of a numeric value.

Attempts to parse a string representation of a **Double** numeric value.

The text to be parsed. If successful, a **Double** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an integer numeric value.

The text to be parsed. If successful, an **Int64** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an unsigned integer numeric value.

The text to be parsed. If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**.

An interface that returns rounded results for provided numbers of several data types.

Rounds a **Double** number.

The **Double** value to be rounded. The rounded number. This result is a double precision floating point number, which is not necessarily an integer.

Rounds an **Int32** number.

The **Int32** value to be rounded. The rounded 32 bit integer.

Rounds an **Int64** number.

The **Int64** value to be rounded. The rounded 64 bit integer.

Rounds a **Single** number.

The **Single** value to be rounded. The rounded number. This result is a single precision floating point number, which is not necessarily an integer.

Rounds a **UInt32** number.

The **UInt32** value to be rounded. The rounded unsigned 32 bit integer.

Rounds a **UInt64** number.

The **UInt64** value to be rounded. The rounded unsigned 64 bit integer.

An interface that gets and sets the option for rounding numbers.

Gets or sets the interface used to return rounded numbers.

An interface for returning rounded numbers.

An interface that gets and sets the option for specifying whether -0 is formatted as "-0" or "0".

Gets or sets whether -0 is formatted as "-0" or "0".

**True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0".

An interface that gets and sets the option for specifying significant digits.

Gets or sets the number of significant digits used in formatting or rounding numbers.

The number of significant digits.

Translates digits of the Latin numerical system into digits of another numerical system.

Creates a NumeralSystemTranslator object initialized by the list of current runtime language values preferred by the user.

Creates a NumeralSystemTranslator object initialized by a language list.

A list of BCP-47 language tags, in priority order, representing the choice of languages. They must all be well-formed according to Windows.Globalization.Language.isWellFormed.

Gets the BCP-47 language tag(s) used to initialize this NumeralSystemTranslator object.

The BCP-47 language tag(s) used to initialize this NumeralSystemTranslator object. There is always at least one.

Gets or sets the numeral system that Latin digits will be converted to on calls to TranslateNumerals.

A string that indicates the target numeral system of the translator, such as "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the language used to determine the numeral system when this object was initialized.

The particular BCP-47 language tag used during the construction of this object to determine the initial value of NumeralSystem.

Converts a string of characters containing Latin digits to a string containing the corresponding digits of NumeralSystem.

A string of characters containing Latin digits to be converted. A string containing the converted digits. This string may be a different length than *value*.

Formats and parses percentages.

Creates a PercentFormatter object and initializes it to default values.

Creates a PercentFormatter object initialized by a language list and a geographic region.

The list of language identifiers, in priority order, representing the choice of languages. See Remarks. The identifier for the geographic region.

Gets or sets the minimum number of digits to display for the fraction part of the percentage.

The minimum number of digits to display.

Gets the region that is used when formatting and parsing percentages.

The region that is used.

Gets or sets the minimum number of digits to display for the integer part of the percentage.

The minimum number of digits to display.

Gets or sets whether the decimal point of the percentage should always be displayed.

**True** if the decimal point of the percentage should always be displayed, and **false** otherwise.

Gets or sets whether the integer part of the percentage should be grouped.

**True** if the integer part of the percentage should be grouped, and **false** otherwise.

Gets or sets whether -0 is formatted as "-0" or "0".

**True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0".

Gets the priority list of language identifiers that is used when formatting and parsing percentages.

The priority list of language identifiers.

Gets or sets the current rounding strategy to be used when formatting percents.

A number rounder object: IncrementNumberRounder or SignificantDigitsNumberRounder.

Gets or sets the numbering system that is used to format and parse percentages.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the geographic region that was most recently used to format or parse percent values.

The geographic region that was most recently used to format or parse percent values.

Gets the language that was most recently used to format or parse percent values.

The language from the priority list of language identifiers that was most recently used to format or parse percent values.

Gets or sets the current padding to significant digits when a percent is formatted.

The number of significant digits.

Returns a string representation of a **Double** percentage.

The **Double** value to be formatted. A string that represents the percentage.

Returns a string representation of an **Int64** percentage.

The **Int64** value to be formatted. A string that represents the percentage.

Returns a string representation of a **UInt64** percentage.

The **UInt64** value to be formatted. A string that represents the percentage.

Returns a string representation of a **Double** percentage.

The **Double** value to be formatted. A string that represents the percentage.

Returns a string representation of an **Int64** percentage.

The **Int64** value to be formatted. A string that represents the percentage.

Returns a string representation of a **UInt64** percentage.

The **UInt64** value to be formatted. A string that represents the percentage.

Attempts to parse a string representation of a **Double** percentage.

The text to be parsed. If successful, a **Double** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an integer percentage.

The text to be parsed. If successful, an **Int64** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an unsigned integer percentage.

The text to be parsed. If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**.

Formats and parses permillages.

Creates a PermilleFormatter object and initializes it to default values.

Creates a PermilleFormatter object initialized by a language list and a geographic region.

The list of language identifiers, in priority order, representing the choice of languages. See Remarks. The identifier for the geographic region.

Gets or sets the minimum number of digits to display for the fraction part of the permillage.

The minimum number of digits to display.

Gets the region that is used when formatting and parsing permille values.

The region that is used.

Gets or sets the minimum number of digits to display for the integer part of the permillage.

The minimum number of digits to display.

Gets or sets whether the decimal point of the permillage should always be displayed.

**True** if the decimal point of the permillage should always be displayed, and **false** otherwise.

Gets or sets whether the integer part of the permillage should be grouped.

**True** if the integer part of the permillage should be grouped, and **false** otherwise.

Gets or sets whether -0 is formatted as "-0" or "0".

**True** if -0 is formatted as "-0", and **false** if -0 is formatted as "0".

Gets the priority list of language identifiers that is used when formatting and parsing permille values.

The priority list of language identifiers.

Gets or sets the current rounding strategy to be used when formatting permilles.

A number rounder object: IncrementNumberRounder or SignificantDigitsNumberRounder.

Gets or sets the numbering system that is used to format and parse permille values.

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported [NumeralSystem values](https://docs.microsoft.com/previous-versions/windows/apps/jj236471(v=win.10)).

Gets the geographic region that was most recently used to format or parse permille values.

The geographic region that was most recently used to format or parse permille values.

Gets the language that was most recently used to format or parse permille values.

The language from the priority list of language identifiers that was most recently used to format or parse permille values.

Gets or sets the current padding to significant digits when a permille is formatted.

The number of significant digits.

Returns a string representation of a **Double** permillage.

The **Double** value to be formatted. A string that represents the permillage.

Returns a string representation of an **Int64** permillage.

The **Int64** value to be formatted. A string that represents the permillage.

Returns a string representation of a **UInt64** permillage.

The **UInt64** value to be formatted. A string that represents the permillage.

Returns a string representation of a **Double** permillage.

The **Double** value to be formatted. A string that represents the permillage.

Returns a string representation of an **Int64** permillage.

The **Int64** value to be formatted. A string that represents the permillage.

Returns a string representation of a **UInt64** permillage.

The **UInt64** value to be formatted. A string that represents the permillage.

Attempts to parse a string representation of a **Double** permillage.

The text to be parsed. If successful, a **Double** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an integer permillage.

The text to be parsed. If successful, an **Int64** that corresponds to the string representation, and otherwise **null**.

Attempts to parse a string representation of an unsigned integer permillage.

The text to be parsed. If successful, a **UInt64** that corresponds to the string representation, and otherwise **null**.

Specifies the algorithm used to round numbers.

**Do not use.**

Round away from zero. This is the equivalent of **RoundUp** if the input is positive, or **RoundDown** if the input is negative.

Round towards negative infinity. (Return the largest integer, increment, or significant digit which does not exceed the input.)

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, this is the equivalent of **RoundAwayFromZero**.

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, this is the equivalent of **RoundDown**.

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, round to the nearest even output.

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, round to the nearest odd output.

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, this is the equivalent of **RoundTowardsZero**.

Round to the integer, increment, or significant digit that is closest to the input. If the input is exactly halfway between the possible outputs, this is the equivalent of **RoundUp**.

Round towards zero. This is the equivalent of **RoundDown** if the input is positive, or **RoundUp** if the input is negative.

Round towards infinity. (Return the smallest integer, increment, or significant digit which is not less than the input.)

Rounds numbers to a specified number of significant digits.

Creates a SignificantDigitsNumberRounder object.

Gets or sets the rounding strategy value for this SignificantDigitsNumberRounder object.

A value of the RoundingAlgorithm enumeration.

Gets or sets the number of significant digits this SignificantDigitsNumberRounder object uses for rounding.

The number of significant digits used for rounding.

Rounds a **Double** number to the specified number of significant digits.

The **Double** value to be rounded. The rounded number. This result is a double precision floating point number, which is not necessarily an integer.

Rounds an **Int32** number to the specified number of significant digits.

The **Int32** value to be rounded. The rounded 32 bit integer.

Rounds an **Int64** number to the specified number of significant digits.

The **Int64** value to be rounded. The rounded 64 bit integer.

Rounds a **Single** number to the specified number of significant digits.

The **Single** value to be rounded. The rounded number. This result is a single precision floating point number, which is not necessarily an integer.

Rounds a **UInt32** number to the specified number of significant digits.

The **UInt32** value to be rounded. The rounded unsigned 32 bit integer.

Rounds a **UInt64** number to the specified number of significant digits.

The **UInt64** value to be rounded. The rounded unsigned 64 bit integer.

Lists phone number formats supported by this API.

Format specified in International Telecommunication Union (ITU-T) recommendation E.164.

International format as specified in ITU-T recommendation E.123.

National format as specified in ITU-T recommendation E.123.

Format specified in RFC 3966, the `tel:` URI for telephone numbers.

Formats phone numbers.

Creates a PhoneNumberFormatter object, using the current default region.

Returns a string representation of the provided phone number.

The phone number to be formatted. The PhoneNumberInfo specifies not just the subscriber number, but also other relevant information such as country code. A string containing the formatted phone number, using the default format for the region specified when this PhoneNumberFormatter was created.

Returns a string representing the given phone number, using the given format.

The phone number to be formatted. The PhoneNumberInfo specifies not just the subscriber number, but also other relevant information such as country code. The specific format to be used. A string containing the phone number, in the specified format.

Returns a string representing the formatted partial phone number given.

A string representing a partial phone number. The input string, formatted as a partial phone number.

Returns the input string, formatted as a phone number.

The input string to be formatted. The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created.

Returns the input string, formatted as a phone number, surrounded by Unicode Left to Right (LTR) markers.

The input string to be formatted. The input string, formatted as a phone number, using the region specified when this PhoneNumberFormatter was created. The string is surrounded by Unicode Left to Right (LTR) markers.

Static method that returns the country code for a given region code.

The two-letter ISO region code. The telephone country code, as an integer.

Static method that returns the national direct dialing prefix for the given region.

The region code of interest. When **true**, all non-digit characters are stripped from the returned string. The national direct dialing prefix for the given region.

Attempts to create a PhoneNumberFormatter for a given region code, and doesn't throw on failure.

The region code of the new PhoneNumberFormatter. On success, a new PhoneNumberFormatter for the requested region code.

Wraps a string with Unicode Left to Right (LTR) markers.

The string to be surrounded with LTR markers. The input string, surrounded with LTR markers.

Information about a phone number.

Constructor.

A phone number that the created object will encapsulate.

Gets the two-letter country code for this phone number.

A country code.

Gets the phone number.

The phone number.

Compares two PhoneNumberInfo objects.

The number to be compared to this object. An enumeration value describing the result of the comparison.

Gets the geographic region code for this number.

A string representing the geographic region code.

Gets the length in characters of the geographical area code.

Length, in characters, of the area code.

Gets the length, in characters, of the national destination code.

The length of the national destination code.

Gets the national significant number of this object.

The national significant number.

Heuristically predicts what kind of number is represented in this object.

An enumeration value describing the kind of phone number this object represents.

Renders the phone number as a string.

The number, rendered as a string.

Static method that attempts to parse a given input string as a phone number (using a given region code) and creates a PhoneNumberInfo encapsulating it.

A phone number, in string form. The two-letter region code to be used to parse *input*. Region codes should use upper-case letters. On success, this object encapsulates the given phone number. An enumeration value giving details of the attempt to parse *input*.

Static method that attempts to parse a given input string as a phone number, and creates a PhoneNumberInfo encapsulating it.

A phone number, in string form. On success, this object encapsulates the given phone number. An enumeration value giving details of the attempt to parse *input*.

The result of calling the PhoneNumberInfo.CheckNumberMatch method.

The two numbers are an exact match.

The entire national significant part (area code and subscriber number) of the two numbers match.

The two numbers do not match.

The short national significant part (the subscriber number) of the two numbers match.

Describes the results of trying to parse a string into a phone number.

The prospective number has an invalid country code, and is not valid.

The prospective number is not valid.

The prospective number is too long, and is not valid.

The prospective number is too short, and is not valid.

The prospective number has been parsed, and is valid.

The kinds of phone numbers returned by PhoneNumberInfo.PredictNumberKind.

A fixed telephone line.

Either a fixed line or a mobile line.

A mobile line.

A number that reaches a pager.

A number that reaches a private individual.

A number that charges a premium rate to connect.

A shared-cost service (caller pays part of the cost, recipient pays the rest.)

A toll-free number.

A category that includes national services and corporate, institutional, or private network access numbers.

A number that is none of the other kinds in this enumeration, or whose precise kind is not known.

A number that reaches a voicemail service.

A VOIP (Voice over IP) line.

Corresponds to the LUID (Locally Unique Identifier) associated with a graphics adapter.

The high part of the LUID.

The low part of the LUID.

Allows for classes that implement this interface to be expressed as a CompositionPath for the purposes of using the Windows.UI.Composition APIs.

Defines a point in a two-dimensional plane.

The X coordinate value of a point.

The Y coordinate value of a point.

Defines the size and location of a rectangular surface.

The height of a rectangle.

The width of a rectangle.

The X coordinate at the center of a rectangle.

The Y coordinate at the center of a rectangle.

Defines the height and wide of a surface in a two-dimensional plane.

The height of a surface.

The width of a surface.

A frame captured by the application.

The content size at the time the frame was rendered.

The content size at the time the frame was rendered.

The Direct3D surface on which the frame was drawn.

The Direct3D surface on which the frame was drawn.

The QPC (Query Performance Counter) time at which the compositor rendered the frame.

The QPC (Query Performance Counter) time at which the compositor rendered the frame.

Releases the captured frame from memory.

Stores frames captured by the application.

The **DispatcherQueue** for the frame pool.

The **DispatcherQueue** for the frame pool.

An event raised when a captured frame is stored in the frame pool.

Disposes of the capture frame pool and releases its resources.

Creates a frame pool.

The Direct3D device. The DirectX pixel format of the captured frames. The number of buffers in which to store captured frames. The size of each buffer. A frame pool created with the given inputs.

Creates a capture session based on the given capture item and frame pool.

The capture item (the target of the capture). A capture session created from the given capture item and frame pool.

Creates a frame pool where the dependency on the DispatcherQueue is removed and the FrameArrived event is raised on the frame pool's internal worker thread.

The Direct3D device. The DirectX pixel format of the captured frames. The number of buffers in which to store captured frames. The size of each buffer. A frame pool created with the given inputs.

Recreates the frame pool based on the given inputs.

The Direct3D device. The DirectX pixel format of the captured frames. The number of buffers in which to store captured frames. The size of each buffer.

Tries to get the next captured frame from the frame pool.

The next captured frame in the frame pool; if the pool is empty, this method returns **null**.

The target of the capture, chosen with the picker control.

The display name of the target of the capture (for example, the application title).

The display name of the target of the capture (for example, the application title).

The size of the target of the capture.

The size of the target of the capture.

An event raised when the target of the capture has been closed.

Constructs a GraphicsCaptureItem that represents the given Visual.

The **Visual** with which to construct the **GraphicsCaptureItem**. A **GraphicsCaptureItem** that represents the given **Visual**.

A system picker UI control that allows the customer to select an item on the screen to capture.

Constructs an instance of a capture picker.

Opens the capture picker and allows the customer to pick a target on the screen to capture.

The capture item representing the target that the customer picked.

Allows the application to take screen captures.

Gets or sets a value specifying whether the capture session will include the cursor in the captured content.

True if the cursor should be captured; otherwise, false.

Closes the capture session and releases resources.

Returns true if screen capture is supported on the device.

True if screen capture is supported on the device.

Starts the capture session, allowing the application to capture frames.

Identifies the alpha value, transparency behavior, of a surface. This is a Windows Runtime equivalent of the Desktop DXGI_ALPHA_MODE enumeration.

Indicates to ignore the transparency behavior.

Indicates that the transparency behavior is premultiplied. Each color is first scaled by the alpha value. The alpha value itself is the same in both straight and premultiplied alpha. Typically, no color channel value is greater than the alpha channel value. If a color channel value in a premultiplied format is greater than the alpha channel, the standard source-over blending math results in an additive blend.

Indicates that the transparency behavior is not premultiplied. The alpha channel indicates the transparency of the color.

Indicates that the transparency behavior is not specified.

This is a Windows Runtime equivalent of the Desktop DXGI_COLOR_SPACE_TYPE enumeration.

Corresponds to **DXGI_COLOR_SPACE_RESERVED**.

Corresponds to **DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709**.

Corresponds to **DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020**.

Corresponds to **DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P2020**.

Corresponds to **DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709**.

Corresponds to **DXGI_COLOR_SPACE_RGB_STUDIO_G2084_NONE_P2020**.

Corresponds to **DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P2020**.

Corresponds to **DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P709**.

Corresponds to **DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P2020**.

Corresponds to **DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P709**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P601**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P709**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_FULL_GHLG_TOPLEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_LEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_TOPLEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_TOPLEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P709**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_TOPLEFT_P2020**.

Corresponds to **DXGI_COLOR_SPACE_YCBCR_STUDIO_GHLG_TOPLEFT_P2020**.

Specifies pixel formats, which includes fully-typed and type-less formats. This is a Windows Runtime equivalent of the Desktop DXGI_FORMAT enumeration.

See DXGI_FORMAT_A8P8.

See DXGI_FORMAT_A8_UNORM.

See DXGI_FORMAT_AI44.

See DXGI_FORMAT_AYUV.

See DXGI_FORMAT_B4G4R4A4_UNORM.

See DXGI_FORMAT_B5G5R5A1_UNORM.

See DXGI_FORMAT_B5G6R5_UNORM.

See DXGI_FORMAT_B8G8R8A8_TYPELESS.

See DXGI_FORMAT_B8G8R8A8_UNORM.

See DXGI_FORMAT_B8G8R8A8_UNORM_SRGB.

See DXGI_FORMAT_B8G8R8X8_TYPELESS.

See DXGI_FORMAT_B8G8R8X8_UNORM.

See DXGI_FORMAT_B8G8R8X8_UNORM_SRGB.

See DXGI_FORMAT_BC1_TYPELESS.

See DXGI_FORMAT_BC1_UNORM.

See DXGI_FORMAT_BC1_UNORM_SRGB.

See DXGI_FORMAT_BC2_TYPELESS.

See DXGI_FORMAT_BC2_UNORM.

See DXGI_FORMAT_BC2_UNORM_SRGB.

See DXGI_FORMAT_BC3_TYPELESS.

See DXGI_FORMAT_BC3_UNORM.

See DXGI_FORMAT_BC3_UNORM_SRGB.

See DXGI_FORMAT_BC4_SNORM.

See DXGI_FORMAT_BC4_TYPELESS.

See DXGI_FORMAT_BC4_UNORM.

See DXGI_FORMAT_BC5_SNORM.

See DXGI_FORMAT_BC5_TYPELESS.

See DXGI_FORMAT_BC5_UNORM.

See DXGI_FORMAT_BC6H_SF16.

See DXGI_FORMAT_BC6H_UF16.

See DXGI_FORMAT_BC6H_TYPELESS.

See DXGI_FORMAT_BC7_TYPELESS.

See DXGI_FORMAT_BC7_UNORM.

See DXGI_FORMAT_BC7_UNORM_SRGB.

See DXGI_FORMAT_D16_UNORM.

See DXGI_FORMAT_D24_UNORM_S8_UINT.

See DXGI_FORMAT_D32_FLOAT.

See DXGI_FORMAT_D32_FLOAT_S8X24_UINT.

See DXGI_FORMAT_G8R8_G8B8_UNORM.

See DXGI_FORMAT_IA44.

See DXGI_FORMAT_NV11.

See DXGI_FORMAT_NV12.

See DXGI_FORMAT_420_OPAQUE.

See DXGI_FORMAT_P010.

See DXGI_FORMAT_P016.

See DXGI_FORMAT_P208.

See DXGI_FORMAT_P8.

See DXGI_FORMAT_R10G10B10A2_TYPELESS.

See DXGI_FORMAT_R10G10B10A2_UINT.

See DXGI_FORMAT_R10G10B10A2_UNORM.

See DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM.

See DXGI_FORMAT_R11G11B10_FLOAT.

See DXGI_FORMAT_R16_FLOAT.

See DXGI_FORMAT_R16G16B16A16_FLOAT.

See DXGI_FORMAT_R16G16B16A16_SINT.

See DXGI_FORMAT_R16G16B16A16_SNORM.

See DXGI_FORMAT_R16G16B16A16_TYPELESS.

See DXGI_FORMAT_R16G16B16A16_UINT.

See DXGI_FORMAT_R16G16B16A16_UNORM.

See DXGI_FORMAT_R16G16_FLOAT.

See DXGI_FORMAT_R16G16_SINT.

See DXGI_FORMAT_R16G16_SNORM.

See DXGI_FORMAT_R16G16_TYPELESS.

See DXGI_FORMAT_R16G16_UINT.

See DXGI_FORMAT_R16G16_UNORM.

See DXGI_FORMAT_R16_SINT.

See DXGI_FORMAT_R16_SNORM.

See DXGI_FORMAT_R16_TYPELESS.

See DXGI_FORMAT_R16_UINT.

See DXGI_FORMAT_R16_UNORM.

See DXGI_FORMAT_R1_UNORM.

See DXGI_FORMAT_R24G8_TYPELESS.

See DXGI_FORMAT_R24_UNORM_X8_TYPELESS.

See DXGI_FORMAT_R32_FLOAT.

See DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS.

See DXGI_FORMAT_R32G32B32A32_FLOAT.

See DXGI_FORMAT_R32G32B32A32_SINT.

See DXGI_FORMAT_R32G32B32A32_TYPELESS.

See DXGI_FORMAT_R32G32B32A32_UINT.

See DXGI_FORMAT_R32G32B32_FLOAT.

See DXGI_FORMAT_R32G32B32_SINT.

See DXGI_FORMAT_R32G32B32_TYPELESS.

See DXGI_FORMAT_R32G32B32_UINT.

See DXGI_FORMAT_R32G32_FLOAT.

See DXGI_FORMAT_R32G32_SINT.

See DXGI_FORMAT_R32G32_TYPELESS.

See DXGI_FORMAT_R32G32_UINT.

See DXGI_FORMAT_R32G8X24_TYPELESS.

See DXGI_FORMAT_R32_SINT.

See DXGI_FORMAT_R32_TYPELESS.

See DXGI_FORMAT_R32_UINT.

See DXGI_FORMAT_R8G8B8A8_SINT.

See DXGI_FORMAT_R8G8B8A8_SNORM.

See DXGI_FORMAT_R8G8B8A8_TYPELESS.

See DXGI_FORMAT_R8G8B8A8_UINT.

See DXGI_FORMAT_R8G8B8A8_UNORM.

See DXGI_FORMAT_R8G8B8A8_UNORM_SRGB.

See DXGI_FORMAT_R8G8_B8G8_UNORM.

See DXGI_FORMAT_R8G8_SINT.

See DXGI_FORMAT_R8G8_SNORM.

See DXGI_FORMAT_R8G8_TYPELESS.

See DXGI_FORMAT_R8G8_UINT.

See DXGI_FORMAT_R8G8_UNORM.

See DXGI_FORMAT_R8_SINT.

See DXGI_FORMAT_R8_SNORM.

See DXGI_FORMAT_R8_TYPELESS.

See DXGI_FORMAT_R8_UINT.

See DXGI_FORMAT_R8_UNORM.

See DXGI_FORMAT_R9G9B9E5_SHAREDEXP.

See DXGI_FORMAT_SAMPLER_FEEDBACK_MIN_MIP_OPAQUE.

See DXGI_FORMAT_SAMPLER_FEEDBACK_MIP_REGION_USED_OPAQUE.

See DXGI_FORMAT_UNKNOWN.

See DXGI_FORMAT_V208.

See DXGI_FORMAT_V408.

See DXGI_FORMAT_X24_TYPELESS_G8_UINT.

See DXGI_FORMAT_X32_TYPELESS_G8X24_UINT.

See DXGI_FORMAT_Y210.

See DXGI_FORMAT_Y216.

See DXGI_FORMAT_Y410.

See DXGI_FORMAT_Y416.

See DXGI_FORMAT_YUY2.

Values that indicate how the pipeline interprets vertex data that is bound to the input-assembler stage. These primitive topology values determine how the vertex data is rendered on screen. This is a Windows Runtime equivalent of the D3D_PRIMITIVE_TOPOLOGY enumeration.

See D3D_PRIMITIVE_TOPOLOGY_LINELIST.

See D3D_PRIMITIVE_TOPOLOGY_LINESTRIP.

See D3D_PRIMITIVE_TOPOLOGY_POINTLIST.

See D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST.

See D3D_PRIMITIVE_TOPOLOGY_TRIANGLESTRIP.

See D3D_PRIMITIVE_TOPOLOGY_UNDEFINED.

This is a Windows Runtime equivalent of the Desktop D3D11_BIND_FLAG enumeration. Identifies the ways in which a resource may be bound to the graphics pipeline.

Bind a buffer as a constant buffer to a shader stage.

Set this flag to indicate that a 2D texture is used to receive output from the decoder API.

Bind a texture as a depth-stencil target for the output-merger stage.

Bind a buffer as an index buffer to the input-assembler stage.

Bind a texture as a render target for the output-merger stage.

Bind a buffer or texture to a shader stage.

Bind an output buffer for the stream-output stage.

Bind an unordered access resource.

Bind a buffer as a vertex buffer to the input-assembler stage.

Set this flag to indicate that a 2D texture is used to receive input from the video encoder API.

This is a Windows Runtime equivalent of the Desktop DXGI_SAMPLE_DESC structure.

The number of multisamples per pixel.

The image quality level. The higher the quality, the lower the performance.

This is a Windows Runtime equivalent of the Desktop DXGI_SURFACE_DESC structure. Describes an IDirect3DSurface.

Pixel format of the surface.

Height of the surface.

Multi-sampling parameters for the surface.

Width of the surface.

This is a Windows Runtime equivalent of the Desktop D3D11_USAGE enumeration. Identifies expected resource use during rendering. The usage directly reflects whether a resource is accessible by the CPU and/or the graphics processing unit (GPU).

A resource that requires read and write access by the GPU.

A resource that is accessible by both the GPU (read only) and the CPU (write only). A dynamic resource is a good choice for a resource that will be updated by the CPU at least once per frame.

A resource that can only be read by the GPU. It cannot be written by the GPU, and cannot be accessed at all by the CPU. This type of resource must be initialized when it is created, since it cannot be changed after creation.

A resource that supports data transfer (copy) from the GPU to the CPU.

This represents an IDXGIDevice, and can be used to interop between Windows Runtime components that need to exchange **IDXGIDevice** references.

Trims any graphics memory allocated by the graphics device on the app's behalf.

This represents an IDXGISurface and can be used to interop between Windows Runtime components that need to exchange **IDXGISurface** references.

Gets a Direct3DSurfaceDescription describing the surface.

A Direct3DSurfaceDescription describing the surface.

Contains a snapshot of the Advanced Color-related information of a monitor or display driver.

Gets the native Blue color primary for the display.

The native Blue color primary for the display.

Gets the AdvancedColorKind which is currently being set on the display.

The AdvancedColorKind which is currently being set on the display.

Gets the native Green color primary for the display.

The native Green color primary for the display.

Gets the maximum frame average luminance of the display which can be achieved on the whole display.

The maximum frame average luminance of the display which can be achieved on the whole display.

Gets the maximum peak luminance of the display in nits, which is usually valid for a small part of the display.

The maximum peak luminance of the display in nits.

Get the minimum luminance of the display in nits.

The minimum luminance of the display in nits.

Gets the native Red color primary for the display.

The native Red color primary for the display.

Get the luminance value, in nits, which is currently being used by the operating system for all the SDR content on this display.

The luminance value, in nits.

Gets the native white point for the display.

The native white point for the display.

Returns a boolean value that describes if the specified Advanced Color kind value is inherently supported by the monitor or display driver.

The Advanced Color kind to check. **True** if the specified Advanced Color kind is supported; otherwise, **false**.

Returns a boolean value that describes whether the specified HDR metadata format is supported by the display in its current state.

The HDR metadata format to check. **True** if the format is supported; otherwise, **false**.

Describes what kind of Advanced Color the display supports.

The display supports high dynamic range. In this case, it is safe to assume that OS composition is being done using an RGB:FP16 surface encoded as scRGB gamma. The actual wire signalling is usually done using ST2084.

The display only supports standard dynamic range. In this case, it is safe to assume that OS composition is being done using an RGB:8 surface encoded as sRGB gamma. The actual wire signalling is usually done using sRGB.

The display supports Wide Color Gamut. In this case, it is safe to assume that OS composition is being done using an RGB:FP16 surface encoded as scRGB gamma. The actual wire signalling is usually done using sRGB.

Overrides the screen brightness level setting on a device. This API provides the ability to have per-application brightness control on devices that support controllable brightness.

Gets the screen brightness level for this BrightnessOverride instance. The brightness level can be changed by calling SetBrightnessLevel().

BOOLEAN value that indicates whether the brightness override is active. If TRUE, the current brightness level matches the override brightness level. This property value will always be FALSE if StartOverride() isn’t called.

Indicates whether the device currently has at least one brightness controllable display. If TRUE, the device has at least one brightness controllable display that supports brightness override.

Occurs when the screen brightness level changes.

Occurs when the screen brightness level either starts to match or stops to match the override brightness level. This event is raised when the IsOverrideActive property changes state.

Occurs when a brightness controllable display is detected or removed. This event is raised when the IsSupported property changes.

Returns a brightness override object. This method does not require CoreWindow so it can be used by apps that are running in the background.

The brightness override object.

Returns a brightness override object. This method requires CoreWindow so it can only be used by apps that are currently running in a window. The returned BrightnessOverride object may not be the same between multiple GetForCurrentView() calls on the same thread.

The brightness override object.

Gets the brightness level associated with the specified scenario.

The enum value of the scenario that you want to retrieve the brightness level for, as defined in DisplayBrightnessScenario. A value to indicate the brightness level.

Saves the specified brightness override settings by committing these values to user settings. Use this method to persist the override settings after overriding stops. If a NULL object is passed in, the system turns on auto-brightness.

The brightness override object. BOOLEAN value to indicate if the operation is successful or not.

Sets the brightness level and the override options. When your app is ready to change the current brightness with what you want to override it with, call StartOverride().

Brightness of the screen. Value should be in the range of 0.0 and 1.0, where 1.0 is for 100% brightness. Options that modify the brightness level of the screen during the brightness override session.

Sets the brightness level, by specifying a scenario that has a well-known brightness level, and the override options of the brightness override.

A scenario that has a well-known brightness level. Options that modify the brightness level of the screen during the brightness override session.

Request to start overriding the screen brightness level. The request to start overriding does not mean that the screen brightness level always changes to match the specified override brightness level. It's still up to the system to decide whether or not to honor this override request. Use IsOverrideActive and IsOverrideActiveChanged properties to determine if the system has honored the override request.

Stops overriding the brightness level.

Contains the settings to use when overriding the screen brightness with DisplayEnhancementOverride on a device.

Gets the desired brightness level.

The desired brightness level.

Gets the desired Nits level.

If the BrightnessOverrideSettings object was created using CreateFromLevel, this value will map to the perceivable brightness in nits equal to the specified brightness level.

Creates a BrightnessOverrideSettings object with a brightness level corresponding to the specified brightness scenario.

The override scenario on which to base the settings. The override settings.

Creates a BrightnessOverrideSettings object with the specified brightness level.

The brightness level to use to create the override settings. The brightness level is a value ranging from [0.0, 1.0], where 0.0 corresponds to 0% The override settings.

Creates a BrightnessOverrideSettings object with the specified brightness in nits.

The brightness in nits to use to create the override settings. The override settings.

Contains the settings to use when overriding the screen color settings with DisplayEnhancementOverride on a device.

Retrieves the desired color override scenario.

The display color override scenario.

Creates a set of color override settings, based on the specified override scenario.

The override scenario to use. The color override settings.

Describes the options that modify the brightness level of the screen during the override session. When __UseDimmedPolicyWhenBatteryIsLow__ is set, it reduces the specified override brightness level in order to conserve battery if the device

Screen display stays at the specified override brightness level when the device battery is low.

Screen display dims when the device battery is low and a brightness override session is running.

Represents the brightness scenarios that a BrightnessOverrideSettings object can request.

Indicates that a brightness level which is barcode reader friendly is wanted.

Indicates that a brightness level of 100% is wanted.

Indicates that a brightness level to be used when the app is idle.

Describes common brightness scenarios that have well-known brightness levels. These scenarios are used in the GetLevelForScenario() and SetBrightnessScenario() methods.

Sets the screen to the brightness level that it is easily readable by barcode readers. This is currently set to 100% brightness.

Sets the screen to the current screen brightness, essentially freezing the brightness.

Sets the screen to 100% brightness.

Sets the screen to a battery friendly yet readable brightness level. This is currently set to 10% brightness.

Represents the color scenarios that a ColorOverrideSettings object can request.

Indicates that colorimetrically accurate display color is wanted. In addition to disabling inbox white point adaptation (such as Night Light), color enhancements that deviate from a standardized colorspace, such as contract and saturation adjustments will be disabled on a best effort basis.

Contains the base features that describe how to override setting displays.

Gets and sets the brightness override settings.

The brightness override settings. A null BrightnessOverrideSettings property means that the DisplayEnhancementOverride does not want to override brightness settings. This property is null by default.

Gets a value that describes whether the current display settings can be overridden.

**True** if the DisplayEnhancementOverride object can successfully override the system's brightness and/or color with its current configuration at the moment that CanOverrideis queried. This can be used to test if override control can be obtained without having to call RequestOverride.

Gets and sets the color override settings.

The color override settings. A null ColorOverrideSettings property means that the DisplayEnhancementOverride object does not want to override color settings. This property is null by default.

Gets a value that describes whether the display enhancement overrides are active.

**True** if the display enhancement override object is currently overriding the system's brightness and/or color settings. Otherwise, **false**.

Raised when the ability to override the display settings have been changed.

Raised when the display enhancement override capabilities have been changed.

Raised when the IsOverrideActive property is changed.

Retrieves the current display enhancement overide capabilities.

The current display enhancement override capabilities.

Retrieves a display enhancement override object for the current view.

The display enhancement override object for the current view.

Requests that the current display be overridden with the current display override settings.

Notifies the system that this display enhancement object no longer wants to apply its settings.

Describes the capabilities of a display enhancement override object.

Gets a value that describes whether brightness control is currently supported.

**True** if brightness control is currently supported; otherwise, **false**.

Gets a value that describes whether brightness control in nits is supported.

**True** if the brightness controls in nits is supported; otherwise, **false**.

Retrieves the supported nit ranges.

The supported nit ranges. Returns an empty vector if IsBrightnessNitsControlSupported is **false**.

Provides the arguments returned by the event raised when the display enhancement override changes.

Gets the display enhancement override capabilities that have changed.

The display enhancement override capabilities that have changed.

Monitors and controls display-related information for an application view. The class provides events to allow clients to monitor for changes in the application view affecting which display(s) the view resides on, as well as changes in displays that can affect the application view.

Gets and sets the preferred orientation of the app.

The orientation of a rectangular monitor.

Gets the current orientation of a rectangular monitor.

The current orientation of a rectangular monitor.

Diagonal size of the display in inches.

Returns the diagonal size of the display in inches. May return null when display size information is not available or undetermined (when connected to a projector, or displays are duplicated).

Gets the pixels per logical inch of the current environment.

The pixels per logical inch of the current environment.

Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor.

The native orientation of the display monitor.

Gets the raw dots per inch (DPI) along the x axis of the display monitor.

The raw dots per inch (DPI) along the x axis of the display monitor.

Gets the raw dots per inch (DPI) along the y axis of the display monitor.

The raw dots per inch (DPI) along the y axis of the display monitor.

Gets a value representing the number of raw (physical) pixels for each view (layout) pixel.

A value representing the number of raw (physical) pixels for each view (layout) pixel.

Gets the scale factor of the immersive environment.

The scale factor of the immersive environment.

Returns the current height resolution of the logical monitor.

Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution.

Returns the current width resolution of the logical monitor.

Returns the current resolution of the logical monitor containing the application’s view. When the application’s view is moved to another logical monitor, this property will reflect the new logical monitor’s resolution.

Gets a value that indicates whether the device supports stereoscopic 3D.

**TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise.

Raised when the advanced color information is changed.

Occurs when the physical display's color profile changes.

Occurs when the display requires redrawing.

Occurs when the LogicalDpi property changes because the pixels per inch (PPI) of the display changes.

Occurs when either the CurrentOrientation or NativeOrientation property changes because of a mode change or a monitor change.

Occurs when the StereoEnabled property changes because support for stereoscopic 3D changes.

Retrieves the Advanced Color information.

The Advanced Color information.

Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display.

Object that manages the asynchronous retrieval of the color profile.

Gets the DisplayInformation instance associated with the current thread's CoreApplicationView. This DisplayInformation instance is tied to the view and cannot be used from other threads.

A DisplayInformation object that provides display-related information for the current thread's view.

Describes the orientation of a rectangular monitor.

Specifies that the monitor is oriented in landscape mode where the width of the display viewing area is greater than the height.

Specifies that the monitor rotated another 90 degrees in the clockwise direction (to equal 180 degrees) to orient the display in landscape mode where the width of the display viewing area is greater than the height. This landscape mode is flipped 180 degrees from the **Landscape** mode.

No display orientation is specified.

Specifies that the monitor rotated 90 degrees in the clockwise direction to orient the display in portrait mode where the height of the display viewing area is greater than the width.

Specifies that the monitor rotated another 90 degrees in the clockwise direction (to equal 270 degrees) to orient the display in portrait mode where the height of the display viewing area is greater than the width. This portrait mode is flipped 180 degrees from the **Portrait** mode.

Provides various properties that are related to the physical display. For most of these properties, the class provides events to allow clients to monitor for changes in the properties.

DisplayProperties may be altered or unavailable for releases after Windows Phone 8.1. Instead, use DisplayInformation.

Gets and sets the preferred orientation of the app.

The orientation of a rectangular monitor.

Gets the current orientation of a rectangular monitor.

The current orientation of a rectangular monitor.

Gets the pixels per logical inch of the current environment.

The pixels per logical inch of the current environment.

Gets the native orientation of the display monitor, which is typically the orientation where the buttons on the device match the orientation of the monitor.

The native orientation of the display monitor.

Gets the scale factor of the immersive environment.

The scale factor of the immersive environment.

Gets a value that indicates whether the device supports stereoscopic 3D.

**TRUE** if the device is capable of stereoscopic 3D and stereoscopic 3D is currently enabled; **FALSE** otherwise.

Occurs when the physical display's color profile changes.

Occurs when the display requires redrawing.

Occurs when the LogicalDpi property changes because the pixels per inch (PPI) of the display changes.

Occurs when either the CurrentOrientation or NativeOrientation property changes because of a mode change or a monitor change.

Occurs when the StereoEnabled property changes because support for stereoscopic 3D changes.

Asynchronously gets the default International Color Consortium (ICC) color profile that is associated with the physical display.

DisplayProperties may be altered or unavailable for releases after Windows Phone 8.1. Instead, use DisplayInformation. Object that manages the asynchronous retrieval of the color profile.

Represents a method that handles display property events.

DisplayProperties may be altered or unavailable for releases after Windows Phone 8.1. Instead, use DisplayInformation. The object that raised the event.

Describes the HDR metadata format.

The specified display supports the HDR10 style metadata, as per the HDR10 specification.

The specified display supports the HDR10Plus style of metadata, as per the HDR10Plus specification.

Describes the minimum, maximum, and step size you can use when using nits to describe brightness on a device.

The inclusive start point.

The inclusive end point.

The step size, in nits, of the display brightness. Guaranteed to be a factor of (MinNits - MaxNits).

Describes the scale factor of the immersive environment. The scale factor is determined by the operating system in response to high pixel density screens.

Specifies the scale of a display is invalid.

Specifies the scale of a display as 100 percent. This percentage indicates a minimum screen resolution for Windows all up is 1024x768.

This value isn't used.

Specifies the scale of a display as 125 percent.

Specifies the scale of a display as 140 percent. This percentage indicates a minimum screen resolution to scale at 140 is 1440x1080.

Applies to Windows Phone 8.

Applies to Windows Phone 8.

Specifies the scale of a display as 175 percent.

Specifies the scale of a display as 180 percent. This percentage indicates a minimum screen resolution to scale at 180 is 1920x1440.

Specifies the scale of a display as 200 percent.

This value isn't used.

Specifies the scale of a display as 250 percent.

Specifies the scale of a display as 300 percent.

Specifies the scale of a display as 350 percent.

Specifies the scale of a display as 400 percent.

Specifies the scale of a display as 450 percent.

Specifies the scale of a display as 500 percent.

Describes the types of standard color spaces for display monitors.

The ITU-R Recommendation BT.2020 is the recommended format for ultra-high-definition TV (UHDTV).

The ITU-R Recommendation BT.709 is the recommended format for high-definition TV (HDTV).

Full RGB; levels are in the full range of 0-255.

Limited RGB; levels are limited to 16-235.

Describes the 10 bit display metadata which is usually used for video. This is used to adjust the output to best match a display's capabilities.

The X chromaticity coordinate of the blue value.

The Y chromaticity coordinate of the blue value.

The X chromaticity coordinate of the green value.

The Y chromaticity coordinate of the green value.

The maximum nit value (in units of 0.00001 nit) used anywhere in the content.

The per-frame average of the maximum nit values (in units of 0.00001 nit).

The maximum number of nits of the display used to master the content. Units are 0.0001 nit, so if the value is 1 nit, the value should be 10,000.

The minimum number of nits (in units of 0.00001 nit) of the display used to master the content.

The X chromaticity coordinate of the red value.

The Y chromaticity coordinate of the red value.

The X chromaticity coordinate of the white point.

The Y chromaticity coordinate of the white point.

Defines constants that specify the high dynamic range (HDR) options of a connected device such as a TV or a monitor.

Specifies the low-latency profile for Dolby Vision.

Specifies an SMPTE ST 2084 electro-optical transfer function (EOTF).

Specifies a standard dynamic range (SDR) electro-optical transfer function (EOTF).

Specifies no option.

Represents a class containing methods which can be used to interact with the display.

Event raised when the display mode changes.

Gets the HdmiDisplayMode object, which provides info about the current display mode of a connected device, like a TV.

The display mode.

Gets the HdmiDisplayInformation object which is the display info of a video content that is currently sent to a display, like a TV or monitor.

The display info of a video content that's currently on screen.

Gets the display modes that are supported by your current display. This is determined in combination by your device type, specifications, and settings.

The list of display modes that are supported.

Sends request to set only the display mode for the display.

Value that indicates whether the set request is successful.

Sends request to set only the display mode and HDR option for the display.

The display mode. The electro-optical transfer function (EOTF) used to master the HDR content. Value that indicates whether the set request is successful.

Sends request to set the display according to the input parameters.

The display mode. The electro-optical transfer function (EOTF) used to master the HDR content. The 10 bit display metadata used to adjust the output. Value that indicates whether the set request is successful.

Sets the display to the back to default settings.

Represents the display mode of a connected device such as a TV or a monitor. It provides info about the display capabilities of the device, such as the number of bits per pixel, colorspace, type of pixel encoding, refresh rate, and more.

Gets the number of bits per pixel. It specifies the number of bits used in a pixel.

Gets the color space.

Indicates whether 10 bit display metadata is supported on the device.

`true` if 10 bit display metadata is supported on the device, otherwise `false`.

Indicates whether the low-latency profile for Dolby Vision is supported on the device.

`true` if the low-latency profile for Dolby Vision is supported on the device, otherwise `false`.

Gets the value that indicates whether standard dynamic range (SDR) luminance levels are supported by the device.

Gets the value that indicates whether the SMPTE (Society of Motion Picture and Television Engineers) ST 2084 electo-optical transfer function (EOTF) is supported.

Gets the type of pixel encoding the device uses for rendering display content.

Gets the device's refresh rate, in Hertz (Hz).

Gets the device's resolution height in raw pixels.

Gets the device's resolution width in raw pixels.

Gets the value that indicates whether stereoscorpic 3D is enabled on the device.

Checks to see whether the current display mode is equal to a specific display mode.

Value that indicates if the current display mode is equal to a specifc display mode. If TRUE, they are the equal.

Describes the types of pixel encoding format.

Video signal is separated into the red, green, blue (RGB) components, with no color sub-sampling.

Chroma sub-sampling is done at 4:2:0. Only one chroma component is sampled on per line. This means that the two chroma components take turns to be sampled, so they are sampled on alternate lines at half the sample rate of the luma component.

Chroma sub-sampling is done at 4:2:2. The two chroma components are sampled at half the sample rate of the luma component.

Video signal is separated into the chroma (Cb and Cr) and luma (Y) components, with no chroma sub-sampling.

Base class for graphics effects.

The name of the graphics effect.

The name of the graphics effect.

Base class for graphics effect sources.

Represents the graphics adapter used for rendering holographic content. Matches the Win32 locally unique identifier (LUID) type.

The HighPart of the LUID struct.

The LowPart of the LUID struct.

Provides per-frame rendering functionality for a HolographicViewConfiguration on a HolographicDisplay.

Gets whether the display supports overriding the viewport rectangles.

True, if the application can override the viewport rectangles; otherwise, false.

Gets metadata about the display represented by this HolographicCamera.

The display's metadata.

Gets the unique identifier for the HolographicCamera.

The unique identifier.

Gets or sets whether this HolographicCamera will produce hardware-protected back buffers for the primary layer.

Whether hardware content protection is enabled.

Gets whether hardware content protection is supported for this HolographicCamera.

Whether hardware content protection is supported.

Gets or sets whether this camera should display the primary back buffer filled by the app.

True, if the primary layer should be displayed; otherwise, false.

Gets whether the current display is stereo rather than mono.

True, if the current display is stereo; otherwise, false.

Gets rendering parameters related to display's left-eye viewport.

The left viewport parameters.

Gets the maximum number of quad layers supported by the current system.

The max quad layer count.

Gets the mutable list of quad layers to display on top of this camera's primary back buffer.

The quad layer list.

Gets the dimensions in pixels of the back buffers allocated for this camera.

The width and height of the HolographicCamera render target.

Gets rendering parameters related to display's right-eye viewport.

The right viewport parameters.

Gets the HolographicViewConfiguration that this HolographicCamera provides rendering for.

The HolographicViewConfiguration that can be used to configure rendering parameters for this HolographicCamera.

Gets or sets the scale factor to apply to the default viewport size.

The viewport scale factor.

Sets the distance, along the z-axis, from the origin of view space to the far plane of the view frustum.

The far plane distance, in meters. By default, this is set to 20 meters.

Sets the distance, along the z-axis, from the origin of view space to the near plane of the view frustum.

The near plane distance, in meters. By default, this is set to 0.1 meters.

Represents the predicted location of a holographic camera for a particular frame.

Gets the far plane distance for this frame, which is set by calling the HolographicCamera.SetFarPlaneDistance method.

The far plane distance for this frame, in meters. By default, this is set to 20 meters.

Gets the HolographicCamera that's described by this camera pose.

The HolographicCamera.

Gets the near plane distance for this frame, which you set by calling the HolographicCamera.SetNearPlaneDistance method.

The near plane distance for this frame, in meters. By default, this is set to 0.01 meters.

Gets the stereo projection transform for this camera pose.

The transforms.

Gets the viewport rectangle that the app must render to for this camera in this frame.

The viewport rect.

Notifies the compositor that the app is rendering with an alternate suboptimal projection transform this frame.

The alternate suboptimal projection transform.

Specifies an alternate viewport rectangle within the frame buffer that the app is rendering into this frame.

The left eye viewport rectangle. The right eye viewport rectangle.

Notifies the compositor that the app is rendering with an alternate suboptimal view transform this frame.

The coordinate system in which the alternate suboptimal view transform will be expressed. The alternate suboptimal view transform.

Gets the predicted conservative culling frustum for this camera pose, expressed in the specified coordinate system.

The coordinate system in which to express the culling frustum. The culling frustum.

Gets the stereo view transform for this camera pose, expressed as a transform from the specified coordinate system. This method will return null if the specified coordinate system cannot be located at the moment.

The coordinate system from which the rendered geometry should be transformed. The transforms.

Gets the predicted view frustum for the current pose, expressed in the specified coordinate system.

The coordinate system in which to express the visible frustum. The visible frustum.

Represents per-camera parameters for rendering holographic content.

Gets the Direct3D 11 back buffer surface for this camera. Apps must retrieve a new back buffer surface for rendering each frame.

The Direct3D 11 surface that holds the back buffer.

Gets the Direct3D 11 device for this camera.

The Direct3D 11 device.

Gets or sets whether the application is displaying protected content.

Whether content protection is enabled.

Gets or sets the kind of reprojection the app is requesting to stabilize its holographic rendering relative to the user's head motion.

The kind of reprojection.

Provides a depth buffer for this frame to the holographic display pipeline, enabling depth-based stabilization of the frame relative to the user's head motion.

The Direct3D 11 surface containing the app's depth buffer.

Sets the stationary point in the holographic space that the user will likely focus on for the current frame.

The coordinate system of the position vector. The location of the focus point in the specified coordinate system.

Sets the stationary point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point.

The coordinate system of the position and normal vectors. The location of the focus point in the specified coordinate system. The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user.

Sets the moving point in the holographic space that the user will focus on, as well as the normal for a focus plane through that point.

The coordinate system of the position, normal and velocity vectors. The location of the focus point in the specified coordinate system. The normal of the focus point in the specified coordinate system, if known. If there is no obvious normal, have it face the user. The velocity vector of the focus point in the specified coordinate system.

Represents per-viewport parameters for rendering holographic content.

Gets screen-space vertices that define the viewport area the user cannot see, given the headset's lens geometry.

The hidden area mesh vertices.

Gets screen-space vertices that define the viewport area the user can see, given the headset's lens geometry.

The visible area mesh vertices.

Provides metadata for a display to which a holographic view must render each frame from that frame's pose.

Gets the identifier of the graphics adapter to be used when displaying holographic content to this HolographicDisplay.

The identifier.

Gets a friendly name for this display that can be displayed to the user.

The friendly name.

Gets whether this display is occluded, blocking the user's view of the physical world around them.

Whether this display is occluded.

Gets whether this display requires separate rendering for the left and right eyes.

Whether this display is stereo.

Gets the maximum viewport size that an app will ever be asked to render to for this display.

The maximum viewport size.

Gets the refresh rate at which an app must present content to this holographic display.

The refresh rate.

Gets a spatial locator that can be used to create frames of reference relative to this display.

The spatial locator.

Gets the default display that represents the user's primary Mixed Reality headset.

The default display.

Attempts to retrieve the view configuration for this HolographicDisplay, which corresponds to the supplied HolographicViewConfigurationKind.

A HolographicViewConfigurationKind indicating the kind of view configuration to be retrieved. A HolographicViewConfiguration object of the indicated kind, or null if the HolographicDisplay does not support the indicated HolographicViewConfigurationKind.

Represents a frame of holographic content that an app must render to all cameras.

Gets the list of HolographicCamera objects that were added since last frame.

A collection of HolographicCamera objects that were added.

Gets the most recent camera location prediction for the current HolographicFrame.

The prediction.

Gets the duration of time that the frame will be on the screen.

The time span.

Gets the unique identifier for the HolographicFrame within its parent HolographicSpace.

A HolographicFrameId representing the unique identifier for the HolographicFrame.

Gets the list of HolographicCamera objects that were removed since last frame.

A collection of HolographicCamera objects that were removed.

Gets an update payload that lets an application configure a specific quad layer's parameters from this frame forward.

The quad layer to update. The update parameters.

Gets the parameters needed to render the current frame with the specified camera pose.

The camera pose. The rendering parameters.

Present the current frame for all cameras and then wait until the next frame.

The result of the Present call.

Presents the current frame for all cameras with the specified waiting behavior.

The wait behavior. The result of the Present call.

Computes an updated prediction for the CurrentPrediction property.

Blocks the current thread until this frame has finished and is showing on the displays.

Uniquely identifies a HolographicFrame within its parent HolographicSpace.

A 64-bit integer value uniquely identifying a **HolographicFrame**.

Represents the poses for each holographic camera at the time that they're predicted to be displayed.

Gets the camera poses that correspond with the time specified by Timestamp.

The camera poses.

Gets the time when the camera poses are predicted to be displayed.

The timestamp.

Monitors an independent stream of frame presentation reports from a HolographicSpace.

Use HolographicFrameScanoutMonitor instead of HolographicFramePresentationMonitor. For more info, see MSDN.

Disposes of this frame presentation monitor, releasing any unread reports.

Returns a list of reports for frame presentations which have occurred since the last time the method was called.

Use HolographicFrameScanoutMonitor instead of HolographicFramePresentationMonitor. For more info, see MSDN. The report list.

A frame presentation report for a particular compositor frame.

Use HolographicFrameScanoutReport instead of HolographicFramePresentationReport. For more info, see MSDN.

The amount of GPU time which was consumed by the app.

The amount of GPU time the app spent which went beyond its presentation target time.

The amount of GPU time which was not available for the app's use since it was consumed by the compositor.

The number of presentation opportunities which were missed before the app's frame was finished rendering.

The number of times the app's frame was presented by the compositor.

Indicates the outcome of a Present call on a holographic frame.

The Direct3D 11 device was removed and a new device is required. To investigate the cause of device removed errors, call the ID3D11Device::GetDeviceRemovedReason method before releasing the Direct3D device. Set the new device by calling the HolographicSpace::SetDirect3D11Device method.

The frame was presented successfully.

Specifies whether a Present call should wait for the frame to finish or returns control to the thread immediately.

Return control to the thread immediately.

Don't return control to the thread until the current frame is finished.

Contains timing information about the work the application did leading up to the frame being scanned out by the system for the first time.

Gets the unique identifier for the HolographicFrame associated with the HolographicFrameRenderingReport.

A HolographicFrameId representing the unique identifier for the HolographicFrame associated with the HolographicFrameRenderingReport.

Gets the number of scanouts where a previous HolographicFrame had to be re-projected again due to the GPU work for the current **HolographicFrame** not finishing in time for the target scanout deadline.

The number of scanouts where a previous HolographicFrame had to be re-projected.

Gets the time at which all GPU work needed for reprojection is known to be finished. This includes any overlay work or other hologram compositor post-processing needed to prepare the final image.

The time at which all GPU work needed for reprojection is known to be finished.

Gets the system-recommended time at which rendering for the HolographicFrame that is dependent on the head pose should have begun. This is the same time that HolographicSpace.WaitForNextFrameReady method is unblocked.

The system-recommended time at which rendering for the HolographicFrame that is dependent on the head pose should have begun.

Gets an estimate of the time that the HolographicFrame needed to have all its GPU work, both application and compositor, finished in order to begin reprojection on schedule.

An estimate of the time that the HolographicFrame needed to have all its GPU work finished in order to begin reprojection on schedule.

Allows Mixed Reality applications to obtain a stream of HolographicFrameScanoutReport objects.

Closes the HolographicFrameScanoutMonitor and releases associated resources.

Returns a list of HolographicFrameScanoutReport objects where each report corresponds to a single scanout to the holographic display which has occurred since the last time the method was called. Note that each HolographicFrame may be scanned out multiple times.

A list of HolographicFrameScanoutReport objects.

Provides performance and timing information about a single scanout to a holographic display.

Gets the number of scanout opportunities that were missed since the last scanout.

The number of scanout opportunities that were missed since the last scanout.

Gets rendering timing information about the HolographicFrame that was scanned out.

A HolographicFrameRenderingReport containing rendering timing information about the HolographicFrame that was scanned out.

Gets the time that the final decision on which HolographicFrame will be scanned out is made and reprojection begins, if applicable.

The time that the final decision on which HolographicFrame will be scanned out is made

Gets the time that the light from the display hardware for the current scanout is expected to be emitted.

The time that the light from the display hardware for the current scanout is expected to be emitted.

Gets the time that the image began scanning out to the display hardware.

The time that the image began scanning out to the display hardware.

Represents a retained texture for the system to display at a specified location on top of the app's primary rendered content.

Creates a new quad layer with a specified texture size, using a default pixel format of DXGI_FORMAT_B8G8R8A8_UNORM.

The size in pixels of the texture that will back this quad layer.

Creates a new quad layer with a specified texture size and pixel format.

The size in pixels of the texture that will back this quad layer. The pixel format for the texture that will back this quad layer.

The pixel format for the texture that will back this quad layer.

The pixel format.

The size in pixels of the texture that will back this quad layer.

The texture size.

Closes a quad layer, reclaiming any associated system resources.

Represents an update payload that lets an application configure a specific quad layer's parameters from a given frame forward.

Gets whether hardware content protection is supported for this quad layer.

Whether hardware content protection is supported.

Gets a Direct3D 11 back buffer whose contents will be displayed for this quad layer from this frame forward.

The Direct3D 11 surface that holds the back buffer.

Gets a hardware-protected Direct3D 11 back buffer whose contents will be displayed for this quad layer from this frame forward.

The Direct3D 11 surface that holds the hardware-protected back buffer.

Updates whether this quad layer contains protected content.

Whether content protection should be enabled for this quad layer.

Updates the extents of this quad layer in world coordinates.

The full width and height of the quad layer in meters.

Updates the center location of this quad layer relative to the center of the displays, setting it to remain at that display-relative location in future frames.

A point for the center of the quad plane, specified relative to the center of the displays. A rotation for the normal of the quad plane, specified relative to a normal facing the displays.

Updates the center location of this quad layer in the world, setting it to remain at that world location in future frames.

The reference SpatialCoordinateSystem object. A point for the center of the quad plane, specified relative to the origin of the reference coordinate system. A rotation for the normal of the quad plane, specified relative to the neutral orientation of the reference coordinate system.

Updates the viewport rectangle within the quad layer's texture that will be displayed to the screen.

The viewport rectangle.

Represents the kind of reprojection an app is requesting to stabilize its holographic rendering relative to the user's head motion.

The image should not be stabilized for the user's head motion, instead remaining fixed in the display. This is generally discouraged, as it is only comfortable for users when used sparingly, such as when the only visible content is a small cursor.

The image should be stabilized only for changes to both the user's head orientation, ignoring positional changes. This is best for body-locked content that should tag along with the user as they walk around, such as 360-degree video.

The image should be stabilized for changes to both the user's head position and orientation. This is best for world-locked content that should remain physically stationary as the user walks around.

Represents a holographic scene, with one or more holographic cameras rendering its content.

Gets whether a Mixed Reality headset is ready for holographic rendering.

Whether a headset is ready.

Gets whether the current system has been configured by the user for Mixed Reality headsets.

Whether headsets are configured by the user.

Gets whether the current system supports Mixed Reality headsets.

Whether headsets are supported.

Gets the identifier of the graphics adapter to be used when displaying holographic content to the default HolographicDisplay.

The identifier.

Describes whether the user is present within the headset to view and interact with this HolographicSpace.

The user presence.

Occurs when a HolographicCamera is added to the current HolographicSpace.

Occurs when a HolographicCamera is removed from the current HolographicSpace.

Occurs when a configured and ready Mixed Reality headset is attached or detached from the system.

Occurs when the user's presence within the headset or ability to view and interact with this HolographicSpace changes.

Creates a HolographicSpace that corresponds with the specified window's CoreApplicationView.

The window to create a HolographicSpace for. The HolographicSpace.

Creates an object to monitor an independent stream of frame presentation reports from this HolographicSpace.

Use CreateFrameScanoutMonitor instead of CreateFramePresentationMonitor. For more info, see MSDN. The maximum number of frame reports that can queue up without being read before reports are discarded. The frame presentation monitor.

Creates a HolographicFrameScanoutMonitor that allows Windows Mixed Reality applications to monitor detailed performance and timing information about the platform in real time.

The maximum number of HolographicFrameScanoutReport objects that will be buffered by the system at any one time. The created HolographicFrameScanoutMonitor.

Creates a HolographicFrame for the next frame to display.

The next frame.

Assigns the IDirect3DDevice that will display holographic content. An error will occur if the app creates an inappropriate device.

The Direct3D device.

Blocks the current thread until the right time to begin rendering the next frame.

Blocks the current thread until the right time to begin rendering the next frame, with the specified head start.

The amount of extra head start time to wake up early.

Provides data for the HolographicSpace.CameraAdded event.

Gets the HolographicCamera that is being added. The app should set up any per-camera resources it may need for this camera.

The camera.

Requests that addition of this camera be delayed until the deferral is completed.

The deferral.

Provides data for the HolographicSpace.CameraRemoved event.

Gets the HolographicCamera that was removed. The app should dispose of any per-camera resources it may have set up for this camera.

The camera.

Represents whether the user is present within the headset to view and interact with a particular HolographicSpace.

This HolographicSpace is not visible in the headset or the user is not wearing the headset.

This HolographicSpace is visible in the headset, the user is wearing the headset, and input is being routed to the app.

This HolographicSpace is visible in the headset and the user is wearing the headset, but a modal dialog is taking all input from the app.

Contains view or projection transforms for stereo rendering. One transform is for the left display, and the other is for the right display.

View or projection transform for the left display of a stereo device.

View or projection transform for the right display of a stereo device.

Represents a view configuration for a HolographicDisplay. This object provides apps with fine-grained control of the rendering configuration for a HolographicCamera.

Gets the HolographicDisplay which this HolographicViewConfiguration is for.

The HolographicDisplay which this HolographicViewConfiguration is for.

Gets or sets whether this HolographicViewConfiguration is enabled.

This value is `true` if the HolographicViewConfiguration is enabled, otherwise `false`.

Gets whether this HolographicViewConfiguration is stereoscopic.

This value is `true` if the HolographicViewConfiguration is stereoscopic, otherwise `false`.

Gets the kind of rendering this HolographicViewConfiguration is for.

A HolographicViewConfigurationKind specifying a kind of HolographicViewConfiguration for a HolographicDisplay.

Gets the native render target size for this HolographicViewConfiguration.

A Size representing the native render target size for the HolographicViewConfiguration.

Gets or sets the pixel format of this HolographicViewConfiguration.

A Windows.Graphics.DirectX.DirectXPixelFormat value.

Gets the refresh rate for this HolographicViewConfiguration.

A double-precision floating point number representing the refresh rate frequency, in Hertz (Hz).

Gets the render target size for this HolographicViewConfiguration.

A Size representing the render target size for this HolographicViewConfiguration.

Gets a list of the supported pixel formats for this HolographicViewConfiguration.

A collection of Windows.Graphics.DirectX.DirectXPixelFormat values, each of which can be set using the HolographicViewConfiguration.PixelFormat property.

Requests a new minimum render target size for this HolographicViewConfiguration.

A Size representing the desired render target size. Must be at least [1, 1]. A Size representing the render target size that was actually set.

Defines constants that indicate the kind of a HolographicViewConfiguration.

Specifies that the view configuration is for a display.

Specifies that the view configuration is for a photo/video camera.

Specifies the alpha mode of pixel data.

The alpha value is ignored.

The alpha value has been premultiplied. Each color is first scaled by the alpha value.

The alpha value has not been premultiplied. The alpha channel indicates the transparency of the color.

Specifies a bounding rectangle.

The Height, in pixels, of the bounding box

The Width, in pixels, of the bounding box.

The X coordinate, in pixels, of the top left corner of the bounding box.

The Y coordinate, in pixels, of the top left corner of the bounding box.

Represents the pixel data buffer of a bitmap.

Disposes of the object and associated resources.

Creates a reference to the underlying memory buffer.

A reference to the underlying memory buffer.

Gets the number of bit planes in the bitmap buffer.

The number of bit planes in the bitmap buffer.

Gets a BitmapPlaneDescription object that describes the size, offset, and stride of the bitmap data in the bit plane with the specified index.

The index of the bit plane for which the description is retrieved. The bit plane description.

Specifies the access mode of a BitmapBuffer.

The buffer is read-only.

The buffer can be read from and written to.

The buffer is write-only.

Provides access to information about a decoder or encoder.

The unique identifier of the decoder or encoder. Methods like BitmapDecoder.CreateAsync and BitmapEncoder.CreateAsync use the codec identifier to determine which codec to create.

The codec unique identifier.

A collection of all the file extensions supported by the decoder or encoder.

The list of supported file extensions.

The friendly name of the decoder or encoder.

The friendly name of the codec.

A collection of all the MIME/content types supported by the decoder or encoder. MIME type is synonymous with content type.

The list of supported MIME/content types.

Provides read access to bitmap container data as well as data from the first frame.

The default alpha mode of the first frame.

The default alpha mode of the first frame.

Provides access to the container bitmap properties.

The container bitmap properties.

The pixel format that best fits the first frame.

The pixel format that best fits the first frame.

A read-only view of the metadata within the first frame.

A read-only view of the metadata within the first frame.

The unique identifier of the BMP decoder.

The unique identifier of the BMP decoder.

Information about the bitmap decoder.

The bitmap decoder information.

The horizontal resolution of the first frame in dots per inch.

The horizontal resolution of the first frame in dots per inch.

The vertical resolution of the first frame in dots per inch.

The vertical resolution of the first frame in dots per inch.

The number of frames within the image file.

The number of frames.

The unique identifier of the GIF decoder.

The unique identifier of the GIF decoder.

The unique identifier of the HEIF decoder.

The unique identifier of the HEIF decoder.

The unique identifier of the ICO decoder.

The unique identifier of the ICO decoder.

The unique identifier of the JPEG decoder.

The unique identifier of the JPEG decoder.

The unique identifier of the JPEG-XR decoder.

The unique identifier of the JPEG-XR decoder.

The height of the first frame in pixels, after any EXIF orientation has been applied to the bitmap.

The height of the first frame in pixels, after any EXIF orientation has been applied.

The width of the first frame in pixels, after any EXIF orientation has been applied to the bitmap.

The width of the first frame in pixels, after any EXIF orientation has been applied.

The height of the first frame in pixels.

The height of the first frame in pixels.

The width of the first frame in pixels.

The width of the first frame in pixels.

The unique identifier of the PNG decoder.

The unique identifier of the PNG decoder.

The unique identifier of the TIFF decoder.

The unique identifier of the TIFF decoder.

The unique identifier of the WebP decoder.

The unique identifier of the WebP decoder.

Asynchronously creates a new BitmapDecoder using a specific bitmap codec and initializes it using a stream.

The unique identifier of the specified bitmap codec. The stream containing the image file to be decoded. An object that manages the asynchronous creation of a new BitmapDecoder.

Asynchronously creates a new BitmapDecoder and initializes it using a stream.

The stream containing the image file to be decoded. An object that manages the asynchronous creation of a new BitmapDecoder.

The bitmap decoders installed on the system and information about them.

A list of BitmapCodecInformation objects containing information about each decoder.

Asynchronously retrieves a frame from the image file.

The zero-based index of the frame to be retrieved. Object that manages the asynchronous retrieval of the frame.

Asynchronously requests the pixel data for the frame.

Object that manages the asynchronous retrieval of the pixel data.

Asynchronously requests the pixel data for the frame using the specified parameters.

The specified pixel format. The specified alpha mode. The set of transformations to be applied to the frame. Indicates whether the EXIF orientation flag should be ignored or respected. Indicates whether the pixel data should be color managed to the sRGB color space. Object that manages the asynchronous retrieval of the pixel data.

Asynchronously returns a stream containing the preview image.

Object that manages the asynchronous retrieval of the bitmap preview data.

Asynchronously gets a SoftwareBitmap representation of the decoded bitmap.

An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously gets a SoftwareBitmap representation of the decoded bitmap.

The pixel format of the software bitmap. The alpha mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously gets a SoftwareBitmap representation of the decoded bitmap.

The pixel format of the software bitmap. The alpha mode of the software bitmap. The transform of the software bitmap. The EXIF orientation mode of the software bitmap. The color management mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously returns a stream containing the thumbnail image.

Object that manages the asynchronous retrieval of the thumbnail stream.

Contains methods to create, edit and save images.

The metadata for the container.

A BitmapProperties object that provides both read and write access to the metadata for the container.

The metadata for the selected frame.

A BitmapProperties object that provides both read and write access to the metadata for the selected frame.

A BitmapTransform object that is used to specify how the frame bitmap is to be transformed.

A BitmapTransform object that is used to specify how the frame bitmap is to be transformed.

The unique identifier of the built-in BMP encoder.

The unique identifier of the built-in BMP encoder.

Information about the bitmap encoder.

An object containing information about the bitmap encoder.

The height, in pixels, of any generated thumbnail.

The height of the thumbnail, in pixels. The default value is 120 pixels.

The width, in pixels, of any generated thumbnail.

The width of the thumbnail, in pixels. The default value is 160 pixels.

The unique identifier of the built-in GIF encoder.

The unique identifier of the built-in GIF encoder.

The unique identifier of the built-in HEIF encoder.

The unique identifier of the built-in HEIF encoder.

Indicates whether or not a new thumbnail is automatically generated.

A value that indicates whether or not the bitmap encoder will automatically generate a new thumbnail. The default value is False.

The unique identifier of the built-in JPEG encoder.

The unique identifier of the built-in JPEG encoder.

The unique identifier of the built-in JPEG-XR encoder.

The unique identifier of the built-in JPEG-XR encoder.

The unique identifier of the built-in PNG encoder.

The unique identifier of the built-in PNG encoder.

The unique identifier of the built-in TIFF encoder.

The unique identifier of the built-in TIFF encoder.

Asynchronously creates a new BitmapEncoder.

The unique identifier of the specified encoder. The output stream. An object that manages the asynchronous creation of a new BitmapEncoder.

Asynchronously creates a new BitmapEncoder for the specified codec with the specified encoding options and initializes it on a stream.

The unique identifier of the specified encoder. A stream representing where the image file is to be written. A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. An object that manages the asynchronous creation of a new BitmapEncoder.

Asynchronously creates a new BitmapEncoder for in-place property and metadata editing. The new encoder can only edit bitmap properties in-place and will fail for any other uses.

A BitmapDecoder containing the image data to be edited. This parameter must be created on a stream with an access mode of ReadWrite. An object that manages the asynchronous initialization of a new BitmapEncoder using data from an existing BitmapDecoder.

Asynchronously creates a new BitmapEncoder and initializes it using data from an existing BitmapDecoder.

The output stream. A BitmapDecoder containing the image data to be copied. An object that manages the asynchronous creation of a new BitmapEncoder using data from an existing BitmapDecoder.

Asynchronously commits and flushes all of the image data.

An object that manages the asynchronous flush operation.

A list of the bitmap encoders installed on the system and information about them.

A list of BitmapCodecInformation objects containing information about each encoder.

Asynchronously commits the current frame data and appends a new empty frame to be edited.

An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited.

Asynchronously commits the current frame data and appends a new empty frame, with the specified encoding options, to be edited.

The specified encoding options. A collection of key-value pairs containing one or more codec-specific encoding options and the desired values. An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited.

Sets pixel data on the frame.

The pixel format of the pixel data. The alpha mode of the pixel data. The width, in pixels, of the pixel data. The height, in pixels, of the pixel data. The horizontal resolution, in dots per inch, of the pixel data. The vertical resolution, in dots per inch, of the pixel data. The pixel data.

Sets the image data of the current frame using the specified SoftwareBitmap.

The software bitmap containing the image data.

Specifies the flip operation to be performed on pixel data.

Flip the bitmap around the y axis.

No flip operation will be performed.

Flip the bitmap around the x axis.

Provides read access to data within a single frame.

The default alpha mode of the frame.

The default alpha mode of the frame.

The pixel format that best fits the frame.

The pixel format that best fits the first frame.

A read-only view of the metadata within the frame.

A read-only view of the metadata within the frame.

The horizontal resolution of the frame in dots per inch.

The horizontal resolution of the frame in dots per inch.

The vertical resolution of the frame in dots per inch.

The vertical resolution of the frame in dots per inch.

The height of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

The height of the frame in pixels, after any EXIF orientation has been applied.

The width of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

The width of the frame in pixels, after any EXIF orientation has been applied.

The height of the frame in pixels.

The height of the frame in pixels.

The width of the frame in pixels.

The width of the frame in pixels.

Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the BitmapPixelFormat and BitmapAlphaMode properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information).

Object that manages the asynchronous retrieval of the pixel data.

Asynchronously requests the pixel data for the frame using the specified parameters.

The specified pixel format. The specified alpha mode. The set of transformations to be applied to the frame. Indicates whether the EXIF orientation flag should be ignored or respected. Indicates whether the pixel data should be color managed to the sRGB color space. Object that manages the asynchronous retrieval of the pixel data.

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

The pixel format of the software bitmap. The alpha mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

The pixel format of the software bitmap. The alpha mode of the software bitmap. The transform of the software bitmap. The EXIF orientation mode of the software bitmap. The color management mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously returns a stream containing the thumbnail image.

Object that manages the asynchronous retrieval of the thumbnail data.

Specifies the interpolation mode used for scaling pixel data.

A bicubic interpolation algorithm. Destination pixel values are computed as a weighted average of the nearest sixteen pixels in a 4x4 grid.

A Fant resampling algorithm. Destination pixel values are computed as a weighted average of the all the pixels that map to the new pixel in a box shaped kernel.

A bilinear interpolation algorithm. The output pixel values are computed as a weighted average of the nearest four pixels in a 2x2 grid.

A nearest neighbor interpolation algorithm. Also known as nearest pixel or point interpolation. The output pixel is assigned the value of the pixel that the point falls within. No other pixels are considered.

Specifies the pixel format of pixel data. Each enumeration value defines a channel ordering, bit depth, and data type.

The pixel format is B8G8R8A8 unsigned integer.

The pixel format is 16 bpp grayscale.

The pixel format is 8 bpp grayscale.

The pixel format is NV12.

The pixel format is P010.

The pixel format is R16B16G16A16 unsigned integer.

The pixel format is R8G8B8A8 unsigned integer.

The pixel format is unknown.

The pixel format is YUY2.

Defines the format of a bitmap plane.

The height of the plane, in pixels.

The start index of the pixel data within the plane.

The stride of the bitmap data.

The width of the plane, in pixels.

Provides read and write access to image properties and metadata.

Asynchronously retrieves one or more bitmap properties.

A collection of strings containing the specified property keys. Object that manages the asynchronous retrieval of the bitmap properties.

Asynchronously sets one or more bitmap properties.

A collection of key-value pairs representing the bitmap properties to be set. Each key is a string containing the Windows property or metadata query, and the corresponding value is a BitmapTypedValue with the data and the correct PropertyType. Object that manages the setting of the bitmap properties asynchronously.

Provides read access to image properties and metadata. A particular instance of BitmapPropertiesView may represent the entire contents of the frame metadata, or any nested metadata block within the frame.

Asynchronously retrieves one or more bitmap properties.

A collection of strings representing the property keys or queries that are being requested. Valid strings include Windows properties and Windows Imaging Component metadata queries. Object that manages the asynchronous retrieval of the bitmap properties.

Represents a property set of BitmapTypedValue objects.

Creates and initializes a new instance of the bitmap property set.

Gets the number of items contained in the property set.

The number of items in the property set.

Removes all items from the property set.

Returns an iterator to enumerate the items in the property set.

The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty.

Gets an immutable view of the property set.

The immutable view.

Indicates whether the property set has an item with the specified key.

The key. True if the property set has an item with the specified key; otherwise, false.

Adds an item to the property set.

The key to insert. The value to insert. True if the method replaces a value that already exists for the key; false if this is a new key.

Retrieves the value for the specified key.

The key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the property set.

The key.

Specifies the rotation operation to be performed on pixel data.

Perform a clockwise rotation of 180 degrees.

Perform a clockwise rotation of 270 degrees.

Perform a clockwise rotation of 90 degrees.

No rotation operation is performed.

Represents the size of a bitmap, in pixels.

The height of a bitmap, in pixels.

The width of a bitmap, in pixels.

Contains transformations that can be applied to pixel data.

Creates a new BitmapTransform object.

Specifies the bounding rectangle that is used to crop the bitmap. This rectangle is defined in the coordinate space after scale, rotation, and flip are applied.

A structure that specifies the bounding rectangle.

Specifies the flip operation that is used to transform the bitmap.

The type of flip operation. One of the values of the BitmapFlip enumeration.

Specifies the interpolation mode that is used to scale the bitmap.

The interpolation mode. One of the values of the BitmapInterpolationMode enumeration.

Specifies the rotation operation that is used to transform the bitmap.

The type of rotation. One of the values of the BitmapRotation enumeration.

Specifies the height, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied.

The height of the bitmap, in pixels.

Specifies the width, in pixels, of the bitmap after it is scaled. This is defined in the coordinate space of the source image, before rotation and flip are applied.

The width of the bitmap, in pixels.

A value along with an enumeration specifying its data type.

Creates a new BitmapTypedValue object.

The value to store. The type of the *value* parameter.

Gets the PropertyType of the stored value.

The PropertyType of the stored value.

Gets the stored value.

The stored value Object.

Specifies the color management behavior when obtaining pixel data.

Color management is performed from the color space embedded with the source bitmap to the sRGB color space.

No color management is performed

Specifies the EXIF orientation flag behavior when obtaining pixel data.

The EXIF orientation flag is ignored. No rotation or flip operations are performed.

If the image frame contains a valid EXIF orientation flag, the specified rotation and/or flip operations are performed on the pixel data.

Exposes methods for operating on a single frame of an image.

Returns the default alpha mode of the frame.

The default alpha mode of the frame.

Returns the default pixel format of the frame.

The default pixel format of the frame.

Returns a read-only view of the metadata within the frame.

A read-only view of the metadata within the frame.

Returns the horizontal resolution of the frame in dots per inch.

The horizontal resolution of the frame in dots per inch.

Returns the vertical resolution of the frame in dots per inch.

The vertical resolution of the frame in dots per inch.

Returns the height of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

The height of the frame in pixels, after any EXIF orientation has been applied.

Returns the width of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

The width of the frame in pixels, after any EXIF orientation has been applied.

Returns the height of the frame in pixels.

The height of the frame in pixels.

Returns the width of the frame in pixels.

The width of the frame in pixels.

Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the BitmapPixelFormat and BitmapAlphaMode properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information).

Object that manages the asynchronous retrieval of the pixel data.

Asynchronously requests the pixel data for the frame using the specified parameters.

The specified pixel format. The specified alpha mode. The set of transformations to be applied to the frame. Indicates whether the EXIF orientation flag should be ignored or respected. Indicates whether the pixel data should be color managed to the sRGB color space. Object that manages the asynchronous retrieval of the pixel data.

Asynchronously retrieves the thumbnail data for the frame.

Object that manages the asynchronous retrieval of the thumbnail data.

Exposes methods for obtaining a SoftwareBitmap representation of an BitmapFrame.

Asynchronously retrieves a SoftwareBitmap representation of an BitmapFrame.

An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously retrieves a SoftwareBitmap representation of an BitmapFrame.

The pixel format of the software bitmap. The alpha mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously retrieves a SoftwareBitmap representation of an BitmapFrame.

The pixel format of the software bitmap. The alpha mode of the software bitmap. The transform of the software bitmap. The EXIF orientation mode of the software bitmap. The color management mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Exposes methods for reading image metadata and properties.

Asynchronously retrieves one or more bitmap properties.

A collection of strings containing the specified property keys. Object that manages the asynchronous retrieval of the bitmap properties.

An implementation of IRandomAccessStreamWithContent type used in the Imaging namespace.

Indicates if you can read the stream.

Indicates whether or not you can read the stream.

Indicates if you can write to the stream.

Indicates whether or not you can write to the stream.

Returns the data format of the stream.

The data format of the stream.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the random access stream.

The size of the stream.

Returns the file stream for the ImageStream.

The file stream for the image.

Closes the ImageStream.

Asynchronously commits the current frame data and flushes all of the data on the image stream.

An object that manages the asynchronous flush operation.

Returns an input stream at a specified location in a stream.

The location in the stream at which to begin. The input stream.

Returns an output stream at a specified location in a stream.

The location in the output stream at which to begin. The output stream.

Reads data asynchronously from a sequential stream.

The buffer into which the asynchronous read operation stores the data. The size of the buffer. The options for the stream to be read. The byte reader operation.

Sets the position of the stream to the specified value.

The new position of the stream.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Specifies which chroma subsampling mode will be used for image compression in JPEG images.

The default mode will be used.

4:2:0 (2x2) chroma subsampling will be used.

4:2:2 (2x1) chroma subsampling will be used.

4:4:4 (1x1) chroma subsampling will be used.

Provides access to the pixel data from a bitmap frame.

Returns the internally-stored pixel data.

The pixel data.

Specifies the filter used to optimize the image prior to image compression in PNG images.

The Adaptive type filter is applied.

The filter type will be chosen automatically.

The Average type filter is applied.

The image is unmodified.

The Paeth type filter is applied.

The Sub type filter is applied.

The Up filter type is applied.

Represents an uncompressed bitmap.

Initializes a new instance of the SoftwareBitmap class.

The pixel format of the new software bitmap. The width of the new software bitmap, in pixels. The height of the new software bitmap, in pixels.

Initializes a new instance of the SoftwareBitmap class.

The pixel format of the new software bitmap. The width of the new software bitmap, in pixels. The height of the new software bitmap, in pixels. The alpha mode of the new software bitmap.

Gets the alpha mode of the software bitmap.

The alpha mode of the software bitmap.

Gets the pixel format of the software bitmap.

The pixel format of the software bitmap.

Gets or sets the dots per inch of the software bitmap in the X direction.

The dots per inch of the software bitmap in the X direction.

Gets or sets the dots per inch of the software bitmap in the Y direction.

The dots per inch of the software bitmap in the Y direction.

Gets a value indicating whether the software bitmap can be modified.

True if the software bitmap is read-only; otherwise, false.

Gets the height of the software bitmap, in pixels.

The height of the software bitmap, in pixels.

Gets the width of the software bitmap, in pixels.

The width of the software bitmap, in pixels.

Disposes of the object and associated resources.

Converts an existing SoftwareBitmap to a SoftwareBitmap with a different pixel format.

The software bitmap to convert. The pixel format of the new software bitmap. The converted software bitmap.

Converts an existing SoftwareBitmap to a SoftwareBitmap with a different pixel format or alpha mode.

The software bitmap to convert. The pixel format of the new software bitmap. The alpha mode of the new software bitmap. The converted software bitmap.

Creates a copy of the provided SoftwareBitmap object.

The software bitmap to copy. The newly created copy of the software bitmap.

Copies the pixel data from an IBuffer into the SoftwareBitmap.

The buffer containing the pixel data to be copied.

Copies the current SoftwareBitmap into the provided SoftwareBitmap object.

The target software bitmap into which the data will be copied.

Copies the software bitmap pixel data into the specified IBuffer.

The target buffer to which the pixel data will be copied.

Creates a new SoftwareBitmap by performing a deep copy of the provided buffer. Modifications to the data in the new SoftwareBitmap will not effect the buffer from which it was created.

The source buffer from which the copy will be created. The pixel format of the software bitmap. The width of the software bitmap, in pixels. The height of the software bitmap, in pixels. The new software bitmap.

Creates a new SoftwareBitmap by performing a deep copy of the provided buffer. Modifications to the data in the new SoftwareBitmap will not effect the buffer from which it was created.

The source buffer from which the copy will be created. The pixel format of the software bitmap. The width of the software bitmap, in pixels. The height of the software bitmap, in pixels. The alpha mode of the software bitmap. The new software bitmap.

Asynchronously creates a new SoftwareBitmap by performing a deep copy of the provided IDirect3DSurface. Modifications to the data in the new SoftwareBitmap will not effect the surface from which it was created.

The source surface from which the copy will be created. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Asynchronously creates a new SoftwareBitmap by performing a deep copy of the provided IDirect3DSurface . Modifications to the data in the new SoftwareBitmap will not effect the surface from which it was created.

The source surface from which the copy will be created. The alpha mode of the software bitmap. An asynchronous operation that returns a SoftwareBitmap on successful completion.

Gets a read-only representation of the SoftwareBitmap object.

A read-only representation of the SoftwareBitmap object.

Gets a BitmapBuffer object that allows you to operate directly on the software bitmap's pixel data.

A value indicating the access mode of the returned buffer. The buffer containing pixel data.

Specifies the compression mode used for TIFF images.

The compression will be automatically selected.

CCITT3 compression will be applied.

CCITT4compression will be applied.

LZW compression will be applied.

LZWH Differencing compression will be applied.

No compression will be applied.

RLE compression will be applied.

ZIP compression will be applied.

The **IPrintDocumentSource** describes the source of the print document.

Represents the core functionality for a **PrintTaskOptions** object.

Gets the page description for a print job.

The job page number. The page description data.

An interface with properties that provide access to the core options for a print task.

Gets or sets the binding option for a print task.

The binding option.

Gets or sets the collation option for a print task.

The collation option.

Gets or sets the color mode option for the print task.

The color mode option.

Gets or sets the duplex option for a print task.

The duplex option.

Gets or sets the hole punch option for the print task.

The hole punch option.

Gets the **MaxCopies** option for the print task.

The MaxCopies option.

Gets or sets the media size option of the print task.

The media size option.

Gets or sets the media type option for the print task.

The media type option.

Gets the **MinCopies** option for the print task.

The MinCopies option.

Gets or sets the **NumberOfCopies** option for a print task.

The NumberOfCopies option.

Gets or sets the orientation option for a print task.

The orientation option.

Gets or sets the print quality option for a print task.

The print quality option.

Gets or sets the staple option for a print task.

The staple option.

An interface that provides access to the core UI configuration functionality that is supported by the print task options.

Gets the **DisplayedOptions** option for a print task.

The DisplayedOptions option.

Specifies the print binding option.

The bale binding option.

The option to bind the pages along their bottom edge.

The option to bind the pages along their left edge.

The option to bind the pages along their right edge.

The option to bind the pages along their top edge.

The option to bind the pages in booklet form.

The default binding option.

The option to bind the pages along their bottom edge, with stiches.

The option to bind the pages along their left edge, with stiches.

The option to bind the pages along their right edge, with stiches.

The option to bind the pages along their top edge, with stiches.

The option to fold the pages.

The option to offset the positioning of the pages in the output tray.

No binding required.

An unsupported binding option.

A custom option that is specific to the print device.

The option to trim the printed sheets.

Specifies the bordering printing option.

An option to indicate the printed output will be bordered.

An option to indicate the printed output will be borderless.

The default bordering option.

An unsupported border option.

A border option that is specific to the printer device.

Specifies the collation option.

An option to specify that collation has been selected for the printed output.

The default collation option.

An unsupported collation option.

A custom collation option that is specific to the print device.

An option to specify that collation has not been selected for the printed output.

Specifies the color mode option.

An option to indicate that the printed output will be in color.

The default color mode option.

An option to indicate that the printed output will be in shades of gray.

An option to indicate that the printed output will be in one shade of a single color.

An unsupported color mode option.

A custom color mode option that is specific to the print device.

Specifies the duplex option.

The default duplex option.

An unsupported duplex option.

The option to print on only one side of the sheet.

A custom duplex option that is specific to the print device.

The option to print on both sides of the sheet, flipped along the long edge.

The option to print on both sides of the sheet, flipped along the short edge.

Specifies the hole punch option.

The option to indicate that hole punching required along the bottom edges of the sheets.

The default hole punch option.

The option to indicate that hole punching required along the left edges of the sheets.

The option to indicate that hole punching is not required.

An unsupported hole punch option.

A custom hole punch option that is specific to the print device.

The option to indicate that hole punching required along the right edges of the sheets.

The option to indicate that hole punching required along the top edges of the sheets.

Informs Windows that an application wishes to participate in printing. The PrintManager class is also used for programmatically initiating printing.

Raised when a request to print has occurred. This event may be triggered by user action or via programmatic invocation of printing via the ShowPrintUIAsync method.

Retrieves the **PrintManager** object associated with the current window.

The **PrintManager** object.

Indicates whether or not the app is running on a device that supports printing.

Returns **true** if on a device that supports printing, returns **false** if not.

Programmatically initiates the user interface for printing content.

A Boolean value to indicate a TRUE for success or a FALSE for a failure.

Specifies the media size option.

A business card size.

A credit card size.

The default media size.

The IsoA0 media size.

The IsoA1 media size.

The IsoA10 media size.

The IsoA2 media size.

The IsoA3 media size.

The IsoA3Extra media size.

The IsoA3Rotated media size.

The IsoA4 media size.

The IsoA4Extra media size.

The IsoA4Rotated media size.

The IsoA5 media size.

The IsoA5Extra media size.

The IsoA5Rotated media size.

The IsoA6 media size.

The IsoA6Rotated media size.

The IsoA7 media size.

The IsoA8 media size.

The IsoA9 media size.

The IsoB0 media size.

The IsoB1 media size.

The IsoB10 media size.

The IsoB2 media size.

The IsoB3 media size.

The IsoB4 media size.

The IsoB4Envelope media size.

The IsoB5Envelope media size.

The IsoB5Extra media size.

The IsoB7 media size.

The IsoB8 media size.

The IsoB9 media size.

The IsoC0 media size.

The IsoC1 media size.

The IsoC10 media size.

The IsoC2 media size.

The IsoC3 media size.

The IsoC3Envelope media size.

The IsoC4 media size.

The IsoC4Envelope media size.

The IsoC5 media size.

The IsoC5Envelope media size.

The IsoC6 media size.

The IsoC6C5Envelope media size.

The IsoC6Envelope media size.

The IsoC7 media size.

The IsoC8 media size.

The IsoC9 media size.

The IsoDLEnvelope media size.

The IsoDLEnvelopeRotated media size.

The IsoSRA3 media size.

The Japan2LPhoto media size.

The JapanChou3Envelope media size.

The JapanChou3EnvelopeRotated media size.

The JapanChou4Envelope media size.

The JapanChou4EnvelopeRotated media size.

The JapanChouDoubleHagakiPostcard media size.

The JapanChouDoubleHagakiPostcardRotated media size.

The JapanHagakiPostcard media size.

The JapanHagakiPostcardRotated media size.

The JapanKaku2Envelope media size.

The JapanKaku2EnvelopeRotated media size.

The JapanKaku3Envelope media size.

The JapanKaku3EnvelopeRotated media size.

The JapanlPhoto media size.

The JapanQuadrupleHagakiPostcard media size.

The JapanYou1Envelope media size.

The JapanYou2Envelope media size.

The JapanYou3Envelope media size.

The JapanYou4Envelope media size.

The JapanYou4EnvelopeRotated media size.

The JapanYou6Envelope media size.

The JapanYou6EnvelopeRotated media size.

The JisB0 media size.

The JisB1 media size.

The JisB10 media size.

The JisB2 media size.

The JisB3 media size.

The JisB4 media size.

The JisB4 media size.

The JisB5 media size.

The JisB5Rotated media size.

The JisB6 media size.

The JisB6Rotated media size.

The JisB7 media size.

The JisB8 media size.

The JisB9 media size.

The NorthAmerica10x11 media size.

The NorthAmerica10x12 media size.

The NorthAmerica10x14 media size.

The NorthAmerica11x17 media size.

The NorthAmerica14x17 media size.

The NorthAmerica4x6 media size.

The NorthAmerica4x8 media size.

The NorthAmerica5x7 media size.

The NorthAmerica8x10 media size.

The NorthAmerica9x11 media size.

The NorthAmericaArchitectureASheet media size.

The NorthAmericaArchitectureBSheet media size.

The NorthAmericaArchitectureCSheet media size.

The NorthAmericaArchitectureDSheet media size.

The NorthAmericaArchitectureESheet media size.

The NorthAmericaCSheet media size.

The NorthAmericaDSheet media size.

The NorthAmericaESheet media sze.

The NorthAmericaExecutive media size.

The NorthAmericaGermanLegalFanfold media size.

The NorthAmericaGermanStandardFanfold media size.

The NorthAmericaLegal media size.

The NorthAmericaLegalExtra media size.

The NorthAmericaLetter media size.

The NorthAmericaLetterExtra media size.

The NorthAmericaLetterPlus media size.

The NorthAmericaLetterRotated media size.

The NorthAmericaMonarchEnvelope media size.

The NorthAmericaNote media size.

The NorthAmericaNumber10Envelope media size.

The NorthAmericaNumber10EnvelopeRotated media size.

The NorthAmericaNumber11Envelope media size.

The NorthAmericaNumber12Envelope media size.

The NorthAmericaNumber14Envelope media size.

The NorthAmericaNumber9Envelope media size.

The NorthAmericaPersonalEnvelope media size.

The NorthAmericaQuarto media size.

The NorthAmericaStatement media size.

The NorthAmericaSuperA media size.

The NorthAmericaSuperB media size.

The NorthAmericaTabloid media size.

The NorthAmericaTabloidExtra media size.

A media size that is not available with the application, or a size that is not supported by the print device.

The OtherMetricA3Plus media size.

The OtherMetricA4Plus media size.

The OtherMetricFolio media size.

OtherMetricInviteEnvelope media size.

The OtherMetricItalianEnvelope media size.

The Prc10Envelope media size.

The Prc10EnvelopeRotated media size.

The Prc16K media size.

The Prc16KRotated media size.

The Prc1Envelope media size.

The Prc1EnvelopeRotated media size.

The Prc2Envelope media size.

The Prc2EnvelopeRotated media size.

The Prc32K media size.

The Prc32KBig media size.

The Prc32KRotated media size.

The Prc3Envelope media size.

The Prc3EnvelopeRotated media size.

The Prc4Envelope media size.

The Prc4EnvelopeRotated media size.

The Prc5Envelope media size.

The Prc5EnvelopeRotated media size.

The Prc6Envelope media size.

The Prc6EnvelopeRotated media size.

The Prc7Envelope media size.

The Prc7EnvelopeRotated media size.

The Prc8Envelope media size.

The Prc8EnvelopeRotated media size.

The Prc9Envelope media size.

The Prc9EnvelopeRotated media size.

A media size that is specific to the print device.

The Roll04Inch media size.

The Roll06Inch media size.

The Roll08Inch media size.

The Roll12Inch media size.

The Roll15Inch media size.

The Roll18Inch media size.

The Roll22Inch media size.

The Roll24Inch media size.

The Roll30Inch media size.

The Roll36Inch media size.

The Roll54Inch media size.

Specifies the media types for the printed output.

The Archival media type.

The option to auto select a media type.

The BackPrintFilm media type.

The Bond media type.

The CardStock media type.

The Continuous media type.

The default media type for the printed output.

The EnvelopePlain media type.

The EnvelopeWindow media type.

The Fabric media type.

The HighResolution media type.

The Label media type.

The MultiLayerForm media type.

The MultiPartForm media type.

The option to indicate that a media type has not been selected.

A media type that is not available with the application or one that is not supported by the print device.

The Photographic media type.

The PhotographicFilm media type.

The PhotographicGlossy media type.

The PhotographicHighGloss media type.

The PhotographicMatte media type.

The PhotographicSatin media type.

The PhotographicSemiGloss media type.

The Plain media type.

A custom media type that is specific to the print device.

The Screen media type.

The ScreenPaged media type.

The Stationery media type.

The TabStockFull media type.

The TabStockPreCut media type.

The Transparency media type.

The TShirtTransfer media type.

Specifies the orientation options for the printed output.

The default orientation option.

The Landscape orientation option.

The LandscapeFlipped orientation option.

An orientaiton option that is not available with the application or one that is not supported by the print device.

The Portrait orientation option.

The PortraitFlipped orientation option.

A custom orientation that is specific to the print device.

Represents the data that describes a document page.

The resolution in dots per inch (DPI) for the X dimension of the page.

The resolution in dots per inch (DPI) for the Y dimension of the page.

The Rect within the page size on which content may actually be printed. Content outside of the , whether less or greater than the page size, will be cropped by the print target. The is specified in device independent pixels (DIPs).

The page size in device independent pixels (DIPs).

Stores formatting data for a single section of printable pages.

Initializes an instance of the PrintPageInfo class.

Gets the print resolution on the horizontal axis for the given print section.

Print resolution in dots per inch.

Gets the print resolution on the vertical axis for the given print section.

Print resolution in dots per inch.

Gets or sets the media size option of the given print section.

The media size option.

Gets or sets the orientation option for the given print section.

The orientation for the section.

Gets or sets the intended paper size on which to print the given section.

The page size of the print section.

Describes the range of pages in a print task.

Initializes an instance of the PrintPageRange class, using the specified page number.

The page number of the print range.

Initializes an instance of the PrintPageRange class, using the specified first and last page numbers.

The first page number of the print range. The last page number of the print range.

Gets the first page number of the print range.

The first page number of the print range.

Gets the last page number of the print range.

The last page number of the print range.

Describes the print page range options.

Gets and sets the allow all pages option of the print page range.

The allow all pages option.

Gets and sets the allow current page option of the print page range.

The allow current page option.

Gets and sets the allow custom set of pages option for the print page range.

The allow custom set of pages option.

Specifies the print quality options for the printed output.

The option to automatically select the print quality.

The default print quality option.

The Draft print quality option.

The Fax print quality option.

The High print quality option.

The Normal print quality option.

A print quality option that is not available with the application or one that is not supported by the print device.

The Photographic print quality option.

A print quality option that is specific to the print device.

The Text print quality option.

Specifies the staple options.

The default staple option.

The option to indicate that no stapling is required.

A staple option that is not available with the application or one that is not supported by the print device.

A custom staple option that is specific to the print device.

The option to saddle stitch the printed output.

The option to staple the bottom left of the printed output.

The option to staple the bottom right of the printed output.

The option to staple the printed output in two places along the bottom edge.

The option to staple the printed output in two places along the left edge.

The option to staple the printed output in two places along the right edge.

The option to staple the printed output in two places along the top edge.

The option to staple the top left of the printed output.

The option to staple the top right of the printed output.

Represents a printing operation including the content to be printed, as well as providing access to information describing how the content is to be printed.

Gets or sets a value that indicates whether the PrintTask supports 3D manufacturing devices, like a 3D printer.

True, if 3D manufacturing devices are supported.

Gets or sets a value that indicates whether the PrintTask will show a print preview.

True, if print preview is enabled.

Gets or sets a value indicating whether the PrintTask supports printer targets.

True if the PrintTask supports printer targets.

Retrieves the PrintTaskOptions for the print task that defines how the content is to be formatted for printing.

The list of print task options.

Retrieves a set of properties associated with the PrintTask.

The data package property set.

Returns a pointer to the app-provided object that represents the content to be printed. This object must support the IPrintDocumentSource interface.

The print task object.

Raised when the print task is completed.

Raised when the print system initializes print preview mode.

Raised to provide progress information about how much of the printed content has been submitted to the print subsystem for printing.

Raised when a print task begins submitting content to the print subsystem to be printed.

Reports the completion of the print task.

Gets the completion status of the print task.

The completion status of the print task.

Specifies the completion status of a print task.

An abandoned print task.

A canceled print task.

A failed print task.

A submitted print task.

Represents a collection of methods and properties for managing the options which define how the content is to be printed.

Gets or sets the binding option for the print task.

The binding option.

Gets or sets the bordering option for the print task.

The bordering option.

Gets or sets the collation option of the print tasks.

The collation option.

Gets or sets the color mode option of the print task.

The color mode option.

Gets the custom page range options for the print task.

The custom page range options.

Gets the list of options displayed for the print experience.

The list of displayed options.

Gets or sets the duplex option of the print task.

The duplex option.

Gets or sets the hole punch option of the print task.

The hole punch option.

Gets the maximum number of copies supported for the print task.

The maximum number of copies.

Gets or sets the media size option of the print task.

The media size option.

Gets or sets the media type option for the print task.

The media type option.

Gets the minimum number of copies allowed for the print task.

The minimum number of copies.

Gets or sets the value for the number of copies for the print task.

The value for the number of copies.

Gets or sets the orientation option for the print task.

The orientation for the print task.

Gets the page range options for the print task.

The page range options.

Gets or sets the print quality option for the print task.

The print quality for the print task.

Gets or sets the staple option for the print task.

The staple option for the print task.

Retrieves the physical dimensions of the printed page.

The page number. The page description data.

Retrieves the physical dimensions and formatting data of a printed page.

The formatting data for a given print section. The print ticket data for the given page(s), to be sent down the print pipeline.

Contains the event arguments for the PrintTask.Progressing event. This event is raised during the submitting phase of the PrintTask.

Gets the page count for a print task.

The page count for a print task.

Contains the request from the system to create a print task. This object is available from the PrintTaskRequestedEventArgs object passed to the PrintTaskRequested event.

Gets a DateTime value that indicates how long an app has to respond to the PrintTaskRequested event. If the system has not received a response from the PrintTaskRequested event handler by the time the deadline is reached, then the print task is ignored.

A value that indicates how long an app has to respond to the PrintTaskRequested event.

Creates a new PrintTask which indicates that the app has content to be printed.

Title for the print task. Pointer to a **PrintTaskSourceRequestedHandler** delegate for the print task. Pointer to the print task that was created.

Retrieves the deferral object associated with the PrintTaskRequest. The deferral object is used to handle asynchronous calls in the PrintTaskRequested event handler.

The **PrintTaskRequestedDeferral** for a print task.

Used to defer the request for a print task.

Indicates when the deferral for the print task request is over.

Event arguments associated with the PrintTaskRequest.

Gets the PrintTaskRequest object for a print task.

The PrintTaskRequest object for a print task.

Arguments associated with the PrintTaskSourceRequestedHandler delegate. Provides a method for handing the content to be printed to the Print Task.

Gets the **DateTime** object that indicates the deadline for a print task source request.

The deadline for a print task source request.

Gets a PrintTaskSourceRequestedDeferral object that provides access to a Complete method. This method indicates then the deferral is over.

Provides access to a **Complete** method.

Informs the print task of the content to be printed.

A pointer to the **IPrintDocumentSource** interface.

Used to defer the request for a print task source.

Indicates when the deferral for a print task source request is over.

Occurs when a print task requests the document to print. The supplied print document must implement the IPrintDocumentSource interface.

Pointer to a **PrintTaskSourceRequestedArgs** object.

Provides access to the canonical names for the options represented by the PrintTaskOptions class. You can use the StandardPrintTaskOptions class to identify print options displayed in the user experience or to retrieve specific options using the PrintTaskOptionDetails class.

Gets the canonical name for the binding option of the print task.

The canonical name for the binding option of the print task.

Gets the canonical name of the bordering option for the print task.

The canonical name of the bordering option for the print task.

Gets the canonical name for collation option of the print task.

The canonical name for collation option of the print task.

Gets the canonical name for color mode option of the print task.

The canonical name for color mode option of the print task.

Gets the canonical name for the copies option of the print task.

The canonical name for the copies option of the print task.

Gets the canonical name for the custom page ranges option for the print task.

The canonical name for the custom page ranges option for the print task.

Gets the canonical name for the duplex option of the print task.

The canonical name for the duplex option of the print task.

Gets the canonical name for the hole punch option of the print task.

The canonical name for the hole punch option of the print task.

Gets the canonical name for the input bin option of the print task.

The canonical name for the input bin option of the print task.

Gets the canonical name for the media size option of the print task.

The canonical name for the media size option of the print task.

Gets the canonical name for the media type option of the print task.

The canonical name for the media type option of the print task.

Gets the canonical name for the NUp (pages per sheet) option of the print task.

The canonical name for the NUp (pages per sheet) option of the print task.

Gets the canonical name for the orientation option of the print task.

The canonical name for the orientation option of the print task.

Gets the canonical name for the print quality option of the print task.

The canonical name for the print quality option of the print task.

Gets the canonical name for the staple option of the print task.

The canonical name for the staple option of the print task.

Represents the base class for all CustomPrintTaskOptionXxx objects.

Gets or sets the display name of the custom print task option.

The display name of the custom print task option.

Represents objects that list print task option items.

Gets a list of the print task option items.

A pointer to the list of the print task option items.

Represents objects that define the enumerated values of the print task options.

Gets the maximum enumerated value of the print task option.

The maximum enumerated value of the print task option.

Gets the minimum enumerated value of the print task option.

The minimum enumerated value of the print task option.

Represents the base class for the PrintTaskOptionXxx objects.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the ID for a print task option.

The ID for the print task option.

Gets the option type for a print task option.

The option type for a print task option.

Gets or sets the state of a print task option.

The state of a print task option.

Gets the enumerated value of a print task option.

The enumerated value of a print task option.

Sets the value for the print task option.

Value for the print task option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents objects that describe the text of a print task option.

Gets the maximum allowed number of characters for the text of a print task option.

The maximum allowed number of characters for the text of a print task option.

Represents the list of print binding options.

Gets or sets the description of the print binding option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print binding options.

A pointer to the list of items.

Gets the ID of the print binding option.

The ID of the print binding option.

Gets the option type of the print binding option.

The binding option type.

Gets or sets the state of the print binding option.

The binding option state.

Gets or sets the enumerated value of the print binding option.

The binding option value.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print binding option.

Value for the print binding option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print bordering options.

Gets or sets a description of the print bordering option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print bordering options.

A pointer to the list of items.

Gets the ID of the print bordering option.

The ID of the print bordering option.

Gets the option type of the print bordering option.

The bordering option type

Gets or sets the state of the print bordering option.

The print bordering option state.

Gets or sets the enumerated value of the print bordering option.

The bordering option value

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print bordering option.

Value for the print bordering option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print collation options.

Gets or sets the description of the print collation option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print collation option.

Pointer to the list of items.

Gets the ID of the print collation option.

The ID of the collation option.

Gets the option type for the print collation option.

The option type.

Gets or sets the state of the print collation option.

The state of the collation option.

Gets or sets the enumerated value of the print collation option.

The value of the print collation option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print collation option.

Value for the print collation option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print color mode options.

Gets or sets the description of the print color mode option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print color mode option.

Pointer to the list of items.

Gets the ID for the print color mode option.

The ID of the color mode option.

Gets the option type for the print color mode option.

The color mode option type.

Gets or sets the state of the print color mode option.

The state of the print color mode option.

Gets or sets the enumerated value of the print color mode option.

The state of the print color mode option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print color mode option.

Value for the print color mode option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the option for the number of printed copies.

Gets or sets the description of the print copies option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the value for the maximum number of printed copies allowed.

The maximum number of printed copies allowed.

Gets the value for the minimum number of printed copies allowed.

The minimum number of printed copies allowed.

Gets the ID for the option for the number of printed copies.

The ID of the option.

Gets the option type for the option for the number of printed copies.

The option type.

Gets or sets the state of the option for the number of printed copies.

The state of the option.

Gets or sets the number of copies for a print task.

The number of copies for a print task.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print copies option.

Value for the print copies option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Allows apps to add a collection of enumerable options to the app print experience.

Gets or sets the display name of the custom print task option item.

The display name of the option item.

Gets the ID of the custom print task option item.

The ID of the print task option.

Represents a list of the custom print task option items.

Gets or sets the description for the print custom item list option.

String containing the description.

Gets or sets the display name of an item in the list of custom print task options.

The display name of the option item.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets an item from the list of custom print tasks.

Pointer to the item.

Gets the ID of a custom print task option.

The option ID.

Gets the option type for a custom print task option.

The option type.

Gets or sets the state of the list of custom print task option items.

The state value.

Gets or sets the value of the list of custom print tasks.

The value of the list.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the ID or display name of an item in the list of custom print task options.

The ID of the option item. The display name of the option item.

Sets the item ID, display name, description, or icon in the list of custom print item options.

The ID of the option item. The display name of the option item. The description of the option item. The icon used by the option item. The icon needs to be in the SVG file format.

Sets the value for the item ID or the display name of the custom item.

Value for the item ID or the display name of the custom item. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents a custom print task option.

Gets or sets a description of the print custom text option.

String containing the description.

Gets or sets the display name of the custom print task option.

The display name of the option.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets or sets the maximum number of characters for the display name of the custom print task option.

The maximum number of characters.

Gets the ID of the custom print task option.

The ID of the custom option.

Gets the option type for the custom print task option.

The option type.

Gets or sets the state of a custom print task option.

The state of the custom option.

Gets or sets the value of a custom print task option.

The value of the custom option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the custom print task.

Value for the custom print task. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print custom toggle options.

Gets or sets the description of the print custom toggle option.

String containing the description.

Gets or sets the display name for the print custom toggle option.

A string containing the print custom toggle option display name.

Gets or sets the string for an error condition.

String that describes an error condition.

Gets the ID of the print custom toggle option.

The ID of the print custom toggle option.

Gets the option type for the print custom toggle option.

The print option type.

Gets or sets the state of the print custom toggle option.

The print option state.

Gets or sets the enumerated value of the print custom toggle option.

The custom toggle value.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print custom toggle option.

Value of the print custom toggle. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print duplex options.

Gets or sets the description of the print duplex option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of print duplex options.

The list of print duplex options.

Gets the ID of the print duplex option.

The ID of the print duplex option.

Gets the option type of the print duplex option.

The option type of the print duplex option.

Gets or sets the state of the print duplex options.

The state of the print duplex option.

Gets or sets the enumerated vlaue of the print duplex option.

The enumerated value of the print duplex option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the duplex option.

Value for the duplex option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of punch hole options.

Gets or sets the description of the hole punch option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the hole punch option.

A pointer to the list.

Gets the ID for the hole punch option.

The ID for the option.

Gets the option type for the hole punch option.

The option type.

Gets or sets the state of the hole punch option.

The state of the hole punch option.

Gets or sets the enumerated value of the hole punch option.

The enumerated value of the hole punch option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the hole punch option.

Value for the hole punch option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of media size options.

Gets or sets the description of the print media size option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of print media size option items.

A pointer to the list of items.

Gets the ID for the print media size option.

The ID for the media size option.

Gets the option type for the option for the number of printed copies.

The option type.

Gets or sets the state of the option for the number of printed copies.

The state of the option.

Gets or sets the number of copies for a print task.

The number of copies for a print task.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the media size option.

Value for the media size option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print media type options.

Gets or sets the description of the print media type option.

String that describes the print media type option.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print media type options.

A pointer to the list of media type options.

Gets the ID for the print media type option.

The ID for the media type option.

Gets the option type for the print media type option.

The option type.

Gets or sets the state for the print media type option.

The state of the media type option.

Gets or sets the enumerated value of the print media type option.

The enumerated value of the media type option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the media type option.

Value for the media type option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Specifies the print task option states.

The UI for the print tasks is visible to the user.

The UI for the print tasks has been enabled.

The UI for the print tasks has not been enabled.

Specifies the print task option types.

A type of option that is a list of items.

A type of option that is numerical.

A type of option that is a string or some text.

A type of option that is a toggle.

Unknown option type.

Represents the list of print orientation options.

Gets or sets a description of the print orientation options.

String describing the print orientation options.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print media type options.

A pointer to the list of media type options.

Gets the ID for the print orientation option.

The ID for the print orientation option.

Gets the option type for the print media type option.

The option type.

Gets or sets the state for the print media type option.

The state of the media type option.

Gets or sets the enumerated value of the print media type option.

The enumerated value of the media type option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print orientation option.

Value for the print orientation option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print page range options.

Gets or sets a description of the print page range option.

String that describes the print page range option.

Gets or sets the string for an error condition.

String that describes an error condition.

Gets the ID of the print page range option.

The ID for the print page range option.

Gets the option type for the print page range option.

The option type.

Gets or sets the state for the print page range option.

The state of the print page range option.

Gets the enumerated value of the print page range option.

The enumerated value of the print page range option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print page range option.

Value for the print page range option Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents the list of print quality options.

Gets or sets the description of the print quality option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the print quality options.

A pointer to the list of items.

Gets the ID for the print quality option.

The ID for the print quality option.

Gets the option type for the print quality option.

The option type.

Gets or sets the state of the print quality option.

The state of the print quality option.

Gets or sets the enumerated value of the print quality option.

The enumerated value of the print quality option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the print quality option.

Value for the print quality option. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Represents a list of the stapling options.

Gets or sets the description of the print staple option.

String containing the description.

Gets or sets the string for an error condition.

String that describes the error condition.

Gets the list of items for the stapling options.

A pointer to the list of items.

Gets the ID for the stapling option.

The ID for the stapling option.

Gets the option type for the stapling option.

The option type.

Gets or sets the state of the stapling option.

The state of the stapling option.

Gets or sets the enumerated value of the stapling option.

The enumerated value of the stapling option.

Gets or sets a string for a warning condition.

String that describes a warning condition.

Sets the value for the staple opiton.

Value for the staple opiton. Boolean value that indicates TRUE for a successful Get or Set, and FALSE for a failed Get or Set.

Called when a print task option has changed.

Gets the ID of the print task option that changed.

The ID of the property that changed.

A collection of events, methods and properties for advanced print tasks.

Gets the list of print task options that are currently displayed.

A pointer to the list of options.

Gets the list of options for the advanced print task.

The list of options for the advanced print task.

Raised when the print system begins a validation pass on the current state of the print ticket.

Raised when any one of the advanced print task options is changed.

Creates a custom list of items that allow the user to choose the page format.

The ID for the custom item. The display name for the custom item. The list of custom items.

Creates a CustomPrintTaskOptionText object to handle the display name and other parameters of the advanced print task option item.

The ID of the print task option. The display name of the print task option. The **CustomPrintTaskOptionText** object.

Creates a PrintCustomToggleOptionDetails object to handle the display name and other parameters of the advanced print task option item.

The ID of the print task option. The display name of the print task option.

Used to retrieve the available options for a print task.

Pointer to a **PrintTaskOptions** object. Pointer to a **PrintTaskOptionDetails** object.

Returns a **PrintPageDescription** object for the referenced page number.

The page number. The **PrintPageDescription** object.

This class presents the configuration options that are supported by the printer. It contains read-only print feature objects with certain options available for each.

Gets the available document binding feature for this print ticket.

The document binding feature object.

Gets the available document collation feature for this print ticket.

The document collation feature object.

Gets the available duplex printing feature for this print ticket.

The duplex printing feature object.

Gets the available document hole-punch feature for this print ticket.

The document hole-punch feature object.

Gets the available printing input bin feature for this print ticket.

The printing input bin feature object.

Gets the available N-up printing feature for this print ticket.

The N-up printing feature object.

Gets the available document staple feature for this print ticket.

The document staple feature object.

Gets the avilable job passcode feature for this print ticket.

The job passcode feature object.

Gets the canonical name of this object.

The canonical name.

Gets the available document borderless feature for this print ticket.

The borderless feature object.

Gets the available page media size feature for this print ticket.

The page media size feature object.

Gets the available page media type feature for this print ticket.

The page media type feature object.

Gets the available page orientation feature for this print ticket.

The page orientation feature object.

Gets the available page color feature for this print ticket.

The page color feature object.

Gets the available page quality feature for this print ticket.

The page quality feature object.

Gets the available page resolution feature for this print ticket.

The page resolution feature object.

Gets the XML namespace for this capabilities object.

The XML namespace.

Gets the XML node for this capabilities object.

The XML node.

Gets the specified print feature object.

The canonical name of the print feature. The XML namespace of the print feature. The specified print feature object.

Gets the parameter definition object for the specified printing parameter.

The canonical name of the printing parameter. The XML namespace of the printing parameter. The parameter definition object.

Represents a modifiable feature of the print ticket. A feature is a device capability that has an enumerable list of settings, unlike a parameter which can be set to values within a range.

Gets the friendly name of the print ticket feature.

The friendly name string.

Gets the canonical name of the print ticket feature.

The canonical name string.

Gets a list of print ticket options available for this feature.

A list of option objects.

Gets the selection type for this print feature.

The selection type.

Gets the XML namespace that this print feature belongs to.

The XML namespace for this print feature.

Gets the XML node that this print feature belongs to.

The XML node for this print feature.

Gets the specified print feature option object.

The canonical name of the print feature option. The XML namespace of the print feature option. The specified print feature option object.

Gets the option that is currently selected for this print feature.

The selected option.

Sets the given option as the selected option for this print feature.

The option to be set as selected.

Contains values that describe the selection type of a print ticket feature. This indicates whether the user can select only one option or multiple for a feature.

The user can select multiple options for the print feature.

The user must select one option for the print feature.

Represents a single possible setting for a print feature.

Gets the UI-friendly display name of this option.

The display name.

Gets the canonical name of this print option.

The canonical name.

Gets the XML namespace of this print option.

The XML namespace.

Gets the XML node of this print option.

The XML node.

Gets the XML node of a property element of the current print option.

The canonical name of the property. The XML namespace of the property. The XML node for the property element.

Gets the value associated with a property element of the current print option.

The canonical name of the property. The XML namespace of the property. The value associated with the property.

Gets the XML node of a scored property element of the current print option.

The canonical name of the scored property. The XML namespace of the scored property. The XML node for the property element.

Gets the value associated with a scored property element of the current print option.

The canonical name of the scored property. The XML namespace of the scored property. The value associated with the scored property.

Contains values that describe the data type of a print ticket parameter.

Integer data type.

Numeric string data type.

String data type.

Represents the definition and value characteristics of a print parameter.

Gets the data type of this print parameter.

The parameter data type.

Gets the canonical name of this print parameter

The canonical name.

Gets the maximum value that can be assigned to this print parameter (assuming an integer datatype) or the maximum length of string that can be assigned (assuming a string datatype).

An `int` indicating the maximum value.

Gets the minimum value that can be assigned to this print parameter (assuming an integer datatype) or the minimum length of string that can be assigned (assuming a string datatype).

An `int` indicating the minimum value.

Gets the unit type associated with the value of this print parameter.

A string indicating the unit type.

Gets the XML namespace of the print parameter.

The XML namespace.

Get the XML node of the print parameter.

The XML node.

Represents a the selected setting for a printing parameter. A printing parameter is a device capability that can be set to values within a range, unlike a feature which has an enumerable list of settings.

Gets the canonical name of the print parameter.

The canonical name.

Gets or sets the value of the print parameter.

The value.

Gets the XML namespace of the print parameter.

The XML namespace.

Gets the XML node of the print parameter.

The XML node.

Represents a value of a printing parameter or print option property.

Gets the type of value that this class object represents.

The value type.

Converts the print value to an `int`.

An `int` indicating the value.

Converts the print value to a string.

A string indicating the value.

Contains values that describe the types of print values.

Integer value.

String value.

The value type is unknown.

This class represents an XML *PrintTicket document* and allows it to be modified easily. The *PrintTicket document* contains instructions on how the printer should set its various features for a printing task.

Gets the document binding configuration for this print ticket.

The document binding feature object.

Gets the document collation configuration for this print ticket.

The document collation feature object.

Gets the duplex printing configuration for this print ticket.

The duplex printing feature object.

Gets the document hole-punch configuration for this print ticket.

The document hole-punch feature object.

Gets the printing input bin configuration for this print ticket.

The printing input bin feature object.

Gets the N-up printing configuration for this print ticket.

The N-up printing feature object.

Gets the document staple configuration for this print ticket.

The document staple feature object.

Gets the job passcode configuration for this print ticket.

The job passcode feature object.

Gets the canonical name of this print ticket.

The canonical name.

Gets the document borderless configuration for this print ticket.

The borderless feature object.

Gets the page media size configuration for this print ticket.

The page media size feature object.

Gets the page media type configuration for this print ticket.

The page media type feature object.

Gets the page orientation configuration for this print ticket.

The page orientation feature object.

Gets the page color configuration for this print ticket.

The page color feature object.

Gets the page quality configuration for this print ticket.

The page quality feature object.

Gets the page resolution configuration for this print ticket.

The page resolution feature object.

Gets the XML namespace for the print ticket.

The XML namespace.

Gets the XML node for the print ticket.

The XML node.

Gets the print capabilities object for this print ticket.

The print ticket capabilities.

Gets the specified print feature object.

The canonical name of the print feature. The XML namespace of the print feature. The specified print feature object.

Gets the parameter initializer object for a specified printing parameter.

The canonical name of the printing parameter The XML namespace of the printing parameter. The parameter initializer object.

Merges a newly configured print ticket onto the current print ticket and validates the merged ticket, guaranteeing that it does not ask for any printing functionality that the printer does not support.

The print ticket object that has been configured. The validated print ticket object.

Notifies the print system that the XML DOM object has changed.

This method does not return a value.

Sets the parameter initializer object for a specified printing parameter. This can only be done if an initializer for the specified parameter doesn't yet exist.

The canonical name of the printing parameter The XML namespace of the printing parameter. The int value to set this parameter to. The parameter initializer object for the newly set parameter.

Sets the given print parameter to the given string value. This can only be done if an initializer for the specified parameter doesn't yet exist.

The canonical name of the printing parameter. The XML namespace of the printing parameter. The value to set this parameter to. The parameter initializer object for the newly set parameter.

Checks that the given print ticket does not ask for any printing functionality that the printer does not support.

An asynchronous operation with a validation result object.

Represents the result of a print ticket validation.

Gets the error report (if an error occurred) relating to the ticket validation.

An HResult for the reported error.

Indicates whether the print ticket was found to be valid.

**true** if the ticket was valid, **false** if it was invalid.

Represents a single print workflow session that runs in the background.

The status of the current print workflow session.

The session status.

Raised first in the print workflow background session. This event exposes information about the print job but not the print content itself. Register for this event to do work on a print job configuration before printing.

Raised when the final XPS print data has become available. This is done after the SetupRequested event and after the optional UI-dependent foreground task is completed.

Starts the print workflow background process. The events of this class are raised in sequential order.

Contains information about a PrintWorkflowBackgroundSession.SetupRequested event that was raised.

Gets information about the source application, print job title, and session ID for this print workflow session.

The configuration data for this print job.

Gets a deferral object for managing the work done on the corresponding PrintWorkflowBackgroundSession.SetupRequested event.

A deferral object.

Gets the print ticket for the current print task.

An asynchronous operation with a print ticket.

Registers this print workflow session as requiring a UI. This will cause the corresponding foreground task to be activated before the PrintWorkflowBackgroundSession.Submitted event is raised by the background task.

Contains information about the source application, print job title, and session ID for a print workflow session.

Gets the job title for this print job.

The job title string.

Gets the session ID for this print job.

The unique session ID.

Gets the display name of the external application that initiated the print job.

The display name of the source application.

Represents a single print workflow session that runs in the foreground.

The status of the current print workflow session.

The session status.

Raised first in the print workflow foreground session. This event exposes information about the print job but not the print content itself. Register for this event to do UI-dependent work on the print job before printing.

Raised when the XPS print data is available to be read. This is done after the SetupRequested event is raised. Register for this event to do UI-dependent work that requires displaying the print content.

Starts the print workflow foreground process. The events of this class are raised in sequential order.

Contains information about a PrintWorkflowForegroundSession.SetupRequested event that was raised.

Gets information about the source application, print job title, and session ID for this print workflow session.

The configuration data for this print job.

Gets a deferral object for managing the work done on the corresponding PrintWorkflowForegroundSession.SetupRequested event.

A deferral object.

Gets the print ticket for the current print task.

An asynchronous operation with a print ticket.

Represents print content in the form of the COM-based XPS object model.

Represents the print output data in the form of the COM-based XPS object model.

Contains values that describe the status of the current print workflow session.

The current session has been aborted.

The current session has been closed.

The current session has completed.

The current session has started.

Represents raw print data from the source application.

Gets the print ticket for the printing task associated with this print data.

A print ticket object with the current print task configuration.

Gets the print data as an XPS data stream.

An data stream of XPS data.

Gets the print data in the form of the COM-friendly XPS object model.

The XPS object model content.

Represents print data in the form of an XPS data stream.

Returns this print data as an input stream.

An input stream of the print data.

Represents an output data stream to be sent to the printer.

Returns the print data as an output stream.

An output stream of the print data.

Contains information about a PrintWorkflowBackgroundSession.Submitted event that was raised.

Gets information about the current print task.

Information about the print task.

Gets a deferral object for managing the work done on the corresponding PrintWorkflowBackgroundSession.Submitted event.

A deferral object.

Gets a reference to the target document for outputting the edited print job.

The print ticket specifying printer configuration options. If no printer options were specified for this print job, use **null**. The target document for output.

Contains information about a print task that has potentially been modified by a print workflow session.

Gets information about the source application, print job title, and session ID for this print workflow session.

The configuration data for this print job.

Gets the source application's original XPS data. This can be edited and then assigned to the print target in order to change the print content.

The XPS print data.

Indicates the completion of the print workflow session. This method should be called in the handler for the PrintWorkflowBackgroundSession.Submitted event when all work relating to the print task has been completed or when an error occurred that requires the process to be aborted.

Indicates the status of the completed print workflow procedure. This will determine whether the printing pipeline should continue or abort.

Contains values that describe the status of a print workflow session.

The session was cancelled: abort the printing process.

The session failed: abort the printing process.

The session was successful: continue to printing

Represents the output document to be sent to the printer driver.

Gets the output document in the form of a data stream.

The target document data stream.

Gets the output document in the form of the COM-based XPS object model.

The output document object model content.

Represents contextual information about the triggering of a print workflow background task.

Gets the print workflow session object that should manage the behavior of the background task that was triggered.

The single print workflow background session.

Contains contextual information about a print workflow foreground task that has been activated.

Gets the reason that this app was activated.

A value indicating the type of task this app was activated to execute. In this case, it should be ActivationKind.PrintWorkflowForegroundTask.

Gets the execution state of the app before it was activated.

The execution state.

Gets the print workflow session object that should manage the behavior of the foreground task that was activated.

The single print workflow foreground session.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Gets the user that the foreground app was activated for.

The user that the app was activated for.

Contains information about a PrintWorkflowForegroundSession.XpsDataAvailable event that was raised.

Gets information about the current print task.

Information about the print task.

Gets a deferral object for managing the work done on the corresponding PrintWorkflowForegroundSession.XpsDataAvailable event.

A deferral object.

Provides functionality to configure the data sent to the mobile device management server.

An MDM alert with custom data fields.

Custom MDM data sent to the server.

String form of the data sent to the server.

The data format of the MDM alert.

An MdmAlertDataType enumeration value.

The priority or criticality of the alert.

An MdmAlertMark enumeration value.

The local URI path to the source of the alert.

The string value of the URI path.

A read-only status code sent by the server in response to the alert.

Integer form of the status code (200, 404, etc.).

The local URI path to the inventory location of the application.

The string value of the URI path.

The type of the alert. This is also the alert ID.

A reversed domain name formatted string.

The possible data formats of an MDM alert payload.

Base-64 data.

Boolean data.

Integer data.

String data.

Values indicating priority or criticality of the MDM alert.

The alert is critical.

The alert is fatal.

The alert is informational.

No information.

The alert is a warning.

Provides functionality to start an MDM session with the server.

A vector list of all MdmAlerts for the current session.

A vector list of MdmAlerts.

The extended error code for an MDM session.

HRESULT value of the error.

The ID for the MDM session.

The string value of the session ID.

Gets the state of an MDM session.

An MdmSessionState enumeration value for the state of the session.

Allows the caller to re-open an existing MDM session.

Results of the operation.

Deletes the MDM session.

Start an MDM session with a constant alerts.

Results of the operation.

Starts an MDM session with custom alerts.

An iterable list of all custom MdmAlerts. Results of the operation.

This is used as an entry point for creating new sessions, viewing old sessions, or cleanup.

Gets all MDM session IDs for the current enterprise account.

An IVectorView containing the session IDs.

Deletes past session information.

The string value of the session ID.

Gets the MDM session's information given the session's ID.

The string value of the MDM session ID. The MdmSession corresponding to the provided session ID.

Attempts to start an MDM session for the current enterprise account.

The MdmSession information of the created session.

The various states of an MDM session.

The MDM session has an alert status available.

The MDM session is communicating with the server.

The MDM session is complete.

The MDM session is connecting to the server.

The MDM session has not started.

The MDM session is retrying.

The MDM session is starting.

Enables you to access and manage the app data store for a package family.

Provides access to the app data store for the specified package family.

The package family name. The app data store.

A subset of DeploymentOptions that are valid for App Installer.

If this package is currently in use, the processes associated with the package are shut down forcibly so that registration can continue.

When you set this option, the app is instructed to skip resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered.

Do not download missing referenced packages

The default behavior is used.

When you set this option, only the required content group will be staged. An app can be installed as a package with the required content group alone.

Specifies the deployment options that you can configure when you use the AddPackageByUriAsync method to add a package.

Creates a new instance of the AddPackageOptions class.

Gets or sets a value that indicates whether to allow an unsigned package to be added.

**TRUE** indicates that an unsigned package can be added; otherwise, **FALSE**.

Gets or sets a value that indicates whether to delay registration of the main package or dependency packages if the packages are currently in use.

**TRUE** indicates that registration of the main package or dependency packages will be delayed until the next time the application is activated if the packages are currently in use; otherwise, **FALSE**.

Gets the list of URIs of the dependency packages to add.

The list of URIs of the dependency packages to add.

Gets or sets a value that indicates whether the app is installed in developer mode.

**TRUE** to install the app in developer mode; otherwise, **FALSE**.

Gets or sets the URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

The URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package, or any package that depends on the package, is currently in use.

**TRUE** indicates that the processes associated with the package will be shut down forcibly so that registration can continue; otherwise, **FALSE**.

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package is currently in use.

**TRUE** indicates that the processes associated with the package will be shut down forcibly so that registration can continue; otherwise, **FALSE**.

Gets or sets a value that indicates whether to force a specific version of a package to be added, regardless of if a higher version is already added.

**TRUE** forces a specific version of a package to be added, regardless of if a higher version is already added; otherwise, **FALSE**.

Gets or sets a value that indicates whether the app skips resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered.

**TRUE** instructs the app to skip all resource applicability checks and stages or registers all resource packages; otherwise, **FALSE**.

Gets the list of package family names from the main bundle to be added.

The list of package family names from the main bundle to be added.

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

The list of URIs of related optional packages to be updated to the same version as the new optional packages.

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

The list of URIs of related optional packages to be updated to the same version as the new optional packages.

Gets or sets a value that indicates whether only the required content group will be added. An app can be installed as a package with the required content group alone.

**TRUE** indicates that only the required content group will be staged; otherwise, **FALSE**.

Gets or sets a value that indicates whether to remove files that have been created on the target machine during the install process in the case of a failed deployment.

**TRUE** indicates that, in the case of a failed deployment, files that have been created on the target machine during the install process will be removed; otherwise, **FALSE**.

Gets or sets a value that indicates whether to stage the package in place.

**TRUE** indicates that the package will be staged in place; otherwise, **FALSE**.

Gets or sets the stub options for the package.

The stub options for the package.

Gets or sets the volume to which the package is added.

The volume to which the package is added.

Specifies the package deployment options.

When you set this option, the app is installed in development mode. For info about development mode, see **Remarks**. Use this option to enable key app development scenarios.You can't use this option in conjunction with a bundle package. If you use this option with a bundle package, your call returns ERROR_INSTALL_FAILED.

If this package, or any package that depends on this package, is currently in use, the processes associated with the package are shut down forcibly so that registration can continue.

If this package is currently in use, the processes associated with the package are shut down forcibly so that registration can continue.

Force a specific version of a package to be staged/registered, regardless of if a higher version is already staged/registered.

When you set this option, the app is instructed to skip resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered. Windows only.

The default behavior is used.

When you set this option, only the required content group will be staged. An app can be installed as a package with the required content group alone.

In the case of a failed deployment, do not remove files that have been created on the target machine during the install process.

When you set this option, the package will be staged in place. This field is useful for notifying the system to prepare for app registration in virtual desktop scenarios.

Contains progress information for the deployment request.

The progress percentage of the deployment request.

The progress state of the deployment request.

Represents the state of a deployment request.

The deployment request is being processed.

The deployment request is queued.

Provides the result of a deployment request.

Gets the activity identifier used to look up an event in Windows Event Viewer. Gets the activity identifier used to look up an event. All events of a deployment operation are logged with the same **activityId**.

The activity identifier.

Gets extended error text for the error if the deployment operation is not successful.

The extended error text.

The extended error code can be used to distinguish a specific error condition which needs to be handled differently from the general error indicated by the return code. The extended error code may provide a more specific reason for the failure that caused the general error. Also, it usually corresponds directly to the specific message in the ErrorText.

The error code.

Describes whether or not the package is fully registered and ready to use.

true if the package is registered; otherwise, false.

Represents the install state of the package.

The package is ready for use.

The package has not been installed.

The installation of the package has been paused.

The package has been downloaded.

Manages the software available to a user.

Creates and initializes a new instance of the object.

Get the debugging settings for package deployment.

The debugging settings for package deployment.

Adds a package (the main package) and its dependency packages for the current user, using the specified deployment options.

The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. A bitwise combination of enumeration values from the DeploymentOptions enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Adds a package (the main package) and its dependency packages to the specified volume for the current user, using the specified deployment options.

The Uri of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. A bitwise combination of enumeration values from the DeploymentOptions enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. The volume to which the package is added. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Adds a package and its dependency packages to the specified volume for the current user, using the specified deployment options.

The Uri of the source package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The Uris of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. A bitwise combination of enumeration values from the DeploymentOptions enumeration. **ForceApplicationShutdown** and **None** are the only valid options for this method. Specifying any other option results in an E_INVALIDARG return value. The volume that the package is added to. The package family names from the main bundle to be registered. The URIs of the other packages in the main bundle to be registered. The DeploymentProgress percentage of completion over the entire course of the deployment operation.

Adds a package (the main package) and its dependency packages for the current user, using the specified deployment options.

The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The URIs of framework dependencies to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. The deployment options for the package. The volume to which the package is added. The package family names from the main bundle to be registered. The URIs of optional packages to be installed with the main app package. URIs of related optional packages to be updated to the same version as the new optional packages. The DeploymentProgress percentage of completion over the entire course of the deployment operation.

Allows single or multiple app packages to be installed with an .appinstaller file.

A Uri to the .appinstaller file. The options as specified in AddPackageByAppInstallerOptions. The volume that the package is installed to.

Adds a package (the main package) and any additional dependency packages for the current user, using the specified deployment options.

The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The package deployment options for the operation. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Creates a new volume. The caller must be a member of the administrators group.

The absolute path of the package store. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperation** interface and returns the newly added PackageVolume.

Cleans up a specified package for a specified user. Used to cleanup packages installed for a user after their user profile is deleted.

The package name. The user security identifier (SID). The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Clears the status of a package.

The full name of the package. One of the enumeration values that specifies the status to clear.

Deprovisions an app package so new users on the device will no longer have the app automatically installed.

The package family name of the package to be deprovisioned. An async operation with the current DeploymentProgress status.

Retrieves information about the specified package installed for any user.

The full name of the package. This parameter cannot be null. If this method succeeds it returns a package object that contains information about the specified package, including but not limited to its name, publisher, version, and install location. If the specified package is not found, this method returns **null**.

Retrieves information about a specific package installed for a specific user or for all users.

The user security identifier (SID). If this parameter is string.Empty, the packages are retrieved for the current user. The full name of the package. The package.

Retrieves information about a specified family of packages installed across all users.

If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location.

Retrieves information about a specified family of packages installed across all users.

The package family name. This parameter cannot be **null**. If the method succeeds, an enumerable collection of package objects with the same package family name will be returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list.

Finds all installed packages with the specified name and publisher.

The package name. This parameter cannot be **null**. The package publisher. This parameter cannot be **null**. If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list.

Finds all packages installed for the specified user.

The user security identifier (SID). If this parameter is **string.Empty**, the packages are retrieved for the current user. If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location.

Retrieves information about a specified family of packages installed for a specific user.

The user security identifier (SID). If this parameter is String.Empty, the packages are retrieved for the current user. The family name of packages to find. This parameter cannot be **null**. If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list.

Retrieves information about all packages with the specified package name and publisher name, installed for a specific user.

The user security identifier (SID). If this parameter is an empty string (""), the packages are retrieved for the current user. The package name. This parameter cannot be **null**. The package publisher. This parameter cannot be **null**. If the method succeeds, an enumerable collection of package objects is returned. Each Package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list.

Retrieves information about packages of specific types with the specified package name and publisher name, installed for a specific user.

The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. The package name. This parameter can't be **null**. The package publisher. This parameter can't be **null**. A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package publisher and family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return.

Retrieves information about a specified family of packages and of specific types that are installed for the specified user.

The user security identifier (SID). If this parameter is **String.Empty**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. The family name of packages to find. This parameter can't be **null**. A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return.

Finds packages of specific types that are installed for the specified user.

The user security identifier (SID). If this parameter is **null**, the packages are retrieved for the current user. Any user SID other than that of current user requires administrative privileges. A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return.

Finds all installed packages of specific types with the specified name and publisher.

The package name. This parameter can't be **null**. The package publisher. This parameter can't be **null**. A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects with the same package name and publisher name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified name and publisher are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return.

Retrieves information about a specified family of packages and specific package types that are installed across all users.

The package family name. This parameter can't be **null**. A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects with the same package family name is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. If no packages with the specified package family name are found, this method returns an empty list. The *packageTypes* parameter determines the types of packages to return.

Retrieves information about specific package types that are installed across all users.

A combination of PackageTypes -typed values that are combined by using a bitwise OR operation. The resulting value specifies the types of packages to be included in the result set. If the method succeeds, an enumerable collection of package objects is returned. Each package object in this collection contains information about the package, including but not limited to its name, publisher, version, and install location. The *packageTypes* parameter determines the types of packages to return.

Gets the specified volume.

The volume media ID, which is a GUID value. The requested volume.

Gets all the known volumes, regardless of their current state.

All the known volumes, regardless of their current state.

Gets the list of all installed packages on the device.

The list of all installed packages on the device.

Finds the users who have installed the specified package.

The full name of the package. This parameter cannot be **null**. If the method succeeds, an enumerable collection of package user information objects is returned. Each PackageUserInformation object in this collection contains the user security identifier (user SID) of a user for whom the specified package is installed. If no packages with the specified package full name are found, this method returns an empty list.

Gets the default package volume, which is the target of deployment operations such as the AddPackageAsync method.

The default package volume, which is the target of deployment operations such as the AddPackageAsync method.

Gets a value that indicates whether the specified app package currently prefers to run as a full app or a stub app.

The family name of the app package to query. A value that indicates whether the specified app package currently prefers to run as a full app or a stub app.

Gets the package volumes on the device.

Returns an asynchronous operation that completes with the package volumes.

Moves the specified package to the specified volume using the specified deployment options.

The full name of the package to move. One of the enumeration values that specifies a deployment option. The target volume. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Enables an app package to be installed for all users on a device.

The FamilyName of the app package to be installed. The progress and the result of the app package deployment.

Registers a package (the main package) and its dependency packages for the current user, using the specified deployment options.

The Uri of the main package. The Uris of the dependency packages. A bitwise combination of enumeration values from the DeploymentOptions enumeration that specify deployment options. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Registers a package (the main package) and its dependency packages on the specified volume for the current user, using the specified deployment options.

The Uri of the main package. The Uris of the dependency packages. A bitwise combination of enumeration values from the DeploymentOptions enumeration that specify deployment options. The volume on which the app stores data for the current user. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Registers a package (the main package) by its family name and its dependency packages for the current user.

A string that specifies the family name of the main package to be registered. Strings that specify the family names of the dependency packages to be registered. A DeploymentOptions -typed value that specifies the package deployment option. The package volume to store that app data on. Strings that specify the optional package family names from the main bundle to be registered. A report of the deployment progress. The object implements the **IAsyncOperationWithProgress** pattern.

Registers a package (the main package) by its full name and its dependency packages for the current user.

A string that specifies the full name of the main package to be registered. Strings that specify the full names of the dependency packages to be registered. A DeploymentOptions -typed value that specifies the package deployment option. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Registers a package (the main package) and its dependency packages for the current user, using the specified deployment options.

The URI of the manifest for the main package. The package registration options for the operation. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Registers the specified packages by their full name for the current user.

The list of full names for the packages you want to register. The package registration options for the operation. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them.

A string representation of the package identity to identify the package to be removed. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Removes a package for the current user asynchronously and receives progress and status messages on the removal operation. Dependency packages are also removed for the user if no other packages installed for the user depend on them.

A string representation of the package identity to identify the package to be removed. A RemovalOptions -typed value that modifies the removal operation. A pointer that receives the address of an object that implements the IAsyncOperationWithProgress interface.

Removes the specified volume.

The volume to remove. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Requests a SmartScreen check and user verification before installing the app package(s).

The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The URIs of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. A valid enumeration value from the DeploymentOptions enumeration. The volume that the package is installed to. Strings that specify the optional package family names from the main bundle to be staged and registered. The URIs of additional packages in the main bundle that should be staged and registered. The progress and the result of the app package deployment.

Requests a SmartScreen check and user verification before installing the app package(s). This method provides a **packageUrisToInstall** overload to specify external packages to be staged and registered.

The URI of the package to add. The URI must follow the file URI scheme (file://) since the only supported URI schemes are local file paths and local network paths. The URIs of the dependency packages to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. A valid enumeration value from the DeploymentOptions enumeration. The volume that the package is installed to. Strings that specify the optional package family names from the main bundle to be staged and registered. The URIs of additional packages in the main bundle that should be staged and registered. A list of other package URIs to be staged and registered. This can contain paths to external packages to be installed. The progress and result of adding the app package.

Allows single or multiple app packages to be installed with an .appinstaller file. This will perform a SmartScreen filter and user verification before installing the app package(s).

A Uri to the .appinstaller file. The options as specified in AddPackageByAppInstallerOptions. The volume that the package is installed to.

Sets the default package volume, which is the target of deployment operations such as the AddPackageAsync method.

The default package volume, which is the target of deployment operations such as the AddPackageAsync method.

Sets the state of a package, for example, to usable, tampered with, and so on.

The full name of the package. One of the enumeration values.

Sets the status of the specified package.

The full name of the package. One of the enumeration values that describes the status of the package.

Sets a value that indicates whether the specified app package currently prefers to run as a full app or a stub app.

The family name of the app package to configure. A value that indicates whether the specified app package currently prefers to run as a full app or a stub app.

Sets the specified volume to an offline state. The caller must be a member of the administrators group.

The volume to take offline. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Sets the specified volume to an online state. The caller must be a member of the administrators group.

The volume to bring online. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Stages a package to the system without registering it.

The source URI of the main package. The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Stages a package to the system without registering it.

The source URI of the main package. The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. A combination of DeploymentOptions -typed values that are combined by using a bitwise OR operation. The resulting value specifies the package deployment options. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Stages a package to the system without registering it.

The source URI of the main package. The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. A bitwise combination of enumeration values from the DeploymentOptions enumeration. The resulting value specifies the package deployment options. The target volume on which to stage the package. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Stages a package to the system without registering it.

The source URI of the main package. The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null. A bitwise combination of enumeration values from the DeploymentOptions enumeration. The resulting value specifies the package deployment options. The target volume on which to stage the package. Strings that specify the optional package family names from the main bundle to be staged. The source URIs of other packages in the main bundle to be staged. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Stages a package to the system without registering it.

The source URI of the main package. The URIs of framework dependencies to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null. The deployment options for the package. The volume to which the package is added. The package family names from the main bundle to be staged. The URIs of additional packages in the main bundle that should be staged. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Stages a package to the system without registering it, using the specified deployment options.

The source URI of the main package. The package deployment options for the operation. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user.

The full name of the package. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Stages a package's roaming data to the system without registering the package. Call this method after staging the package but before registering the package for a particular user.

The full name of the package. A bitwise combination of enumeration values from the DeploymentOptions enumeration that specify deployment options. An object that the caller can observe to track progress and completion for the call. The object implements the **IAsyncOperationWithProgress** pattern.

Updates an installed package or its dependency packages for the current user.

The source URI of the main package. The source URIs of the dependency packages. One of the permitted enumeration values. **ForceApplicationShutdown** and **None** are the only valid options for this method and specifying any other deployment option results in an E_INVALIDARG return value. The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.

Settings for debugging app packages.

Sets the staging state of a content group for debugging.

The app package. The content group name. An AppxContentGroupMap.xml must be present when the app is registered for this API to work. The PackageContentGroupState enum value. Returns an IAsyncAction that completes when the state has changed.

Sets the staging state of a content group for debugging.

The app package. The content group name. An AppxContentGroupMap.xml must be present when the app is registered for this API to work. The PackageContentGroupState enum value. The simulated percent install completion. A value between 0 and 100.0. A value greater than 100 is clamped to 100. Returns an IAsyncAction that completes when the state has changed.

Represents the state of the package.

The license of the package is not valid.

The package payload was modified by an unknown source.

The package is usable.

The package payload was tampered with intentionally.

Provides info about the status of a package.

The package is not available for use. It can still be serviced.

The license of the package is not valid.

The package payload was modified by an unknown source.

The package is usable.

The package payload was tampered with intentionally.

Represents whether an app package currently prefers to run as a full app or a stub app.

The app package currently prefers to run as a full app.

The app package currently prefers to run as a stub app.

Defines the types of packages to be included in the result set of a query.

Include all packages when you enumerate the package repository.

Include the bundle packages when you enumerate the package repository.

Include the framework packages when you enumerate the package repository.

Include the main packages when you enumerate the package repository.

Default inventorying behavior.

Include the optional packages when you enumerate the package repository.

Include the resource packages when you enumerate the package repository.

Include the XAP packages when you enumerate the package repository.

Provides information about the users of an installed package.

Gets the install state of the package for the user.

One of the enumeration values.

Gets the security identifier (SID) of the package user.

The SID.

Represents a package storage volume.

Gets a boolean that indicates if APPX installing is supported.

The boolean that indicates that APPX installing is supported.

Gets a boolean that indicates if full-trust packages are supported.

A boolean that indicates if full-trust packages are supported.

Describes whether a volume is in an offline state.

true if the volume is in an offline state; otherwise, false.

Describes whether a volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable.

true if the volume is an internal system volume mapped to the %SYSTEMDRIVER% environment variable; otherwise, false.

Gets the path of the last known volume mount point.

The path of the last known volume mount point.

Gets the media ID of the volume.

The media ID of the volume.

Gets the absolute path for the package store on the volume.

The absolute path for the package store on the volume.

Gets a value that specifies whether the volume supports the creation of hard links in its file system.

true if the volume supports the creation of hard links in its file system; otherwise, false.

Gets a collection of info about all installed instances of the specified package for all registered users.

The full name of the package. A collection of info about all installed instances of the specified package for all registered users.

Gets a collection of info about the installed instances of the specified package for the specified user or users.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. The full name of the package. A collection of info about all installed instances of the specified package for the specified user or users.

Gets a collection of info about all installed instances of all packages for all registered users.

A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package for all registered users.

The package family name of the package. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package from the specified publisher for all registered users.

The full name of the package. The publisher of the package. A collection of info about the specified packages.

Gets a collection of info about all installed instances of all packages for the specified user or users.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package for the specified user or users.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. The package family name. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package from the specified publisher for the specified user or users.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. The full name of the package. The publisher of the package. A collection of info about the specified packages.

Gets a collection of info about all installed instances of all packages for the specified user or users and with the specified package types.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. A bitwise combination of the enumeration values that specifies the types of packages to return. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. A bitwise combination of the enumeration values that specifies the types of packages to return. The package family name. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package for the specified user or users and with the specified package types.

The security identifier (SID) of the user or users. An empty string denotes the current user. The Everyone SID (S-1-1-0) denotes all users. Any SID other than that of the current user requires administrative privileges. A bitwise combination of the enumeration values that specifies the types of packages to return. The full name of the package. The publisher of the package. A collection of info about the specified packages.

Gets a collection of info about all installed instances of all packages with the specified package types for all registered users.

A bitwise combination of the enumeration values that specifies the types of packages to return. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package with the specified package types for all registered users.

A bitwise combination of the enumeration values that specifies the types of packages to return. The package family name. A collection of info about the specified packages.

Gets a collection of info about all installed instances of the specified package from the specified publisher with the specified package types for all registered users.

A bitwise combination of the enumeration values that specifies the types of packages to return. The full name of the package. The publisher of the package. A collection of info about the specified packages.

Gets the available space.

Returns an asynchronous operation that will complete with the available space.

Specifies the deployment options that you can configure when you use the RegisterPackageByUriAsync method to register a package.

Creates a new instance of the RegisterPackageOptions class.

Gets or sets a value that indicates whether to allow an unsigned package to be registered.

**TRUE** indicates that an unsigned package can be registered; otherwise, **FALSE**.

Gets or sets the target volume on which to store app data.

The target volume on which to store app data.

Gets or sets a value that indicates whether to delay registration of the main package or dependency packages if the packages are currently in use.

**TRUE** indicates that registration of the main package or dependency packages will be delayed until the next time the application is activated if the packages are currently in use; otherwise, **FALSE**.

Gets the list of URIs of the dependency packages to add.

The list of URIs of the dependency packages to add.

Gets or sets a value that indicates whether the app is installed in developer mode.

**TRUE** to install the app in developer mode; otherwise, **FALSE**.

Gets or sets the URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

The URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package, or any package that depends on the package, is currently in use.

**TRUE** indicates that the processes associated with the package will be shut down forcibly so that registration can continue; otherwise, **FALSE**.

Gets or sets a value that indicates whether the processes associated with the package will be shut down forcibly so that registration can continue if the package is currently in use.

**TRUE** indicates that the processes associated with the package will be shut down forcibly so that registration can continue; otherwise, **FALSE**.

Gets or sets a value that indicates whether to force a specific version of a package to be staged/registered, regardless of if a higher version is already staged/registered.

**TRUE** forces a specific version of a package to be staged/registered, regardless of if a higher version is already staged/registered; otherwise, **FALSE**.

Gets or sets a value that indicates whether the app skips resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered.

**TRUE** instructs the app to skip all resource applicability checks and stages or registers all resource packages; otherwise, **FALSE**.

Gets the list of package family names from the main bundle to be registered.

The list of package family names from the main bundle to be registered.

Gets or sets a value that indicates whether to stage the package in place.

**TRUE** indicates that the package will be staged in place; otherwise, **FALSE**.

Values that modify the removal of a package.

No removal options are specified. This is the default deployment behavior.

Don't remove any application data when the package is removed. This can only apply to packages that were deployed with the DeploymentOptions.DevelopmentMode value. If you specify **PreserveApplicationData** on an incompatible package, PackageManager.RemovePackageAsync(String, RemovalOptions) returns **E_INVALIDARG**.

Don't remove the roamable portion of the app's data when the package is removed. This value is not supported with the **PreserveApplicationData** and **RemoveForAllUsers** fields. This field is useful in virtual desktop scenarios when additional work needs to be performed to enable the portable part of the app's state to be roamed between remote servers so that a user's virtual desktop session can be logged onto different servers without loss of app state.

Removes a package for all users on the device.

Specifies the deployment options that you can configure when you use the StagePackageByUriAsync method to stage a package.

Creates a new instance of the StagePackageOptions class.

Gets or sets a value that indicates whether to allow an unsigned package to be added.

**TRUE** indicates that an unsigned package can be added; otherwise, **FALSE**.

Gets the list of URIs of the dependency packages to stage.

The list of URIs of the dependency packages to stage.

Gets or sets a value that indicates whether the app is installed in developer mode.

**TRUE** to install the app in developer mode; otherwise, **FALSE**.

Gets or sets the URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

The URI of an external disk location outside of the MSIX package where the package manifest can reference application content.

Gets or sets a value that indicates whether to force a specific version of a package to be staged/registered, regardless of if a higher version is already staged/registered.

**TRUE** forces a specific version of a package to be staged/registered, regardless of if a higher version is already staged/registered; otherwise, **FALSE**.

Gets or sets a value that indicates whether the app skips resource applicability checks. This effectively stages or registers all resource packages that a user passes in to the command, which forces applicability for all packages contained in a bundle. If a user passes in a bundle, all contained resource packages will be registered.

**TRUE** instructs the app to skip all resource applicability checks and stages or registers all resource packages; otherwise, **FALSE**.

Gets the list of package family names from the main bundle to be registered.

The list of package family names from the main bundle to be registered.

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

The list of URIs of related optional packages to be updated to the same version as the new optional packages.

Gets the list of URIs of related optional packages to be updated to the same version as the new optional packages.

The list of URIs of related optional packages to be updated to the same version as the new optional packages.

Gets or sets a value that indicates whether only the required content group will be staged. An app can be installed as a package with the required content group alone.

**TRUE** indicates that only the required content group will be staged; otherwise, **FALSE**.

Gets or sets a value that indicates whether to stage the package in place.

**TRUE** indicates that the package will be staged in place; otherwise, **FALSE**.

Gets or sets the stub options for the package.

The stub options for the package.

Gets or sets the volume to which the package is staged.

The volume to which the package is staged.

Defines the stub behavior for an app package that is being added or staged.

Use the default behavior.

Install as a full app.

Install as stub app.

Use the current PackageSubPreference for the package.

Provides functionality to get Mobile Device Management (MDM) policy information.

Gets the valid MDM policy information given a specified policy name and area name.

A string representing the area name for a policy. A string representing the name of the policy. The NamedPolicyData for the policy specified by the area and name parameters.

Gets a valid MDM user policy given the specified MDM policy name and area name. This is more user friendly than GetPolicyFromPath.

The user data for user policies. A string representing the area name for a policy. A string representing the name of the policy. The NamedPolicyData for the policy specified by the user, area, and name parameters.

Policy data information for mobile device management.

Gets the MDM policy area name.

The MDM policy area name.

Determines whether an MDM policy is actively managed or not.

True if the policy is managed; False if the policy is not managed.

Determines whether an MDM policy is a user policy or not.

True if the policy is a user policy; False if the policy is not a user policy.

Gets the type of the MDM policy value.

The type of the named MDM policy from the NamedPolicyKind enumeration.

Gets the MDM policy name value.

The MDM policy name value.

Gets the user's data for the MDM user policy.

Windows.System.User associated with the user policy.

Occurs when the MDM policy is changed.

Gets the binary representation of the MDM policy value.

IBuffer containing the binary value of the MDM policy.

Gets the boolean representation of the MDM policy value.

The boolean value of the MDM policy.

Gets the 32 bit integer representation of the MDM policy value.

The 32 bit integer value of the MDM policy.

Gets the 64 bit integer representation of the MDM policy value.

The 64 bit integer value of the MDM policy.

Gets the string representation of the MDM policy value.

The string value of the MDM policy.

Possible data types representing the MDM policy value.

The policy is represented by a binary.

The policy is represented by a boolean.

The policy is represented by a 32 bit integer.

The policy is represented by a 64 bit integer.

The policy is invalid.

The policy is represented by a string.

Manages the state of preview builds for the device.

A boolean value describing whether preview builds are allowed on the device.

True if preview builds are allowed; False if preview builds are not allowed.

The current state of the PreviewBuildsState object.

The current `PreviewBuildsState` object.

Gets the default PreviewBuildsManager from the device.

The default PreviewBuildsManager. This will return `null` if the API is not supported on the platform.

Determines if this API is supported on the device.

True if the API is supported; False otherwise.

Syncs the PreviewBuildsManager with the server to get current information.

True if the PreviewBuildsManager object successfully synced; False otherwise.

Contains information used to connect a device to associate the device with the Windows Insider Program.

Contains properties associated with a PreviewBuildsState for registering a device with the WindowsInsiderProgram.

A ValueSet of properties.

MDM (Mobile Device Management) policy.

Gets the current messaging sync policy.

The messaging sync policy.

Returns **true** if a browser is allowed.

**true** if a browser is allowed.

Returns **true** if a camera is allowed.

**true** if a camera is allowed.

Returns **true** if a Microsoft Account is allowed.

**true** if a Microsoft Account is allowed.

Returns **true** if a Store is allowed.

**true** if a Store is allowed.

An enumeration that indicates the messaging sync policy.

Message syncing is allowed.

Message syncing is disallowed.

Message syncing is required.

Represents a buffer containing audio data.

Gets the maximum number of bytes that the buffer can hold.

The maximum number of bytes that the buffer can hold.

Gets or sets the number of bytes currently in use in the buffer.

The number of bytes currently in use in the buffer.

Disposes of the object and associated resources.

Returns an IMemoryBufferReference representation of the audio buffer.

The IMemoryBufferReference representation of the audio buffer.

Defines the access mode of an AudioBuffer returned by AudioFrame.LockBuffer.

The audio buffer is read-only.

The audio buffer can be written to and read from.

The audio buffer is write-only.

Represents a single frame of audio data.

Initializes a new instance of the AudioFrame class.

The maximum number of bytes that the buffer can hold.

Gets or sets the duration of the audio frame.

The duration of the audio frame.

Gets the extended property set which enables getting and setting properties on the AudioFrame.

The extended properties map.

Gets or sets a value that indicates whether an audio frame is the first frame after a gap in the stream.

True if the audio frame is the first frame after a gap in the stream; otherwise, false.

Gets a value indicating whether the audio frame is read-only.

True if the audio frame is read-only; otherwise, false.

Gets or sets the relative time of the frame within the audio stream.

The relative time of the frame within the audio stream.

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system.

Gets a string indicating the type of audio data the audio frame contains.

A string indicating the type of audio data the audio frame contains.

Disposes of the object and associated resources.

Gets a AudioBuffer object that allows you to operate directly on the frame's audio data.

A value indicating the access mode of the returned audio buffer. The buffer containing audio sample data.

Defines the audio processing modes.

Normal audio signal processing.

Minimal audio signal processing.

Provides data for the AutoRepeatModeChangeRequested event.

Gets a value indicating the requested auto-repeat mode.

The requested auto-repeat mode.

Provides properties for image information that is displayed by SystemMediaTransportControlsDisplayUpdater class.

Gets or sets the subtitle of the image.

The subtitle of the image.

Gets or sets the title of the image.

The title of the image.

Encapsulates the method needed to set the configuration properties on a registered media parser or codec.

Sets the configuration properties that were supplied when the media parser or codec was registered.

The configuration properties for the media parser or codec.

Represents a single frame of media data.

Gets or sets the duration of the media frame.

The duration of the media frame.

Gets the extended property set which enables getting and setting properties on the media frame.

The extended properties map.

Gets or sets a value that indicates whether an media frame is the first frame after a gap in the stream.

True if the media frame is the first frame after a gap in the stream; otherwise, false.

Gets a value indicating whether the audio frame is read-only.

True if the audio frame is read-only; otherwise, false.

Gets or sets the relative time of the frame within the media stream.

The relative time of the frame within the media stream.

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system.

Gets a string indicating the type of data the media frame contains.

A string indicating the type of data the media frame contains.

Represents a marker at specific location in a media stream time-line.

Gets the type of the media marker.

The marker type.

Gets the text associated with the marker.

The text associated with the marker.

Gets the offset in the media time-line that the marker occurs.

The offset in the media time-line that the marker occurs.

Represents a collection of media markers.

Gets the collection of media markers.

The collection of media markers.

Registers a media parser or codec.

Creates a new MediaExtensionManager object that is used to register a media parser or codec.

Registers an audio decoder for the specified input and output media types.

The class identifier of the activatable runtime class of the audio decoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the audio decoder accepts as input. The guid identifier of the media type that is output by the audio decoder.

Registers an audio decoder for the specified input and output media types with an optional configuration parameter.

The class identifier of the activatable runtime class of the audio decoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the audio decoder accepts as input. The guid identifier of the media type that is output by the audio decoder. An optional parameter that contains the configuration properties to be passed to the audio decoder.

Registers an audio encoder for the specified input and output media types.

The class identifier of the activatable runtime class of the audio encoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the audio encoder accepts as input. The guid identifier of the media type that is output by the audio encoder.

Registers an audio encoder for the specified input and output media types with an optional configuration parameter.

The class identifier of the activatable runtime class of the audio encoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the audio encoder accepts as input. The guid identifier of the media type that is output by the audio encoder. An optional parameter that contains the configuration properties to be passed to the audio encoder.

Registers a byte-stream handler by file name extension and MIME type.

The class identifier of the activatable runtime class of the byte-stream handler. The runtime class must implement the IMediaExtension interface. The file name extension that is registered for this byte-stream handler. The MIME type that is registered for this byte-stream handler.

Registers a byte-stream handler by file name extension and MIME type, with an optional configuration parameter.

The class identifier of the activatable runtime class of the byte-stream handler. The runtime class must implement the IMediaExtension interface. The file name extension that is registered for this byte-stream handler. The MIME type that is registered for this byte-stream handler. An optional parameter that contains configuration properties for the byte-stream handler.

Registers a media extension that provides a background task that decodes media.

An object that implements IMediaExtension. An AppServiceConnection object that represents an endpoint connection for an app service.

Registers a scheme handler for the specified URL scheme.

The class identifier of the activatable runtime class of the scheme handler. The runtime class must implement the IMediaExtension interface. The URL scheme that will be recognized to invoke the scheme handler. For example, "myscheme://".

Registers a scheme handler for the specified URL scheme with an optional configuration parameter.

The class identifier of the activatable runtime class of the scheme handler. The runtime class must implement the IMediaExtension interface. The URL scheme that will be recognized to invoke the scheme handler. For example, "myscheme://". An optional parameter that contains configuration properties for the scheme handler.

Registers an video decoder for the specified input and output media types.

The class identifier of the activatable runtime class of the video decoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the video decoder accepts as input. The guid identifier of the media type that is output by the video decoder.

Registers a video decoder for the specified input and output media types with an optional configuration parameter.

The class identifier of the activatable runtime class of the video decoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the video decoder accepts as input. The guid identifier of the media type that is output by the video decoder. An optional parameter that contains the configuration properties to be passed to the video decoder.

Registers a video encoder for the specified input and output media types.

The class identifier of the activatable runtime class of the video encoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the video encoder accepts as input. The guid identifier of the media type that is output by the video encoder.

Registers a video encoder for the specified input and output media types with an optional configuration parameter.

The class identifier of the activatable runtime class of the video encoder. The runtime class must implement the IMediaExtension interface. The guid identifier of the media type that the video encoder accepts as input. The guid identifier of the media type that is output by the video encoder. An optional parameter that contains the configuration properties to be passed to the video encoder.

Provides a static list of media marker types.

Gets the value of the Bookmark type which is returned as the string "Bookmark"

The bookmark type which is return as the string "Bookmark".

Specifies the auto repeat mode for media playback.

Repeat the current list of tracks.

No repeating.

Repeat the current track.

Defines values for the status of the media playback.

The media is changing.

The media is closed.

The media is paused.

The media is playing.

The media is stopped.

Defines values for the types of media playback.

The media type is an image.

The media type is audio music.

The media type is unknown.

The media type is video.

Provides a media processing background task access to the set of arguments supplied in the call to MediaProcessingTrigger.RequestAsync.

Gets a value set containing the arguments supplied in the call to MediaProcessingTrigger.RequestAsync.

A value set containing the arguments supplied in the call to MediaProcessingTrigger.RequestAsync.

Provides information about and control over the rate, position, and state of a MediaPlayer. This class makes it possible to control and synchronize multiple media players from a single controller and makes it easier to create custom transport controls.

Initializes a new instance of the MediaTimelineController class.

Gets or sets the speed at which the position of the MediaTimelineController changes, expressed as a ratio to normal playback speed. For example, setting a value of 1.0 will result in normal playback speed, a value of 4.0 will result in a playback speed 4 times the normal speed.

The speed at which the position of the MediaTimelineController changes.

Gets a value indicating the duration of the timeline. After the specified time span has elapsed, the timeline clock will no longer progress.

A value indicating the duration of the timeline.

Gets a value indicating whether the timeline will loop, restarting the clock at zero, when it reaches the end of the time window specified by the Duration.

True if looping is enabled; otherwise, false.

Gets or sets the current position of the MediaTimelineController.

The current position of the MediaTimelineController.

Gets a value indicating the current state of the MediaTimelineController, which can be either running or paused.

A value indicating the current state of the MediaTimelineController

Occurs when the timeline controller reaches the end of the time window specified by the Duration if IsLoopingEnabled is set to false.

Occurs when the timeline controller encounters an internal error and can't continue playback.

Occurs when the position of the MediaTimelineController changes.

Occurs when the state of the MediaTimelineController changes.

Pauses playback of the MediaTimelineController.

Resumes the playback of the MediaTimelineController from the position at which the controller was paused.

Starts the playback of the MediaTimelineController from the position 0.

Provides data for the Failed event, which occurs when the timeline controller encounters an error and can't continue playback.

Gets the extended error code associated with the event.

The extended error code associated with the event.

Specifies the state of a MediaTimelineController.

The **MediaTimelineController** has encountered an error.

The **MediaTimelineController** is paused.

The **MediaTimelineController** is running.

The **MediaTimelineController** is stalled due to starvation of streaming data. Apps may choose to show a buffering indicator when the timeline controller is stalled.

Represents a time range within media content.

A time span from the beginning of the media content to the end of the time range.

A time span from the beginning of the media content to the beginning of the time range.

Provides properties for music information that is displayed by the SystemMediaTransportControlsDisplayUpdater class.

Gets or sets the name of the album artist.

The name of the album artist.

Gets or sets the album title.

The album title.

Gets or sets the album track count.

The album track count.

Gets or set the name of the song artist.

The name of the song artist.

Gets a modifiable list of strings representing genre names.

A modifiable list of strings representing genre names.

Gets or set the title of the song.

The title of the song.

Gets or sets the track number.

The track number.

Provides data for the PlaybackPositionChangeRequested event.

Gets a value indicating the requested offset into the media item.

A value indicating the requested offset into the media item.

Provides data for the PlaybackRateChangeRequested event.

Gets the requested playback rate.

The requested playback rate.

Provides data for the ShuffleEnabledChangeRequested event.

Gets a value indicating whether the request is to enable or disable shuffle.

True if the request is for shuffle to be enabled; otherwise, false.

Specifies the sound level of the capture or render stream.

The sound level is at full volume.

The sound level is low.

The sound level is muted.

Represents an object that enables integrate with the system media transport controls and support for media commands.

Gets or sets a value representing the current auto-repeat mode of the SystemMediaTransportControls.

A value representing the current auto-repeat mode.

Gets the display updater for the SystemMediaTransportControls which enable updating the information displayed about the currently playing song.

The display updater for the SystemMediaTransportControls.

Gets or sets a value that specifies if the channel down button is supported.

**true** if the channel down button is supported; otherwise, **false**.

Gets or sets a value that specifies if the channel up button is supported.

**true** if the channel up button is supported; otherwise, **false**.

Enables and disables the system media transport controls for the app.

**true** if the system transport controls are enabled for the app; otherwise, **false**.

Gets or sets a value that specifies if the fast forward button is supported.

**true** if the fast forward button is supported; otherwise, **false**.

Gets or sets a value that specifies if the next button is supported.

**true** if the next button is supported; otherwise, **false**.

Gets or sets a value that specifies if the pause button is supported.**true** if the pause button is supported; otherwise, **false**.

**true** if the pause button is supported; otherwise, **false**.

Gets or sets a value that specifies if the play button is supported.

**true** if the play is supported; otherwise, **false**.

Gets or sets a value that specifies if the previous button is supported.

**true** if the previous button is supported; otherwise, **false**.

Gets or sets a value that specifies if the record button is supported.**true** if the record button is supported; otherwise, **false**.

**true** if the record button is supported; otherwise, **false**.

Gets or sets a value that specifies if the rewind button is supported.

**true** if the rewind button is supported; otherwise, **false**.

Gets or sets a value that specifies if the stop button is supported.

**true** if the stop button is supported; otherwise, **false**.

Gets or sets the playback rate of the SystemMediaTransportControls.

The playback rate of the SystemMediaTransportControls.

Gets or sets the playback status of the media.

The playback status.

Gets or sets a value representing the current shuffle state of the SystemMediaTransportControls.

True if the SystemMediaTransportControls have shuffle enabled; otherwise, false.

Gets the sound level of the media for the capture and render streams.

The sound level.

Occurs when the user modifies the SystemMediaTransportControls auto-repeat mode.

Occurs when a button is pressed on the SystemMediaTransportControls.

Occurs when the user modifies the playback position of the SystemMediaTransportControls.

Occurs when the user modifies the SystemMediaTransportControls playback rate.

Occurs when a property on the SystemMediaTransportControls has changed.

Occurs when the user modifies the SystemMediaTransportControls shuffle state.

The system media transport controls for the current view.

The system media transport controls for the current view.

Updates the SystemMediaTransportControls timeline properties with the values in the provided object.

The object representing the new timeline property values.

Defines values for the buttons on the SystemMediaTransportControls.

The channel down button.

The channel up button.

The fast forward button.

The next button.

The pause button.

The play button.

The previous button.

The record button.

The rewind button.

The stop button.

Provides data for the SystemMediaTransportControls.ButtonPressed event.

Gets the button on the SystemMediaTransportControls that was pressed.

The button that was pressed.

Provides functionality to update the music information that is displayed on the SystemMediaTransportControls.

Gets or sets the media id of the app.

The media id.

Gets the image properties associated with the currently playing media.

The image properties.

Gets the music properties associated with the currently playing media.

The music properties.

Gets or sets thumbnail image associated with the currently playing media.

The thumbnail image.

Gets or sets the type of media.

The type of media.

Gets the video properties associated with the currently playing media.

The video properties.

Clears out all of the media metadata.

Initialize the media properties using the specified file.

The type of media. The file to initialize the media properties. When this method completes, it returns a boolean value that indicates **true** if the operation succeeded; otherwise, **false**.

Updates the metadata for the currently playing media.

Defines values for the properties on the SystemMediaTransportControls.

The sound level property.

Occurs when a property is changed on the SystemMediaTransportControls.

The property that was changed on the SystemMediaTransportControls.

The property that was changed.

Represents timeline properties of the SystemMediaTransportControls. Pass an instance of this class to the UpdateTimelineProperties method to update the properties.

Initializes a new instance of the SystemMediaTransportControlsTimelineProperties class.

Gets or sets a value representing the end time of the currently playing media item.

A value representing the end time of the currently playing media item

Gets or sets a value indicating the latest time within the currently playing media item to which the user can seek.

The latest time within the currently playing media item to which the user can seek.

Gets or sets a value indicating the earliest time within the currently playing media item to which the user can seek.

A value indicating the earliest time within the currently playing media item to which the user can seek.

Gets or sets a value representing the current playback position within the currently playing media item.

The current playback position within the currently playing media item.

Gets or sets a value representing the start time of the currently playing media item.

A value representing the start time of the currently playing media item.

Provides properties for video information that is displayed by SystemMediaTransportControlsDisplayUpdater class.

Gets a modifiable list of strings representing genre names.

A modifiable list of strings representing genre names.

Gets or sets the subtitle of the video.

The subtitle of the video.

Gets or sets the title of the video.

The title of the video.

Provides video-related effects.

Represents a video stabilization effect which can be used on a video object to reduce the shakiness in the video.

The name of the effect: "Windows.Media.VideoStabilizationEffect"

Represents a single frame of video data.

Initializes a new instance of the VideoFrame class.

The pixel format of the video frame. The width of the video frame, in pixels. The height of the video frame, in pixels.

Initializes a new instance of the VideoFrame class.

The pixel format of the video frame. The width of the video frame, in pixels. The height of the video frame, in pixels. The alpha mode of the video frame.

Gets the IDirect3DSurface object containing the pixel data of the video frame, when one is present.

The IDirect3DSurface object containing the pixel data of the video frame.

Gets or sets the duration of the video frame.

The duration of the video frame.

Gets the extended property set which enables getting and setting properties on the media frame.

The extended properties map.

Gets or sets a value that indicates whether an video frame is the first frame after a gap in the stream.

True if the video frame is the first frame after a gap in the stream; otherwise, false.

Gets a value indicating whether the video frame is read-only.

True if the video frame is read-only; otherwise, false.

Gets or sets the relative time of the frame within the video stream.

The relative time of the frame within the video stream.

Gets the SoftwareBitmap object containing the pixel data of the video frame, when one is present.

The SoftwareBitmap object containing the pixel data of the video frame.

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system.

Gets a string indicating the type of video data the video frame contains.

A string indicating the type of video data the video frame contains.

Disposes of the object and associated resources.

Copies the current VideoFrame into a provided VideoFrame object.

The target video frame into which the current frame will be copied. An asynchronous action.

Copies the specified rectangle in the current VideoFrame into the specified rectangle of a provided VideoFrame object.

The target video frame into which the current frame will be copied. A BitmapBounds reference specifying the rectangle within the source frame that should be copied. A BitmapBounds reference specifying the rectangle within the target frame into which the source content is copied. An asynchronous action.

Creates a new instance of the VideoFrame class for which the image data is stored in an IDXGISurface allocated by the default Direct3D device.

A value from the DirectXPixelFormat enumeration, specifying the pixel format of the created **VideoFrame**. Not all pixel formats are supported. See the Remarks section for more information. The width, in pixels, of the created **VideoFrame**. The height, in pixels, of the created **VideoFrame**. A **VideoFrame**.

Creates a new instance of the VideoFrame class for which the image data is stored in an IDXGISurface allocated by the supplied Direct3D device.

A value from the DirectXPixelFormat enumeration, specifying the pixel format of the created **VideoFrame**. Not all pixel formats are supported. See the Remarks section for more information. The width, in pixels, of the created **VideoFrame**. The height, in pixels, of the created **VideoFrame**. An IDirect3DDevice that is used to allocate the backing surface of the video frame. A **VideoFrame**.

Creates a new instance of the VideoFrame class for which the image data is stored in the provided IDXGISurface.

The IDXGISurface in which the image data is stored. A **VideoFrame**.

Creates a new instance of the VideoFrame class from the provided SoftwareBitmap.

The SoftwareBitmap from which the **VideoFrame** is created. A **VideoFrame**.

Represents a node in an audio graph node that inputs audio data into the graph from an audio device such as a microphone or external audio interface.

Gets or sets a value indicating if the audio device input node consumes input.

True if the audio device input node consumes input, and false otherwise.

Gets information about the audio device.

A DeviceInformation object representing the device.

Gets the list of effect definitions for the audio device input node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioDeviceInputNode audio is emitted when spatial audio processing is used.

The spatial audio emitter associated with the AudioDeviceInputNode.

Gets the encoding properties for the audio device input node.

The encoding properties for the node.

Gets the list of outgoing connections from the audio device input node to other nodes in the audio graph.

A collection of AudioGraphConnection objects representing the supported connections.

Gets or sets the outgoing gain for the audio device input node.

The outgoing gain value.

Adds an outgoing connection to the audio device input node.

The destination node for the connection.

Adds an outgoing connection with gain to the audio device input node.

The destination node for the connection. A value indicating the gain associated with the connection. This is a scalar multiplier of the audio signal. The default value is 1.0.

Closes the audio device input node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Removes the outgoing connection from the audio device input node to the specified node.

The audio node for which the outgoing connection is removed.

Resets the audio device input node.

Starts the audio device input node.

Stops the audio device input node.

Defines status values for audio device node creation.

Access to the audio device was denied.

The audio device is not available.

The format for audio device node creation is not supported.

Audio device node creation succeeded.

An unknown failure occurred in creation of the audio device node.

Represents a node in an audio graph node that outputs audio data from the graph to an audio device such as a speaker or external audio interface.

Gets or sets a value indicating if the audio device output node consumes input.

True if the audio device output node consumes input, and false otherwise.

Gets information about the audio device.

A DeviceInformation object representing the device.

Gets the list of effect definitions for the audio device output node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the encoding properties for the audio device output node.

The encoding properties for the node.

Gets or sets the AudioNodeListener that describes the position and other characteristics of the listener from which the AudioDeviceOutputNode audio is heard when spatial audio processing is used.

The spatial audio listener associated with the AudioDeviceInputNode.

Gets or sets the outgoing gain for the audio device output node.

The outgoing gain value.

Closes the audio device output node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Resets the audio device output node.

Starts the audio device output node.

Stops the audio device output node.

Represents a node in an audio graph node that inputs audio data into the graph from an audio file.

Gets or sets a value indicating if the audio file input node consumes input.

True if the audio file input node consumes input, and false otherwise.

Gets the duration for the audio input file.

A value indicating the duration for the audio input file.

Gets the list of effect definitions for the audio file input node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioFileInputNode audio is emitted when spatial audio processing is used.

The spatial audio emitter associated with the AudioFileInputNode.

Gets the encoding properties for the audio file input node.

The encoding properties for the node.

Gets or sets the end time for the audio file input node, which determines when playback of the media content ends.

A value indicating the end time.

Gets or sets the loop count of the audio file input node.

A reference to an integer representing the loop count.

Gets the list of outgoing connections from the audio file input node to other nodes in the audio graph.

A collection of AudioGraphConnection objects representing the supported connections.

Gets or sets the outgoing gain for the audio file input node.

The outgoing gain value.

Gets or sets the playback speed factor for the audio file input node.

A value indicating the playback speed factor.

Gets the playback position of the audio file input node.

The current playback position within the audio file, in seconds.

Gets the source audio file for the audio file input node.

A StorageFile object representing the source audio file.

Gets or sets the start time for the audio file input node.

A value indicating the start time.

Occurs when the playback position reaches the end of the audio file or the position specified with the EndTime property.

Adds an outgoing connection to the audio file input node.

The destination node for the connection.

Adds an outgoing connection with gain to the audio file input node.

The destination node for the connection. A value indicating the gain associated with the connection. This is a scalar multiplier of the audio signal. The default value is 1.0.

Closes the audio file input node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Removes the outgoing connection from the audio file input node to the specified node.

The audio node for which the outgoing connection is removed.

Resets the audio file input node.

Moves the playback position of the node to the specified time within the audio input file.

A value indicating the position to which the node should seek.

Starts the audio file input node.

Stops the audio file input node.

Defines status values for audio file node creation.

The audio file used to create the node was not found.

The format of the audio file is not supported.

The audio file for node creation has an invalid file type.

Creation of the audio file node succeeded.

An unknown failure occurred during creation of the audio file node.

Represents a node in an audio graph node that outputs audio data from the graph to an audio file.

Gets or sets a value indicating if the audio file output node consumes input.

True if the audio file output node consumes input, and false otherwise.

Gets the list of effect definitions for the audio file output node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the encoding properties for the audio file output node.

The encoding properties for the node.

Gets the file associated with the audio file output node.

A StorageFile object representing the file.

Gets the file encoding profile supported by the audio file output node.

A MediaEncodingProfile object representing the encoding profile.

Gets or sets the outgoing gain for the audio file output node.

The outgoing gain value.

Closes the audio file output node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Finalizes the asynchronous operation of the audio file output node.

When this operation completes, a TranscodeFailureReason value is returned.

Resets the audio file output node.

Starts the audio file output node.

Stops the audio file output node.

Represents arguments for an AudioFrameCompleted event.

Gets the audio frame that was just completed by the AudioFrameInputNode. A frame is completed when all of the audio in the frame has been consumed by the audio graph.

An AudioFrame object representing the audio frame.

Represents a node in an audio graph node that inputs audio data into the graph from app-implemented code that generates audio samples programmatically.

Gets or sets a value indicating if the audio frame input node consumes input.

True if the audio frame input node consumes input, and false otherwise.

Gets the list of effect definitions for the audio frame input node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioFrameInputNode audio is emitted when spatial audio processing is used.

The spatial audio emitter associated with the AudioFrameInputNode.

Gets the encoding properties for the audio frame input node.

The encoding properties for the node.

Gets the list of outgoing connections from the audio frame input node to other nodes in the audio graph.

A collection of AudioGraphConnection objects representing the supported connections.

Gets or sets the outgoing gain for the audio frame input node.

The outgoing gain value.

Gets or sets the playback speed factor for the audio frame input node.

A value indicating the playback speed factor.

Gets the queued sample count for the audio frame input node.

A value indicating the queued sample count.

Notifies of a completed audio frame that has been submitted to the graph with a call to AddFrame.

Raised when the audio graph is ready to begin processing a new quantum of data.

Adds an audio frame to the audio frame input node.

An AudioFrame object representing the frame.

Adds an outgoing connection to the audio frame input node.

The destination node for the connection.

Adds an outgoing connection with gain to the audio frame input node.

The destination node for the connection. A value indicating the gain associated with the connection. This is a scalar multiplier of the audio signal. The default value is 1.0.

Closes the audio frame input node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Removes queued frames from the audio frame input node.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Removes the outgoing connection from the audio frame input node to the specified node.

The audio node for which the outgoing connection is removed.

Resets the audio frame input node.

Starts the audio frame input node.

Stops the audio frame input node.

Represents a node in an audio graph node that outputs audio data from the graph into app-implemented code.

Gets or sets a value indicating if the audio frame output node consumes input.

True if the audio frame output node consumes input, and false otherwise.

Gets the list of effect definitions for the audio frame output node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the encoding properties for the audio frame output node.

The encoding properties for the node.

Gets or sets the outgoing gain for the audio frame output node.

The outgoing gain value.

Closes the audio frame output node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Gets an audio frame containing all of the data accumulated by this node since the previous call to **GetFrame**. If **GetFrame** has not yet been called, the audio frame will contain all of the data accumulated since the node was created.

An AudioFrame object representing the frame.

Resets the audio frame output node.

Starts the audio frame output node.

Stops the audio frame output node.

Represents an audio graph of connected input, output, and submix nodes that manipulate and route audio.

Gets the completed quantum count for the audio graph.

A value indicating the completed quantum count.

Gets the encoding properties for the audio graph.

The encoding properties for the audio graph.

Gets the latency in samples that the audio graph supports.

A value indicating the sample latency.

Gets the primary render device for the audio graph.

The primary render device for the audio graph.

Gets a value that indicates the audio processing mode for the audio graph.

A value that indicates the audio processing mode for the audio graph.

Gets the number of samples per quantum at which the audio graph is currently operating.

A value indicating the number of samples per quantum.

Notifies that the audio graph has processed the specified quantum.

Notifies that the audio graph has started processing a new quantum.

Notifies of an unrecoverable audio error in audio graph operation.

Closes the audio graph and disposes of associated resources.

Creates an audio graph with specific settings.

An AudioGraphSettings object representing the source audio file. When this operation completes, a CreateAudioGraphResult object is returned.

Creates a new AudioGraphBatchUpdater for the AudioGraph which causes all subsequent modifications to all nodes in the audio graph to be accumulated and then committed once your app closes or disposes of the batch updater object.

A new batch updater for the audio graph.

Creates an AudioDeviceInputNode that inputs audio data into the audio graph from the default audio input device, such as a microphone or audio card.

A value from the MediaCategory enumeration value indicating the category of the media processed by this node, allowing the system to perform content-appropriate processing and prioritization of the media. An asynchronous operation that returns a CreateAudioDeviceInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The DeviceInputNode property provides a reference to the created input node on success.

Creates an AudioDeviceInputNode that inputs audio data into the audio graph from the default audio input device such as a microphone or audio card.

A value from the MediaCategory enumeration value indicating the category of the media processed by this node, allowing the system to perform content-appropriate processing and prioritization of the media. An object representing the audio encoding properties for the device input node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An asynchronous operation that returns a CreateAudioDeviceInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The DeviceInputNode property provides a reference to the created input node on success.

Creates an AudioDeviceInputNode that inputs audio data into the audio graph from the specified audio input device such as a microphone or audio card.

A value from the MediaCategory enumeration value indicating the category of the media processed by this node, allowing the system to perform content-appropriate processing and prioritization of the media. An object representing the audio encoding properties for the device input node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. A DeviceInformation object representing the device from which the device input node will get audio data. An asynchronous operation that returns a CreateAudioDeviceInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The DeviceInputNode property provides a reference to the created input node on success.

Creates a spatial audio-enabled AudioDeviceInputNode that inputs audio data into the audio graph from the specified audio input device such as a microphone or audio card.

A value from the MediaCategory enumeration value indicating the category of the media processed by this node, allowing the system to perform content-appropriate processing and prioritization of the media. An object representing the audio encoding properties for the device input node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. A DeviceInformation object representing the device from which the device input node will get audio data. An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. An asynchronous operation that returns a CreateAudioDeviceInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The DeviceInputNode property provides a reference to the created input node on success.

Creates a new AudioDeviceOutputNode that outputs audio data from the audio graph to the system's default output device, such as speakers or headphones.

An asynchronous operation that returns a CreateAudioDeviceOutputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The DeviceOutputNode property provides a reference to the created output node on success.

Creates an AudioFileInputNode that inputs audio data into the audio graph from a storage file.

A StorageFile object representing the audio file associated with the input node. An asynchronous operation that returns a CreateAudioFileInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The FileInputNode property provides a reference to the created output node on success.

Creates a spatial audio-enabled AudioFileInputNode that inputs audio data into the audio graph from a storage file.

A IStorageFile object representing the audio file associated with the input node. An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. An asynchronous operation that returns a CreateAudioFileInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The FileInputNode property provides a reference to the created input node on success.

Creates a new AudioFileOutuputNode that outputs audio data from the audio graph to the specified storage file.

A StorageFile to which audio data is written. An asynchronous operation that returns a CreateAudioFileOutputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The FileOutputNode property provides a reference to the created output node on success.

Creates a new AudioFileOutuputNode that outputs audio data from the audio graph to the specified storage file.

A StorageFile to which audio data is written. A MediaEncodingProfile that determines the format of the output file. An asynchronous operation that returns a CreateAudioFileOutputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The FileOutputNode property provides a reference to the created output node on success.

Creates an AudioFrameInputNode that inputs audio data generated by app-implemented code into the audio graph.

An audio frame input node.

Creates an AudioFrameInputNode, with the specified encoding properties, that inputs audio data generated by app-implemented code into the audio graph.

An object representing the audio encoding properties for the frame input node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An audio frame input node.

Creates a spatial audio-enabled AudioFrameInputNode, with the specified encoding properties, that inputs audio data generated by app-implemented code into the audio graph.

An object representing the audio encoding properties for the frame input node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. An audio frame input node.

Creates a new AudioFrameOutputNode that outputs audio data from the audio graph to app-implemented code.

An audio frame output node.

Creates a new AudioFrameOutputNode, with the specified encoding properties, that outputs audio data from the audio graph to app-implemented code.

An object representing the audio encoding properties for the frame output node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An audio frame output node.

Creates a MediaSourceAudioInputNode that inputs audio data into the audio graph from the provided MediaSource object.

The MediaSource object from which audio data is input into the audio graph. An IAsyncOperation object that returns a CreateMediaSourceAudioInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The Node property provides a reference to the created input node on success.

Creates a spatial audio-enabled MediaSourceAudioInputNode that inputs audio data into the audio graph from the provided MediaSource object.

The MediaSource object from which audio data is input into the audio graph. An AudioNodeEmitter object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. An IAsyncOperation object that returns a CreateMediaSourceAudioInputNodeResult on completion. This object exposes a Status property, that indicates either that the operation was successful or the reason why the operation failed. The Node property provides a reference to the created input node on success.

Creates an AudioSubmixNode that mixes the output of one or more audio graph nodes into a single output that can be connected to output nodes or other submix nodes.

An audio submix node.

Creates an AudioSubmixNode that mixes the output of one or more audio graph nodes into a single output that can be connected to output nodes or other submix nodes.

An object representing the audio encoding properties for the submix node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An audio submix node.

Creates a spatial audio-enabled AudioSubmixNode that mixes the output of one or more audio graph nodes into a single output that can be connected to output nodes or other submix nodes.

An object representing the audio encoding properties for the submix node which specifies the sample rate at which the created node will operate. Only uncompressed PCM and float formats are allowed. An object that describes the position and other physical characteristics of the emitter from which the node's audio is emitted when spatial audio processing is used. An audio submix node.

Resets all nodes in the audio graph.

Starts the audio graph.

Stops the audio graph.

An object that, upon creation with CreateBatchUpdater, causes all subsequent modifications to all nodes in an AudioGraph to be accumulated and then committed once your app closes or disposes of the batch updater object.

Closes the CreateBatchUpdater, causing all audio graph node modifications accumulated since the object was created to be committed.

Represents a connection within an audio graph.

Gets the destination node for the connection.

The **IAudioNode** interface for the destination node.

Gets the gain associated with the audio graph connection.

A value indicating the gain.

Defines status values for audio graph creation.

The PrimaryRenderDevice for the audio graph is not available.

The audio stream format is not supported by the audio graph.

Creation of the audio graph succeeded.

An unknown failure occurred during creation of the audio graph.

Represents initialization settings for an audio graph. Set the properties of this object to your desired values and then call AudioGraph.CreateAsync to create a new audio graph instance with the specified settings.

Initializes a new instance of the AudioGraphSettings class with initial settings values optimized for the specified AudioRenderCategory.

The AudioRenderCategory that determines the initial settings values.

Gets or sets a value that indicates the audio render category setting for the audio graph.

A value that indicates the audio render category setting for an audio graph.

Gets or sets a value that indicates the desired audio processing mode setting for the audio graph.

A value that indicates the desired audio processing mode setting for the audio graph.

Gets or sets the desired number of samples per quantum defined for the audio graph.

The number of samples per quantum.

Gets or sets the audio encoding properties setting for the audio graph.

The audio encoding properties for the audio graph.

Gets or sets the maximum playback speed of input nodes in the AudioGraph.

The maximum playback speed of the associated AudioGraph, as a multiplier of the normal speed of the content. So, a value of 2 represents twice the normal speed and a value of 3 represents three times the normal speed. This value must be in the range of 1 to 1024, inclusive. The default value is 1024.

Gets or sets an object that represents the primary render device for the audio graph.

An object that represents the primary render device for the audio graph.

Gets or sets the quantum size selection mode for the audio graph.

An enumeration value indicating the quantum size selection mode. If the audio graph is only to be used with files, it is strongly recommended to use the value SystemDefault.

Defines unrecoverable errors for the audio graph.

The audio device has been lost.

The audio session has been disconnected.

No unrecoverable errors were found.

An unknown failure occurred during creation of the audio graph.

Represents arguments for an UnrecoverableErrorOccurred event.

Gets the error associated with the event.

An enumeration value indicating the error.

Describes the position and other physical characteristics of an emitter from which the audio of an AudioGraph node is emitted when spatial audio processing is used.

Initializes a new instance of the AudioNodeEmitter class.

Initializes a new instance of the AudioNodeEmitter class with the specified emitter characteristics.

An object describing the shape in which audio is emitted. An object describing the decay model for emitted audio. Flags specifying additional settings for the emitter.

Gets an object describing the decay model for the AudioNodeEmitter.

An object describing the decay model for the emitter.

A vector expressing the direction in which audio is emitted from the AudioNodeEmitter.

The direction in which audio is emitted from the emitter.

Gets or sets the scale of the position of the emitter. All distances used when calculating spatial audio effects are expressed in meters. Setting this value allows you to automatically scale the calculations to use some other unit.

The scale of the position of the emitter.

Gets or sets the scale of the doppler velocity of the emitter. The DopplerVelocity of an emitter is expressed in meters per second. Setting this value allows you to automatically scale the velocity to some other unit.

The scale of the doppler velocity of the emitter.

Gets or sets a Vector3 expressing the velocity at which the emitter is moving in 3D space, expressed in meters per second.

A Vector3 expressing the velocity at which the emitter is moving.

Gets or sets a value indicating the gain applied to the signal by the emitter.

A value indicating the gain applied to the signal by the emitter.

Gets a value indicating whether Doppler processing is disabled for the emitter.

True if Doppler processing is disabled; otherwise, false.

Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters.

A vector representing the position of the emitter in 3D space

Gets an object describing the shape in which the emitter emits audio.

An object describing the shape in which the emitter emits audio.

Gets or sets a value that specifies the spatial audio processing model used by the emitter.

A value that specifies the spatial audio processing model used by the emitter.

Describes the cone shape used by an AudioNodeEmitterShape. At the inner angle of the cone, audio is not attenuated at all. At the outer angle of the cone, audio is fully attenuated.

Gets the inner angle of an audio node emitter cone shape. This is the angle at which the audio is not attenuated at all.

The inner angle of a an audio node emitter cone shape.

Gets the outer angle of a an audio node emitter cone shape, expressed in radians. This is the angle at which the audio is fully attenuated.

The outer angle of a an audio node emitter cone shape

Gets a value indicating the gain applied at the outer angle of the cone.

A value indicating the gain applied at the outer angle of the cone.

Specifies the type of decay model used by an AudioNodeEmitter.

Decay is determined using the MinGain and MaxGain properties..

A natural roll-off model using a distance-squared formula is used.

Represents the model used to compute the distance-based attenuation of a signal from an AudioNodeEmitter.

Gets a value indicating the type of the decay model.

A value indicating the type of the decay model.

Gets the maximum gain applied to the signal as a result of the decay model.

The maximum gain applied to the signal as a result of the decay model.

Gets the minimum gain applied to the signal as a result of the decay model.

The minimum gain applied to the signal as a result of the decay model.

Gets the properties of a natural AudioNodeEmitterDecayModel.

The properties of a natural decay model.

Creates a new AudioNodeEmitterDecayModel that uses the specified minimum and maximum gain values to compute distance-based attenuation of a signal from an AudioNodeEmitter.

The minimum gain level for the signal. The maximum gain level for the signal. The created decay model.

Creates an AudioNodeEmitterDecayModel with a natural roll-off model using a distance-squared formula.

The minimum gain applied to the signal. The maximum gain applied to the signal. The distance at which the gain of the signal is unaffected by decay. The distance at which the gain is *minGain*. The created decay model.

Describes the characteristics of a natural AudioNodeEmitterDecayModel.

Gets a value indicating the distance at which the gain reaches the minimum gain value specified when the model was created with a call to AudioNodeEmitterDecayModel.CreateNatural.

A value indicating the distance at which the gain reaches the model's minimum gain value.

Gets a value indicating the distance at which the signal gain is unaffected by the decay model.

A value indicating the distance at which the signal gain is unaffected by the decay model.

Specifies settings flags for the creation of an AudioNodeEmitter.

Processing of Doppler effects based on the DopplerVelocity of the emitter is disabled.

No settings.

Describes the shape in which an AudioNodeEmitter emits audio.

Gets an object that defines the characteristics of an emitter's cone shape, including the inner and outer angle of the cone and the gain applied to the signal at the outer angle.

An object that defines the characteristics of the cone shape

Gets a value indicating the kind of shape represented by the AudioNodeEmitterShape.

A value indicating the kind of shape represented by the AudioNodeEmitterShape.

Creates an instance of AudioNodeEmitterShape representing a cone shape.

The inner angle of an audio node emitter cone shape, where the audio signal is not attenuated at all, expressed in radians. The outer angle of an audio node emitter cone shape, where the audio signal is fully attenuated, expressed in radians. A value indicating the gain applied at the outer angle of the cone. A cone-shaped AudioNodeEmitterShape.

Creates an instance of AudioNodeEmitterShape that is omnidirectional, meaning that the audio signal attenuation is the same regardless of the emitter's Direction.

An omnidirectional AudioNodeEmitterShape.

Specifies the shape of an AudioNodeEmitterShape object.

The shape is a cone.

The shape is omnidirectional.

Describes the position and other physical characteristics of a listener from which the audio output of an AudioGraph node is heard when spatial audio processing is used.

Creates a new instance of the AudioNodeListener class.

Gets or sets a Vector3 expressing the velocity at which the listener is moving in 3D space, expressed in meters per second.

The velocity at which the listener is moving.

Gets or sets a Quaternion expressing the rotation of the listener in 3D space.

The rotation of the listener in 3D space.

Gets or sets a vector representing the position of the emitter in 3D space, expressed in meters.

A vector representing the position of the emitter in 3D space.

Gets or sets the speed of sound used for computing spatial audio, expressed in meters per second.

The speed of sound used for computing spatial audio.

Represents a connection that allows a remote device to stream audio to a Windows device.

Gets the unique device ID for the underlying device represented by the AudioPlaybackConnection.

The unique device ID for the underlying device represented by the **AudioPlaybackConnection**.

Gets the current connection state of the AudioPlaybackConnection.

A member of the AudioPlaybackConnectionState enumeration, indicating the current connection state.

Occurs when the connection state of the AudioPlaybackConnection changes.

Closes the connection represented by the AudioPlaybackConnection object.

Gets an Advanced Query Syntax (AQS) string for that can be used to find devices for which an AudioPlaybackConnection can be created.

An AQS string.

Attempts to connect the underlying device. If successful, this causes any audio that is playing on the remote device to be heard on the local device.

An AudioPlaybackConnectionOpenResult object. The Status property of this object indicates the result of the connection attempt.

Asynchronously attempts to connect the underlying device. If successful, this causes any audio that is playing on the remote device to be heard on the local device.

Upon completion, returns an AudioPlaybackConnectionOpenResult object. The Status property of this object indicates the result of the connection attempt.

Configures the system to allow connections from the remote audio source.

Asynchronously configures the system to allow connections from the remote audio source.

An asynchronous operation.

Attempts to create an AudioPlaybackConnection from the specified device ID.

The identifier for the device for which the connection should be created. If successful, returns an AudioPlaybackConnection. If the specified device does not have support for audio streaming, the return value is null.

The value returned from a call to Open or OpenAsync that indicates whether the call was successful and, if not, provides an extended error code.

Gets the extended error code returned from a call to Open or OpenAsync.

The extended error code.

Gets a value that indicates whether the call to call to Open or OpenAsync was successful.

A member of the AudioPlaybackConnectionOpenResultStatus indicating whether the call was successful.

Specifies the result status of a call to Open or OpenAsync

The open operation was denied by the system.

The request timed out.

The open request was successful.

The request failed for an unknown reason. Check the ExtendedError property for more information.

Specifies the connection state of an AudioPlaybackConnection.

The connection is closed.

The connection is open.

Allows a UWP app to determine if any of the app's audio streams are currently being muted or having their volume reduced by the system.

Gets a value indicating the current sound level of the audio streams being monitored by the AudioStateMonitor.

A value indicating the current sound level of the monitored audio streams.

Occurs when the system changes the sound level of the audio streams being monitored by the AudioStateMonitor.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for all audio capture streams.

An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for audio capture streams with the specified MediaCategory.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for audio capture streams with the specified MediaCategory and AudioDeviceRole.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. A value from the AudioDeviceRole enumeration indicating the device role of audio streams that will be monitored. The system may use the device role of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for audio capture streams with the specified MediaCategory that are using the specified audio device.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. A string containing the unique identifier of a audio device for which associated audio streams will be monitored. An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for all audio render streams.

An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for audio render streams with the specified MediaCategory.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for render streams with the specified MediaCategory and AudioDeviceRole.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. A value from the AudioDeviceRole enumeration indicating the device role of audio streams that will be monitored. The system may use the device role of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. An AudioStateMonitor object.

Initializes a new instance of the AudioStateMonitor class that monitors the sound level for audio render streams with the specified MediaCategory that are using the specified audio device.

A value from the MediaCategory enumeration indicating the categories of audio streams that will be monitored. The system may use the category of an audio stream to determine if it should be muted or have its volume lowered in response to a particular system event. A string containing the unique identifier of a audio device for which associated audio streams will be monitored. An AudioStateMonitor object.

Represents an audio submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes.

Gets or sets a value indicating if the audio submix node consumes input.

True if the audio submix node consumes input, and false otherwise.

Gets the list of effect definitions for the audio submix node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioSubmixNode output audio is emitted when spatial audio processing is used.

The spatial audio emitter associated with the AudioSubmixNode.

Gets the encoding properties for the audio device submix node.

The encoding properties for the node.

Gets outgoing connections from the audio submix node to other nodes in the audio graph.

A collection of objects representing audio graph connections.

Gets or sets the outgoing gain for the audio submix node.

The outgoing gain value.

Adds an outgoing connection to the audio submix node.

The destination node for the connection.

Adds an outgoing connection with gain to the audio submix node.

The destination node for the connection. A value indicating the gain associated with the connection. This is a scalar multiplier of the audio signal. The default value is 1.0.

Closes the audio submix node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Removes the outgoing connection from the audio submix node to the specified node.

The audio node for which the outgoing connection is removed.

Resets the audio submix node.

Starts the audio submix node.

Stops the audio submix node.

Represents the result of attempting to create an audio device input node.

Gets the audio device input node.

An object representing the audio device input node.

Gets the extended error code associated with the creation of a AudioDeviceInputNode object.

The extended error code associated with the creation of a AudioDeviceInputNode object.

Gets the result status of an operation to create an AudioDeviceInputNode with a call to CreateDeviceInputNodeAsync.

An enumeration value indicating node creation status. If the result status is **Success**, get the instance of the node with the Node property.

Represents the result of attempting to create an audio device output node.

Gets the audio device output node.

An object representing the audio device output node.

Gets the extended error code associated with the creation of a AudioDeviceOutputNode object.

The extended error code associated with the creation of a AudioDeviceOutputNode object.

Gets the result status of an operation to create an AudioDeviceOutputNode with a call to CreateDeviceOutputNodeAsync.

An enumeration value indicating node creation status. If the result status is **Success**, get the instance of the node with the Node property.

Represents the result of attempting to create an audio file input node.

Gets the extended error code associated with the creation of a AudioFileInputNode object.

The extended error code associated with the creation of a AudioFileInputNode object.

Gets the audio file input node.

An object representing the audio file input node.

Gets the result status of an operation to create an AudioFileInputNode with a call to CreateFileInputNodeAsync.

An enumeration value indicating file node creation status. If the result status is **Success**, get the instance of the node with the Node property.

Represents the result of attempting to create an audio file output node.

Gets the extended error code associated with the creation of a AudioFileOutputNode object.

The extended error code associated with the creation of a AudioFileOutputNode object.

Gets the audio file output node.

An object representing the audio file output node.

Gets the result status of an operation to create an AudioFileOutputNode with a call to CreateFileOutputNodeAsync.

An enumeration value indicating node creation status. If the result status is **Success**, get the instance of the node with the Node property.

Represents the result of attempting to create an audio graph.

Gets the extended error code associated with the creation of a AudioGraph object.

The extended error code associated with the creation of a AudioGraph object.

Gets the audio graph object.

An object indicating the audio graph.

Gets the result status of an operation to create an AudioGraph with a call to AudioGraph.CreateAsync.

An enumeration value indicating audio graph creation status.

Represents the result of attempting to create a MediaSourceAudioInputNode.

Gets the extended error code associated with the creation of a MediaSourceAudioInputNode object.

The extended error code associated with the creation of a MediaSourceAudioInputNode object.

Gets the **MediaSource** audio input node.

The **MediaSource** audio input node.

Gets the result status of an operation to create a MediaSourceAudioInputNode with a call to AudioGraph.CreateMediaSourceAudioInputNodeAsync.

An enumeration value indicating audio graph creation status.

Represents an echo effect definition supported by the audio graph.

Creates an EchoEffectDefinition object.

The AudioGraph with which the effect will be used. Using effects outside of the audio graph it was created with is not supported.

Gets the activatable class ID for the echo effect definition object.

The activatable class ID.

Gets or sets the delay time, in milliseconds, of the echo effect definition.

A value indicating the delay, in milliseconds.

Gets or sets the feedback included in the echo effect definition.

A feedback value.

Gets or sets the properties supported by the echo effect definition.

The set of properties.

Gets or sets the wet-dry audio voice mix for the echo effect definition.

A value indicating the wet-dry audio voice mix.

Represents an equalizer band for the equalizer effect.

Gets or sets the bandwidth for the equalizer band.

A bandwidth value.

Gets or sets the frequency center for the equalizer band.

A value indicating the frequency center.

Gets or sets the gain for the equalizer band.

A value indicating the gain.

Represents an equalizer effect definition supported by the audio graph.

Initializes a new instance of the EqualizerEffectDefinition class.

The AudioGraph with which the effect will be used. Using effects outside of the audio graph it was created with is not supported.

Gets the activatable class ID for the equalizer effect definition object.

The activatable class ID.

Gets the bands included in the equalizer effect definition.

A collection of objects indicating the equalizer bands.

Gets the properties supported by the equalizer effect definition.

The set of properties.

Provides data for the AudioFrameInputNode.QuantumStarted event. This event is raised when the audio graph containing the audio frame input node is ready to begin processing a new quantum of data.

Gets the number of samples that the audio graph requires to fill the quantum with data.

The number of samples that the audio graph requires to fill the quantum with data.

Defines an audio input node.

Gets outgoing connections for the audio input node.

A collection of audio graph connection objects representing the outgoing connections.

Adds an outgoing connection to the audio input node.

The destination node for the connection.

Adds an outgoing connection with gain to the audio input node.

The destination node for the connection. A value indicating the gain associated with the connection.

Removes the outgoing connection from the audio input node to the specified node.

The audio node for which the outgoing connection is removed.

The interface implemented by audio input nodes that support spatial audio.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the audio input node audio is emitted when spatial audio processing is used.

The emitter for the audio input node.

Defines an audio node.

Gets or sets a value indicating if the audio node consumes input.

True if the audio node consumes input, and false otherwise.

Gets the list of effect definitions for the audio node.

The list of effect definitions for the node.

Gets the encoding properties for the audio node.

The encoding properties for the node.

Gets or sets the outgoing gain for the audio node.

The outgoing gain value.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Resets the audio node.

Starts the audio node.

Stops the audio node.

The interface implemented by audio nodes that support a spatial audio listener.

Gets or sets the AudioNodeListener that describes the position and other characteristics of the listener from which the node's audio is heard when spatial audio processing is used.

The listener for the audio node.

Represents a limiter effect definition supported by the audio graph.

Initializes a new instance of the LimiterEffectDefinition class.

The AudioGraph with which the effect will be used. Using effects outside of the audio graph it was created with is not supported.

Gets the activatable class ID for the limiter effect definition object.

The activatable class ID.

Gets or sets the loudness included in the limiter effect definition.

A value indicating the loudness.

Gets the properties supported by the limiter effect definition.

The set of properties.

Gets or sets the release included in the limiter effect definition.

The release value.

Represents a node in an audio graph that inputs audio data into the graph from a MediaSource object.

Gets or sets a value indicating if the **MediaSource** input node consumes input.

True if the node consumes input; otherwise, false.

Gets the duration for the media content represented by the MediaSource associated with the node.

A value indicating the duration for the audio input file media content.

Gets the list of effect definitions for the **MediaSource** node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.

The list of effect definitions for the node.

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioSubmixNode output audio is emitted when spatial audio processing is used.

The spatial audio emitter associated with the **MediaSource** audio input node.

Gets the encoding properties for the audio device submix node.

The encoding properties for the audio device submix node.

Gets or sets the end time for the **MediaSource** input node, which determines when playback of the media content ends.

A value indicating the end time.

Gets or sets the loop count of the **MediaSource** input node.

A reference to an integer representing the loop count.

Gets the **MediaSource** associated with the audio input node.

The **MediaSource** associated with the audio input node.

Gets the list of outgoing connections from the **MediaSource** input node to other nodes in the audio graph.

A collection of AudioGraphConnection objects representing the supported connections.

Gets or sets the outgoing gain for the **MediaSource** audio input node.

The outgoing gain value.

Gets or sets the playback speed factor for the **MediaSource** audio input node.

A value indicating the playback speed factor.

Gets the playback position of the **MediaSource** input node.

The current playback position within the media content, in seconds.

Gets or sets the start time for the **MediaSource** input node.

A value indicating the start time.

Occurs when the playback position reaches the end of the media content or the position specified with the EndTime property.

Adds an outgoing connection with gain to the **MediaSource** input node.

The destination node for the connection.

Adds an outgoing connection with gain to the **MediaSource** input node.

The destination node for the connection. A value indicating the gain associated with the connection. This is a scalar multiplier of the audio signal. The default value is 1.0.

Closes the **MediaSource** input node and disposes of associated resources.

Disables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to disable.

Enables all effects in the EffectDefinitions list with the specified effect definition.

The effect definition of the effects to enable.

Removes the outgoing connection from the **MediaSource** audio input node to the specified node.

The audio node for which the outgoing connection is removed.

Resets the **MediaSource** audio input node.

Moves the playback position of the node to the specified time within the media content.

A value indicating the position to which the node should seek.

Starts the **MediaSource** input node.

Stops the audio file output node.

Specifies the result status of a call to AudioGraph.CreateMediaSourceAudioInputNode.

The **MediaSourceAudioInputNode** could not be created because the media content associated with the **MediaSource** is in a format that is not supported by the AudioGraph API.

The **MediaSourceAudioInputNode** could not be created because of a network error.

The **MediaSourceAudioInputNode** was created successfully.

The MediaSourceAudioInputNode could not be created because of an unknown failure.

Specifies which policy to use when picking a spatial audio format in mixed reality.

Use the device configuration's default.

Use the system defined default for Mixed Reality.

Defines values used for quantum size selection.

Use the value closest to the one desired.

Use the value with the lowest latency.

Use the system default value.

Represents a reverberation effect definition supported by the audio graph.

Initializes a new instance of the ReverbffectDefinition class.

The AudioGraph with which the effect will be used. Using effects outside of the audio graph it was created with is not supported.

Gets the activatable class ID for the reverberation effect definition object.

The activatable class ID.

Gets or sets the decay time supported by the reverberation effect definition.

The decay time.

Gets or sets the density included in the reverberation effect definition.

The density value.

Gets or sets a value indicating if the reverberation effect disables late fields.

True if the reverberation effect disables late fields, and false otherwise.

Gets or sets the early diffusion value for the reverberation effect definition.

The early diffusion value.

Gets or sets the high equalization cutoff included in the reverberation effect definition.

The high equalization cutoff value.

Gets or sets the high equalization gain included in the reverberation effect definition.

The high equalization gain value.

Gets or sets the late diffusion included in the reverberation effect definition.

The late diffusion value.

Gets or sets the low equalization cutoff included in the reverberation effect definition.

The low equalization cutoff value.

Gets or sets the low equalization gain included in the reverberation effect definition.

The low equalization gain value.

Gets or sets the position left included in the reverberation effect definition.

The position left value.

Gets or sets the matrix position left included in the reverberation effect definition.

The matrix position left value.

Gets or sets the matrix position right included in the reverberation effect definition.

The matrix position right value.

Gets or sets the position right included in the reverberation effect definition.

The position right value.

Gets the properties supported by the reverberation effect definition.

The set of properties.

Gets or sets the rear delay included in the reverberation effect definition.

The rear delay value.

Gets or sets the reflections delay included in the reverberation effect definition.

The reflections delay value.

Gets or sets the reflections gain included in the reverberation effect definition.

The reflections gain value.

Gets or sets the reverberation delay included in the reverberation effect definition.

The reverberation delay value.

Gets or sets the reverberation gain included in the reverberation effect definition.

The reverberation gain value.

Gets or sets the room filter frequency included in the reverberation effect definition.

The room filter frequency value.

Gets or sets the room filter high frequency included in the reverberation effect definition.

The room filter high frequency value.

Gets or sets the main room filter included in the reverberation effect definition.

The main room filter value.

Gets or sets the room size included in the reverberation effect definition.

A value indicating the room size.

Gets or sets the wet-dry audio voice mix for the reverberation effect definition.

The wet-dry audio voice mix.

Represents the result of attempting to set a default spatial audio format.

Specifies the status of the result, whether it failed (and why) or succeeded.

An enumeration value indicating set default spatial audio format status.

Specifies the status of the SetDefaultSpatialAudioFormatResult, whether it failed (and why) or succeeded.

The caller doesn't have permission to change/set this spatial audio format.

There is no current license for this spatial audio format.

This spatial audio format is licensed, but not for this endpoint.

This audio endpoint doesn't support this format.

The call succeeded and the format was set.

Something unexpected went wrong.

Represents a audio device, providing information and control for its current spatial audio setup.

Provides the currently active spatial audio format for this device. This could have been changed by the system and therefore may not be the same as the default.

A string of the GUID for the active spatial audio format.

Provides the default spatial audio format for this device. This is the format the user has selected.

A string of the GUID for the default spatial audio format.

The ID of the device this object represents.

String representation of the device ID.

Specifies whether this device can support any form of spatial audio.

Bool indicating whether this device supports spatial audio.

Occurs when the spatial audio state of the device has changed.

Creates a SpatialAudioDeviceConfiguration for the given device ID.

The device ID of the device to represent. The SpatialAudioDeviceConfiguration for the device.

Specifies whether this device can support the given spatial audio format.

A string of the GUID for the spatial audo format to check. SpatialAudioFormatSubtype enum will return the neccesary strings. Bool indicating whether the format is supported or not.

Tries to set the specified spatial audio format for this device. The caller must be the app that owns this spatial audio format.

A string of the GUID for the spatial audio format to set. SpatialAudioFormatSubtype enum will return the neccesary string. A result indicating success or why the call failed to set the specified format.

Provides a way to configure Spatial Audio Formats.

Specifies which policy to use when picking a spatial audio format in mixed reality.

An enumeration that specifies how to handle spatial audio in Mixed Reality.

Gets an instance of SpatialAudioFormatConfiguration.

An instance of SpatialAudioFormatConfiguration.

Allows a spatial audio format companion app to report that the configuration has changed for a specific format.

String of the GUID for the spatial audio format that's configuration has changed. An async action.

Allows a spatial audio format companion app to report that the license has changed for a specific format.

String of the GUID for the spatial audio format that's license has changed. An async action.

Helper class to retrieve the GUIDs for known spatial audio formats.

GUID for DolbyAtmosForHeadphones.

A string representation of the format's GUID.

GUID for DolbyAtmosForHomeTheater.

A string representation of the format's GUID.

GUID for DolbyAtmosForSpeakers.

A string representation of the format's GUID.

GUID for DTSHeadphoneX.

A string representation of the format's GUID.

GUID for DTSXUltra.

A string representation of the format's GUID.

GUID for WindowsSonic.

A string representation of the format's GUID.

Specifies the spatial audio processing model used by an AudioNodeEmitter.

Spatial audio is processed using non-spatial methods, such as panning between stereo channels. This provides less realistic spatial sound that preserves the X and Z coordinates of the emitter, but effectively ignores the Y coordinate. This model has a lower CPU and memory cost than object-based processing.

Spatial audio is processed using the Microsoft head-relative transfer function (HRTF) algorithm. This provides a more realistic spatial sound that preserves X, Y, and Z coordinates of the emitter, but at a higher CPU and memory cost than fold-down processing.

Represents a photo captured using system-provided computational photography techniques provided by the AdvancedPhotoCapture class.

Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to AdvancedPhotoCapture.CaptureAsync(Object).

The app-defined context object associated with the advanced photo capture operation.

Gets the captured frame containing the result of the advanced photo capture.

The captured frame containing the result of the advanced photo capture.

Gets a reference to a Rect that expresses the dimensions of the Frame generated by the advanced photo capture operation, relative to the reference photo passed into the OptionalReferencePhotoCaptured event.

A reference to a Rect that expresses the frame bounds of the captured frame relative to a reference photo.

Gets a value indicating the advanced capture mode with which the photo was captured.

A value indicating the advanced capture mode with which the photo was captured.

Provides methods for capturing photos using system-provided computational photography techniques.

Occurs when all of the frames required for the advanced photo capture have been captured.

Raised when a reference photo for the advanced photo operation has been captured, on devices that support this feature.

Asynchronously performs an advanced photo capture.

An asynchronous operation that returns an AdvancedCapturedPhoto upon successful completion.

Asynchronously performs an advanced photo capture passing the provided app-defined context object to the result of the operation.

An app-defined context object that passes context information to the result of the operation. An asynchronous operation that returns an AdvancedCapturedPhoto upon successful completion.

Asynchronously releases the AdvancedPhotoCapture object and resources used by the advanced photo capture operation.

An asynchronous action.

Provides information about the app capture feature.

Gets a value indicating whether another app is currently capturing audio.

True if another app is currently capturing audio; otherwise, false.

Gets a value indicating whether another app is currently capturing video.

True if another app is currently capturing video; otherwise, false.

Raised when the capturing status changes.

Gets the instance of this class for the current view.

The instance for the current view.

Sets a value that specifies whether the app capture is currently allowed for the calling app.

True if app capture is allowed; otherwise, false. An asynchronous action.

Provides a full window UI for capturing audio, video, and photos from a camera. As well as controls for trimming video, time delayed capture, and camera settings.

Create a new CameraCaptureUI object.

Provides settings for capturing photos. The settings include aspect ratio, image size, format, resolution, and whether or not cropping is allowed by the user interface (UI).

An object containing settings for capturing photos.

Provides settings for capturing videos. The settings include format, maximum resolution, maximum duration, and whether or not to allow trimming.

An object that provides settings for capturing videos.

Launches the CameraCaptureUI user interface.

Specifies whether the user interface that will be shown allows the user to capture a photo, capture a video, or capture both photos and videos. When this operation completes, a StorageFile object is returned.

Determines the highest resolution the user can select for capturing photos.

The user can select any resolution.

The user can select resolutions up to 1920 X 1080, or a similar 4:3 resolution.

The user can select resolutions up to 1024 X 768, or a similar 16:9 resolution.

The user can select resolutions up to 320 X 240, or a similar 16:9 resolution.

The user can select resolutions up to 5 MP.

The user can select resolutions up to 320 X 240, or a similar 16:9 resolution.

Determines the highest resolution the user can select for capturing video.

The user can select resolutions up to high definition resolutions.

The user can select any resolution.

The user can select resolutions up to low definition resolutions.

The user can select resolutions up to standard definition resolutions.

Determines whether the user interface for capturing from the attached camera allows capture of photos, videos, or both photos and videos.

The user can only capture a photo.

Either a photo or video can be captured.

The user can only capture a video.

Provides settings for capturing photos with CameraCaptureUI. The settings include aspect ratio, image size, format, resolution, and whether or not cropping is allowed by the user interface (UI).

Determines whether photo cropping will be enabled in the user interface for capture a photo.

True, if photo cropping will be enabled; otherwise, false.

The aspect ratio of the captured photo.

The aspect ratio of the captured photo. If zero, the aspect ratio is not enforced.

The exact size in pixels of the captured photo.

The size of the captured photo.

Determines the format that captured photos will be stored in.

A value that indicates the format for captured photos.

Determines the maximum resolution the user will be able to select.

A value that indicates the maximum resolution the user will be able to select.

Determines the format for photos captured with CameraCaptureUI.

JPEG format.

JPEG-XR format.

PNG format.

Provides settings for capturing videos. The settings include format, maximum resolution, maximum duration, and whether or not to allow trimming.

Determines whether or not the video trimming user interface will be enabled.

True, if the user will be allowed to trim videos; otherwise, false.

Determines the format for storing captured videos.

A value indicating the format for storing captured videos.

Determines the maximum duration of a video.

The maximum duration of a video. If this property is set to zero, no maximum duration is enforced.

Determines the maximum resolution that the user can select.

The maximum resolution that the user can select.

Determines the format for saving captured videos.

MP4/H.264/AAC format.

WMV format.

Represents a captured video frame.

Gets an object containing bitmap properties for the CapturedFrame. These properties convey image metadata such as EXIF data.

An object containing bitmap properties for the CapturedFrame.

Gets a value that indicates if the captured frame can be read from.

**true** if the captured frame can be read from; otherwise, **false**.

Gets a value that indicates if the captured frame can be written to.

**true** if the captured frame can be written to; otherwise, **false**.

Gets the content type of the captured frame.

The content type of the captured frame.

Gets an object containing capture control metadata for the CapturedFrame. Capture controls adjust capture settings such as ISO and exposure.

An object containing capture control metadata for the CapturedFrame.

Gets the height of the captured frame

The height of the frame.

Gets the position of the captured frame.

The position of the captured frame.

Gets the size of the captured frame in bytes.

The size of the captured frame in bytes.

Gets a SoftwareBitmap object representing the captured frame.

A SoftwareBitmap object representing the captured frame.

Gets the width of the captured frame.

The width of the captured frame.

Creates a copy of the stream.

The clone of the strem.

Closes the captured framed object.

Asynchronously commits and flushes all of the data of the CapturedFrame.

When this method completes, a boolean value is returned which specifies **true** if the operation completed successfully; otherwise, **false**.

Gets the input stream at the specified position.

The position in the input stream. The input stream.

Gets the output stream at the specified position.

The position in the output stream. The output stream.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the [Capacity](https://docs.microsoft.com/previous-versions/hh438363(v=vs.85)) value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Seeks the stream to the specified position.

The position in the stream to seek too.

Asynchronously writes the specified data to the stream.

The data to write to the stream. Represents an asynchronous operation that returns a result and reports progress.

Provides information about the capture device settings that were used for a frame in a variable photo sequence.

Gets the exposure time used for a frame in a variable photo sequence.

Gets the exposure time used for a frame in a variable photo sequence.

Gets the exposure compensation value used for a frame in a variable photo sequence.

The exposure compensation value used for a frame in a variable photo sequence.

Gets a value indicating if the flash was used for a frame in a variable photo sequence.

A value indicating if the flash was used for a frame in a variable photo sequence.

Gets the flash power used for a frame in a variable photo sequence.

The flash power used for a frame in a variable photo sequence.

Gets the focus lens position used for a frame in a variable photo sequence.

The focus lens position used for a frame in a variable photo sequence.

Gets the focus state for a frame in a variable photo sequence.

The focus state for a frame in a variable photo sequence.

Gets the ISO analog gain used for a frame in a variable photo sequence.

The ISO analog gain used for a frame in a variable photo sequence.

Gets the ISO digital gain used for a frame in a variable photo sequence.

The ISO digital gain used for a frame in a variable photo sequence.

Gets the ISO speed used for a frame in a variable photo sequence.

The ISO speed used for a frame in a variable photo sequence.

Gets the scene mode used for a frame in a variable photo sequence.

The scene mode used for a frame in a variable photo sequence.

Gets the sensor frame rate used for a frame in a variable photo sequence.

The sensor frame rate used for a frame in a variable photo sequence.

Gets the white balance setting used for a frame in a variable photo sequence.

The white balance setting used for a frame in a variable photo sequence.

Gets the white balance gain used for a frame in a variable photo sequence.

The white balance gain used for a frame in a variable photo sequence.

Gets the zoom factor used for a frame in a variable photo sequence.

The zoom factor used for a frame in a variable photo sequence.

Represents a photo taken from a capture device such as a webcam attached.

Gets the photo data, represented as CapturedFrame object, associated with the CapturedPhoto object.

The captured frame.

Represents a thumbnail image of the capture photo.

The thumbnail image.

Specifies the names of video recording profiles that are known by the system.

The profile provides hints to the driver to allow for photo capture during video capture with balanced quality between both.

The profile provides hints to the driver to optimize for High Dynamic Range (HDR) with Wide Color Gamut (WCG) photo.

The profile provides hints to the driver to optimize for High Dynamic Range (HDR) with Wide Color Gamut (WCG) video.

The profile provides hints to the driver to optimize for high frame rate video capture.

The profile provides hints to the driver to optimize for high-quality photo capture.

The profile provides hints to the driver to optimize for capturing photo sequences.

The profile provides hints to the driver to optimize for capturing variable photo sequences.

The profile provides hints to the driver to optimize for VoIP scenarios, prioritizing lower power consumption, lower latency, and concurrency (for example, using the front and back cameras of a device simultaneously) while deprioritizing higher resolution.

The profile provides hints to the driver to optimize for High Dynamic Range (HDR) video.

The profile provides hints to the driver to optimize for high-quality video, prioritizing higher resolution and frame rates over power consumption and latency.

Provides methods for taking a low lag media recording.

Asynchronously releases the LowLagMediaRecording object and resources used by the media recording operation.

Object that is used to control the asynchronous operation.

Pauses an ongoing low lag media record operation.

A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. An asynchronous action.

Pauses an ongoing low lag media record operation and provides a MediaCapturePauseResult that can be used to help the user align the camera with the last captured frame when resuming recording.

A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. An asynchronous action that returns a MediaCapturePauseResult upon completion.

Resumes a paused low lag recording operation.

An asynchronous action.

Asynchronously starts the low lag media recording.

Object that is used to control the asynchronous operation.

Asynchronously stops the low lag media recording.

Object that is used to control the asynchronous operation.

Asynchronously stops the low lag media recording and provides a MediaCaptureStopResult that can be used to help the user align the camera with the last captured frame when restarting recording.

An asynchronous action that returns a MediaCaptureStopResult upon completion.

Provides methods for taking a low shutter lag photo.

Asynchronously captures a low shutter lag photo.

When this method completes, a CapturedPhoto object is returned which contains the captured photo.

Asynchronously releases the LowLagPhotoCapture object and resources used by the capture photo operation.

Object that is used to control the asynchronous operation.

Provides methods for taking a rapid sequence of low shutter lag photos.

Occurs when a photo has been captured.

Asynchronously releases the LowLagPhotoSequenceCapture object and resources used by the photo sequence capture operation.

Object that is used to control the asynchronous operation.

Asynchronously starts capturing photos.

Object that is used to control the asynchronous operation.

Asynchronously stops capturing photos.

Object that is used to control the asynchronous operation.

Provides functionality for capturing photos, audio, and videos from a capture device, such as a webcam.

Creates a new instance of the MediaCapture object.

Gets an object that controls settings for the microphone.

An AudioDeviceController object that controls settings for the microphone.

Gets the current stream state of the camera stream.

The current stream state of the camera stream.

Gets a read-only dictionary of MediaFrameSource objects that can be used simultaneously to acquire media frames.

A read-only dictionary of MediaFrameSource objects that can be used simultaneously to acquire media frames.

Gets the configuration settings for the MediaCapture object.

A MediaCaptureSettings object that contains the settings.

Gets a value that indicates the current thermal status of the capture device.

A value that indicates the current thermal status of the capture device.

Gets an object that controls settings for the video camera.

A VideoDeviceController object.

Occurs when the state of the camera stream changes.

Occurs when the exclusive control status of the capture device changes.

Raised when an error occurs during media capture.

Occurs when the capture device changes focus.

Occurs when a photo confirmation frame is captured.

Occurs when the record limit is exceeded.

Occurs when the thermal status of the capture device changes.

Adds an audio effect to the capture pipeline.

The object containing the definition of the effect to be added. An asynchronous operation that returns an IMediaExtension upon successful completion.

Adds an audio or video effect.

AddEffectAsync might not be available in future versions of Windows. Starting with Windows Threshold, use AddAudioEffectAsync and AddVideoEffectAsync instead Specifies the streams to which the effect will be applied. The class identifier of the activatable runtime class that implements the effect. The runtime class must implement the IMediaExtension interface. Configuration parameters for the effect. Returns an IAsyncAction object that is used to control the asynchronous operation.

Adds a video effect to the capture pipeline.

The object containing the definition of the effect to be added. Specifies the streams to which the effect will be applied. An asynchronous operation that returns an IMediaExtension upon successful completion.

Captures a photo to a storage file.

The encoding properties for the output image. The storage file where the image is saved. Returns an IAsyncAction object that is used to control the asynchronous operation.

Captures a photo to a random-access stream.

The encoding properties for the output image. The stream where the image data is written. Returns an IAsyncAction object that is used to control the asynchronous operation.

Removes all audio and video effects from a stream.

The stream from which to remove the effects. Returns a IAsyncAction object that is used to control the asynchronous operation.

Closes the media capture object.

Creates a MediaFrameReader that is used to acquire frames from a MediaFrameSource.

The media frame source from which the reader will acquire frames. An asynchronous operation that returns a MediaFrameReader on completion.

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype from a MediaFrameSource.

The media frame source from which the reader will acquire frames. A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the MediaEncodingSubtypes class. An asynchronous operation that returns a MediaFrameReader on completion.

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype and size from a MediaFrameSource.

The media frame source from which the reader will acquire frames. A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the MediaEncodingSubtypes class. An object specifying the requested size for the frames acquired by the frame reader. An asynchronous operation that returns a MediaFrameReader on completion.

Creates a MultiSourceMediaFrameReader that is used to acquire time-correlated frames from one or more MediaFrameSource objects.

A IIterable list of MediaFrameSource objects to be used by the frame reader. An asynchronous operation that returns a MultiSourceMediaFrameReader upon successful completion.

Creates a new instance of the MediaCaptureRelativePanelWatcher class, which monitors the panel associated with the provided DisplayRegion, so that the app receives notifications when the relative location of the panel changes.

A value from the StreamingCaptureMode enumeration enumeration. A DisplayRegion for which the associated panel is monitored for changes. Typically this display region will be the camera view finder UI element, so that the app is alerted if the relative location of the panel containing the view finder changes. A new instance of the MediaCaptureRelativePanelWatcher class.

Retrieves the list of all video profiles supported by the specified video capture device.

The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see DeviceInformation.FindAllAsync. The list of video profiles supported by the specified video capture device.

Retrieves the list of video profiles supported by the specified video capture device that can be used while another profile is used on a different capture device.

The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see DeviceInformation.FindAllAsync. The list of video profiles supported by the specified video capture device that support concurrency.

Retrieves the list of all video profiles supported by the specified video capture device that match the specified KnownVideoProfile value.

The identifier of the video device for which supported video profiles are queried. For information on getting the video device ID, see DeviceInformation.FindAllAsync. A value specifying one of the profile names known by the system. The list of video profiles supported by the specified video capture device that match the specified known profile name.

Gets the value of an encoding property.

Specifies the stream to query for the encoding property. The encoding property to retrieve. Returns the value of the encoding property.

Gets a preview frame from the capture device.

An asynchronous operation that returns a VideoFrame on successful completion.

Gets a preview frame from the capture device, copied into the provided destination VideoFrame and converted into the destination frame's format.

The video frame into which the preview frame will be copied. An asynchronous operation that returns a VideoFrame on successful completion.

Queries whether the video stream is mirrored horizontally.

True if mirroring is enabled; false otherwise.

Gets the rotation of the video preview stream.

The amount by which the video preview stream is rotated.

Gets the rotation of the recorded video.

The amount by which the recorded video is rotated.

Initializes the MediaCapture object, using default settings.

Returns a IAsyncAction object that is used to control the asynchronous operation.

Initializes the MediaCapture object.

The initialization settings. Returns a IAsyncAction object that is used to control the asynchronous operation.

Gets a boolean value indicating whether video profiles are supported by the specified video capture device.

The identifier of the video device for which supported video profile support is queried. For information on getting the video device ID, see DeviceInformation.FindAllAsync. True if video profiles are supported; otherwise, false.

Pauses an ongoing record operation.

A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. An asynchronous action.

Pauses an ongoing media record operation and provides a MediaCapturePauseResult that can be used to help the user align the camera with the last captured frame when resuming recording.

A value indicating whether the media capture hardware resources should be preserved or released while recording is paused. An asynchronous action that returns a MediaCapturePauseResult upon completion.

Initializes the advanced photo capture and provides the AdvancedPhotoCapture object used to manage the recording.

The encoding properties used for the resulting image. An asynchronous operation that returns an AdvancedPhotoCapture object on successful completion.

Initializes the low shutter lag photo capture and provides the LowLagPhotoCapture object used to manage the recording.

The encoding profile used for the image. When this method completes, a LowLagPhotoCapture object is returned which can be used to start the photo capture.

Initializes the low shutter lag photo sequence capture and provides the LowLagPhotoSequenceCapture object used to manage the recording.

The encoding profile used for the image. When this method completes, a LowLagPhotoSequenceCapture object is returned which can be used to start the photo sequence capture.

Initializes the low lag recording using the specified custom sink to store the recording. This method provides the LowLagMediaRecording object used to managed the recording.

The encoding profile to use for the recording. The activatable class ID of the media extension for the custom media sink. Contains properties of the media extension. When this method completes, a LowLagMediaRecording object is returned which can be used to start the photo capture.

Initializes the low lag recording using the specified custom sink to store the recording. This method provides the LowLagMediaRecording object used to managed the capture.

The encoding profile to use for the recording. The media extension for the custom media sink. When this method completes, a LowLagMediaRecording object is returned which can be used to start the photo capture.

Initializes the low lag recording using the specified file to store the recording. This method provides the LowLagMediaRecording object used to managed the recording.

The encoding profile for the recording. The storage file where the image is saved. When this method completes, a LowLagMediaRecording object is returned which can be used to start the photo capture.

Initializes the low lag recording using the specified random-access stream to store the recording. This method provides the LowLagMediaRecording object used to managed the recording.

The encoding profile for the recording. The stream where the image data is written. When this method completes, a LowLagMediaRecording object is returned which can be used to start the photo capture.

Initializes the variable photo sequence capture and provides the VariablePhotoSequenceCapture object used to manage the recording.

The encoding profile used for the image. When this method completes, a VariablePhotoSequenceCapture object is returned which can be used to start the photo sequence capture.

Removes the specified effect from the capture pipeline.

The effect to remove from the capture pipeline. Returns an IAsyncAction object that is used to control the asynchronous operation.

Resumes a paused recording operation.

An asynchronous operation.

Sets an encoding property.

The type of media data the stream represents, such as video or audio. The encoding property to set. The new value of the encoding property.

Asynchronously sets the media encoding properties.

The type of media data the stream represents, such as video or audio. The properties for the media encoding. The properties for the encoder. Object that is used to control the asynchronous operation.

Enables or disables horizontal mirroring of the video preview stream. This is not the preferred method for mirroring. See the Remarks section below for details.

True to enable mirroring; false to disable mirroring.

Rotates the video preview stream.

The amount by which to rotate the video.

Rotates the recorded video.

The amount by which to rotate the video.

Starts preview.

Returns a IAsyncAction object that is used to control the asynchronous operation.

Starts sending a preview stream to a custom media sink using the specified encoding profile and sink settings.

The encoding profile to use for the recording. The activatable class ID of the media extension for the custom media sink. Contains properties of the media extension. An object that is used to control the asynchronous operation.

Starts sending a preview stream to a custom media sink using the specified encoding profile.

The encoding profile to use for the recording. The media extension for the custom media sink. An object that is used to control the asynchronous operation.

Start recording to a custom media sink using the specified encoding profile and sink settings.

The encoding profile to use for the recording. The activatable class ID of the media extension for the custom media sink. Contains properties of the media extension. An object that is used to control the asynchronous operation.

Start recording to a custom media sink using the specified encoding profile.

The encoding profile to use for the recording. The media extension for the custom media sink. An object that is used to control the asynchronous operation.

Starts recording asynchronously to a storage file.

The encoding profile for the recording. The storage file where the image is saved. Returns a IAsyncAction object that is used to control the asynchronous operation.

Starts recording to a random-access stream.

The encoding profile for the recording. The stream where the image data is written. Returns a IAsyncAction object that is used to control the asynchronous operation.

Stops preview.

Returns a IAsyncAction object that is used to control the asynchronous operation.

Stops recording.

Returns a IAsyncAction object that is used to control the asynchronous operation.

Asynchronously stops the media recording and provides a MediaCaptureStopResult that can be used to help the user align the camera with the last captured frame when restarting recording.

An asynchronous action that returns a MediaCaptureStopResult upon completion.

Specifies the exclusive control status of the media capture device. Exclusive control is required to modify the settings of the capture device, but is not required to obtain media frames from the device.

The current app can initialize the capture device with exclusive control.

Another app has exclusive control of the capture device, so the current app can't obtain exclusive control.

Provides data for the MediaCapture.CaptureDeviceExclusiveControlStatusChanged event.

Gets the device ID for the capture device for which exlusive control status has changed.

The device ID for the capture device for which exlusive control status has changed.

Gets a value indicating whether exclusive control of the capture device specified with the DeviceID property is available to the current app.

A value indicating whether exclusive control of the device is available or if the device can only be accessed in shared mode.

Provides data for the MediaCapture.Failed event.

The error code of the error that caused the event.

The error code.

A message string for the error.

The message string.

Represents the method that will handle the MediaCapture.Failed event.

The MediaCapture object that raised the event. Arguments that contain information about the event.

Provides data for the FocusChanged event.

Gets the current focus state of the capture device.

The current focus state of the capture device.

Contains initialization settings for the MediaCapture object which are passed to the MediaCapture.InitializeAsync method.

Creates a new instance of the MediaCaptureInitializationSettings object.

Gets a value indicating whether the system should always play a shutter sound when a photo is captured.

True if the system should always play a shutter sound; otherwise, false.

Gets the DeviceInformation.Id of the microphone.

The DeviceInformation.Id of the microphone.

Gets or sets a value that specifies the audio processing mode.

The audio processing mode.

Gets or sets the audio source for the capture operation.

The audio source for the capture operation.

Gets or sets the URI of the remote capture device to be initialized.

The URI of the remote capture device to be initialized.

Gets or sets the PasswordCredential object representing the credentials used to access the remote capture device to be initialized.

The credentials used to access the remote capture device.

Gets or set the media category.

The media category.

Gets or sets an object specifying the preferred memory location for storing frames acquired from a MediaFrameSource used by the MediaCapture.

An object specifying preferred the memory location for storing frames acquired from a MediaFrameSource.

Gets or sets the stream that is used for photo capture.

The stream that is used for photo capture.

Gets or sets the media description for photo capture.

The media description for photo capture.

Gets or sets the media description for preview video.

The media description for preview video.

Gets or sets the media description for video recording.

The media description for video capture.

Gets or sets an object that specifies the sharing mode for the MediaCapture.

An object that specifies the sharing mode for the MediaCapture.

Gets or sets the MediaFrameSourceGroup with which the MediaCapture should be initialized. This property defines a set of media frame sources that can be used simultaneously.

The MediaFrameSourceGroup with which the MediaCapture should be initialized.

Gets or sets the streaming mode.

The streaming mode.

Gets the DeviceInformation.Id of the video camera.

The DeviceInformation.Id of the video camera.

Gets or sets the video profile which provides hints to the driver to allow it to optimize for different capture scenarios.

The video profile.

Gets or sets the video source for the capture operation.

The video source for the capture operation.

Specifies the preferred memory location for captured video frames.

The system dynamically chooses between CPU and GPU memory.

CPU memory is used.

Provides the last frame captured and the recorded duration of a media capture operation that has been paused.

Gets a VideoFrame representing the last frame captured before the capture operation was paused.

The last frame captured before the capture operation was paused.

Gets the duration of the media captured before the capture operation was paused.

The duration of the media captured before the capture operation was paused.

Closes the object and disposes of associated resources.

Monitors the panel associated with a DisplayRegion, so that the app receives notifications when the relative location of the panel changes.

Gets the relative panel that the MediaCaptureRelativePanelWatcher monitors for changes.

A value from the Windows.Devices.Enumeration.Panel enumeration, indicating the relative panel that the MediaCaptureRelativePanelWatcher monitors for changes.

Raised when the relative location of the panel being monitored by the MediaCaptureRelativePanelWatcher changes.

Closes the relative panel watcher and disposes of associated resources.

Starts the MediaCaptureRelativePanelWatcher monitoring of the relative panel location of the associated DisplayRegion.

Stops the MediaCaptureRelativePanelWatcher monitoring of the relative panel location of the associated DisplayRegion.

Contains read-only configuration settings for the MediaCapture object.

Gets the DeviceInformation.Id of the microphone.

The DeviceInformation.Id of the microphone.

Gets the audio processing mode.

The audio processing mode.

Gets a value that indicates if the device’s region requires that a sound be played when a photo or video is captured.

**true** if the device’s region requires that a sound be played when a photo or video is captured; otherwise, **false**. An app may play a sound during photo or video capture even if it is not required by the device’s region.

Gets a value that indicates if the capture device supports recording video and taking a photo sequence at the same time.

**true** if the capture device supports concurrently recording video and capturing a photo sequence; otherwise, **false**.

Gets a value that indicates if the capture device supports recording video and taking a photo at the same time.

**true** if the capture device supports concurrently recording video and capturing a photo; otherwise, **false**.

Gets an IDirect3DDevice representing the Direct3D device instance being used by the associated MediaCapture object.

An IDirect3DDevice representing the Direct3D device instance being used by the associated MediaCapture object.

Gets the horizontal 35mm equivalent focal length of the camera lens on the capture device.

The horizontal 35mm equivalent focal length of the camera lens.

Gets the media category of the media.

The media category

Gets the stream that is used for photo capture.

The stream that is used for photo capture.

Gets the pitch offset of the camera in degrees.

The pitch offset in degrees.

Gets the streaming mode.

The streaming mode.

Gets the vertical 35mm equivalent focal length of the camera lens on the capture device.

The vertical 35mm equivalent focal length of the camera lens.

Gets a value that indicates which video streams are independent of each other.

A value of VideoDeviceCharacteristic that indicates which video streams are independent pf each other.

Gets the DeviceInformation.Id of the video camera.

The DeviceInformation.Id of the video camera.

Specifies the media frame source sharing mode for a MediaCapture object.

The MediaCapture should have exclusive control of one or more of the frame sources specified in SourceGroup.

The MediaCapture can acquire frames from the frame sources specified in SourceGroup but can't adjust the configuration of the frame sources.

Provides the last frame captured and the recorded duration of a media capture operation that has been stopped.

Gets a VideoFrame representing the last frame captured before the capture operation was stopped.

The last frame captured before the capture operation was stopped.

Gets the duration of the media captured before the capture operation was stopped.

The duration of the media captured before the capture operation was stopped.

Closes the object and disposes of associated resources.

Specifies the thermal status of a media capture device.

The thermal state is normal.

The capture device is overheated. You should stop the current capture session and save any captured media.

Represents a video profile that indicates a configuration supported by the video capture device.

Gets a read-only list of MediaFrameSourceInfo objects which provide details about the capabilities of a MediaFrameSource.

A read-only list of MediaFrameSourceInfo objects.

Gets the unique identifier of the video profile.

The unique identifier of the video profile.

Gets a read-only map of custom attributes provided by the capture device manufacturer.

A read-only map of custom attributes.

Gets a list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for photo capture.

A list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for photo capture.

Gets a list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for video preview.

A list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for video preview.

Gets a list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for video recording.

A list of MediaCaptureVideoProfileMediaDescription objects that represent supported video device settings for video recording.

Gets the device ID of the video device associated with the video profile.

The device ID of the video device associated with the video profile.

Gets the list of MediaCaptureVideoProfile objects that can be used concurrently with this video profile.

The list of MediaCaptureVideoProfile objects that can be used concurrently with this video profile.

Represents a description of media that is supported by a video profile.

Gets the frame rate of the media description.

The frame rate of the media description.

Gets the height of the media description.

The height of the media description.

Gets a value indicating if the media description includes HDR video support.

True if HDR video is supported; otherwise, false.

Gets a value indicating if the media description includes variable photo sequence support.

True if variable photo sequence is supported; otherwise, false.

Gets a read-only map of custom attributes provided by the capture device manufacturer.

A read-only map of custom attributes.

Gets a string containing the standard name for the media encoding subtype supported by the media profile, such as "Aac", "Jpeg", or "Hevc".

A string containing the standard name for the media encoding subtype supported by the media profile.

Gets the width of the media description.

The width of the media description.

Defines values for types of media categories.

Media is intended for real-time communications.

Media is game chat.

General media.

Media category is other.

Media is speech.

Specifies a type of stream on a media capture device.

An audio stream.

A photo stream.

A video preview stream.

A video recording stream.

Provides data for the AdvancedPhotoCapture.OptionalReferencePhotoCaptured event.

Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to AdvancedPhotoCapture.CaptureAsync(Object).

The app-defined context object associated with the advanced photo capture operation.

Gets the captured frame containing the reference photo from the advanced photo capture.

The captured frame containing the reference photo.

Provides data for the photo sequence PhotoCaptured event.

Gets a value that indicates time offset in the photo sequence.

The

Gets the captured image associated with the event.

The captured image.

Gets a thumbnail version of the captured image associated with the event.

The thumbnail image.

Specifies which stream on a video camera is used to capture photos.

Automatically select the stream.

Use the photo stream.

Use the video stream.

Provides data for the PhotoConfirmationCaptured event.

Gets the time offset from when capture began to the capture of the frame associated with the event.

The time offset from when capture began to the capture of the frame associated with the event.

Gets the captured frame.

The captured frame.

Specifies the local power line frequency.

The power-line frequency is determined automatically by the system.

Power-line frequency control is disabled.

The power-line frequency is 50 Hz.

The power-line frequency is 60 Hz.

Represents the method that will handle RecordLimitationExceeded and related events.

The object where the event handler is attached.

Specifies the streaming mode for a media capture device.

Capture audio only.

Capture audio and video.

Capture video only.

Indicates which video streams are independent of each other.

All streams are identical

All streams are independent.

Preview photo streams are identical

Preview video streams are identical.

Video and photo streams are identical

Specifies the rotation of the video stream.

The video stream is rotated 180 degrees clockwise.

The video stream is rotated 270 degrees clockwise.

The video stream is rotated 90 degrees clockwise.

The video stream is not rotated.

Represents a set of input and output VideoEncodingProperties for a video stream

Gets a VideoEncodingProperties object representing an video stream input configuration.

A VideoEncodingProperties object representing an video stream input configuration.

Gets a VideoEncodingProperties object representing an video stream output configuration.

A VideoEncodingProperties object representing an video stream output configuration.

Represents the red, green, and blue values of a white balance gain setting.

The blue value of a white balance gain setting.

The green value of a white balance gain setting.

The red value of a white balance gain setting.

Provides data for the PhotoCaptured event.

Gets a CapturedFrameControlValues object that indicates the capture settings used for the associated frame in a variable photo sequence.

A CapturedFrameControlValues object that indicates the capture settings used for the associated frame in a variable photo sequence.

Gets the time offset of the capture of the associated frame in a variable photo sequence.

The time offset of the capture of the associated frame in a variable photo sequence.

Gets a CapturedFrame object representing a captured frame of a variable photo sequence.

A CapturedFrame object representing a captured frame of a variable photo sequence.

Gets an index value that indicates which element of the DesiredFrameControllers vector was used to specify the requested control values for the associated frame of a variable photo sequence.

An index value that indicates which element of the DesiredFrameControllers vector was used to specify the requested control values for the associated frame of a variable photo sequence.

Provides methods and events that enable the capture of variable photo sequences.

Occurs when a frame of a variable photo sequence is captured.

Occurs when the VariablePhotoSequenceCapture object stops capturing frames for a variable photo sequence.

Asynchronously releases the VariablePhotoSequenceCapture object and resources used by the capture operation.

An asynchronous action.

Starts the capturing of variable photo sequence frames.

An asynchronous action.

Stops the capturing of variable photo sequence frames.

An asynchronous action.

Updates the frame control values of the variable photo sequence.

An asynchronous action.

Represents a frame of audio data retreived from a MediaFrameSource.

Gets an AudioEncodingProperties object that provides information about the audio data in the frame. This includes information like the bitrate, sample rate, and channel count of the audio data.

An AudioEncodingProperties object that provides information about the audio data in the frame.

Gets the MediaFrameReference wrapper object associated with the AudioMediaFrame, which provides access to format information and other properties of the media frame.

The MediaFrameReference wrapper object associated with the AudioMediaFrame.

Creates a copy of the AudioMediaFrame as an AudioFrame object.

An AudioFrame containing a copy of the AudioMediaFrame audio data.

Represents a frame from a MediaFrameSource that provides data in an IBuffer.

Gets the buffer that contains the data for the BufferMediaFrame.

The buffer that contains the data for the BufferMediaFrame.

Gets the MediaFrameReference wrapper object associated with the BufferMediaFrame, which provides access to format information and other properties of the media frame.

The MediaFrameReference wrapper object associated with the BufferMediaFrame.

Represents a VideoMediaFrame that contains depth video data.

Gets an object that describes the format of the depth data in the DepthMediaFrame.

An object that describes the format of the depth data in the DepthMediaFrame.

Gets the MediaFrameReference wrapper object associated with the DepthMediaFrame, which provides access to format information and other properties of the media frame.

The MediaFrameReference wrapper object associated with the DepthMediaFrame

Gets a value that specifies the maximum reliable depth value for the camera that captured the depth frame.

A value that specifies the maximum reliable depth value for the camera that captured the depth frame.

Gets a value that specifies the minimum reliable depth value for the camera that captured the depth frame.

A value that specifies the minimum reliable depth value for the camera that captured the depth frame.

Gets the VideoMediaFrame associated with the DepthMediaFrame.

The VideoMediaFrame associated with the DepthMediaFrame.

Attempts to create a DepthCorrelatedCoordinateMapper for the DepthMediaFrame. This object provides methods for mapping pixel coordinates from a MediaFrameSource camera to the coordinate system of a different **MediaFrameSource** or to 3D space.

An object that describes the distortion model of the **MediaFrameSource** camera for which coordinates will be mapped using the DepthMediaFrame data. An object representing the spatial coordinate system of the camera for which coordinates will be mapped using the DepthMediaFrame data. A DepthCorrelatedCoordinateMapper if the operation was successful; otherwise, null.

Describes the format of a DepthMediaFrame.

Gets the scale of the depth values in a DepthMediaFrame, in meters.

The scale of the depth values in a DepthMediaFrame, in meters.

Gets the VideoMediaFrameFormat object that describes the non-depth-specific format of a DepthMediaFrame.

The VideoMediaFrameFormat object that describes the non-depth-specific format of a DepthMediaFrame.

Represents a VideoMediaFrame that contains infrared video data.

Gets the MediaFrameReference wrapper object associated with the InfraredMediaFrame, which provides access to format information and other properties of the media frame.

The MediaFrameReference wrapper object associated with the InfraredMediaFrame.

Gets a value specifying whether the infrared media frame is illuminated.

True if the infrared media frame is illuminated; otherwise, false.

Gets the VideoMediaFrame associated with the InfraredMediaFrame.

The VideoMediaFrame associated with the InfraredMediaFrame.

Provides data for the MediaFrameReader.FrameArrived event.

Describes the format of a media frame obtained from a MediaFrameSource and represented by a MediaFrameReference.

Gets an AudioEncodingProperties object that provides information about the audio data in an audio frame. This includes information like the bitrate, sample rate, and channel count of the audio data.

An AudioEncodingProperties object that provides information about the audio data in the frame.

Gets the frame rate of the media frame.

The frame rate, in frames per second.

Gets a string identifying the major type of a media frame.

A string identifying the major type of a media frame.

Gets a map of properties for the frame format.

A map of properties for the frame format.

Gets a string identifying the subtype of a media frame.

A string identifying the subtype of a media frame.

Gets an object describing the image format of a video media frame.

An object describing the image format of a video media frame.

Provides access to frames from a MediaFrameSource and notification when a new frame arrives.

Gets or sets a value that specifies the way that the system should manage frames acquired from a **MediaFrameReader** when a new frame arrives before the app has finished processing the previous frame.

A value that specifies the frame reader's acquisition mode.

Occurs when a new frame arrives from the media frame source associated with the MediaFrameReader.

Disposes of the object and associated resources.

Asynchronously starts the reading of frames from a MediaFrameSource.

An asynchronous operation that returns a MediaFrameReaderStartStatus on completion.

Asynchronously stops the reading of frames from a MediaFrameSource.

An asynchronous action.

Attempts to obtain a MediaFrameReference object representing the latest frame from the MediaFrameSource.

A MediaFrameReference representing the latest frame from the media frame source.

Specifies the way that the system should manage frames acquired from a MediaFrameReader or a MultiSourceMediaFrameReader when a new frame arrives before the app has finished processing the previous frame.

Frames that arrive while the app's FrameArrived event handler is executing are buffered in memory by the system. The **FrameArrived** event is raised for each buffered frame when the event handler for the previous frame has completed. This mode is intended for apps for which the sequence of frames is critical and for which dropped frames will break the scenario.

Frames that arrive while the app's FrameArrived event handler is executing are dropped. This mode works well for scenarios where processing the most current frame is prioritized, such as real-time computer vision applications.

Specifies the result of a call to StartAsync to start the reading of media frames by a MediaFrameReader.

The operation failed because the media frame source device is unavailable.

The operation failed because exclusive control of the media frame source device is unavailable.

The operation failed because the requested output format is not supported by the media frame source.

The operation was successful.

The operation failed for an unknown reason.

A wrapper class that represents a frame obtained from a MediaFrameSource. Use the properties of this class to access the specific frame type provided by the source, such as a VideoMediaFrame or BufferMediaFrame.

Gets the AudioMediaFrame wrapped by the MediaFrameReference, if that is the type of frame represented.

The AudioMediaFrame wrapped by the MediaFrameReference.

Gets the BufferMediaFrame wrapped by the MediaFrameReference, if that is the type of frame represented.

The BufferMediaFrame wrapped by the MediaFrameReference.

Gets the spatial coordinate system for the referenced media frame, if one is defined.

The spatial coordinate system for the referenced media frame.

Gets the duration of the referenced media frame.

The duration of the referenced media frame.

Gets the format of the reference media frame.

The format of the reference media frame.

Gets a map of properties for the referenced frame.

A map of properties for the referenced frame.

Gets the type of MediaFrameSource from which the referenced frame originated, such as a color, infrared, or custom source.

The type of media frame source from which the referenced frame originated.

Gets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system. This value uses 100ns interval QPC time. For more information on QPC time, see Acquiring high-resolution time stamps.

Gets the VideoMediaFrame wrapped by the MediaFrameReference, if that is the type of frame represented.

The VideoMediaFrame wrapped by the MediaFrameReference.

Disposes of the object and associated resources.

Represents a source of media frames, such as a color or infrared camera.

Gets the MediaFrameSourceController for the MediaFrameSource.

The MediaFrameSourceController for the media frame source.

Gets a value indicating the current frame format of the MediaFrameSource.

A value indicating the current frame format of the media frame source.

Gets the MediaFrameSourceInfo object that provides information about the MediaFrameSource.

The MediaFrameSourceInfo object that provides information about the media frame source.

Gets a read-only list of MediaFrameFormat objects representing the frame formats supported by the MediaFrameSource.

A read-only list of frame formats supported by the media frame source.

Occurs when the current frame format of the MediaFrameSource changes.

Asynchronously sets the frame format of the MediaFrameSource.

The new frame format for the media frame source. An asynchronous action.

Attempts to retrieve the media frame source's camera intrinsics, which describe a camera's distortion model, for the specified MediaFrameFormat.

The media frame format for which the camera intrinsics should be retrieved. An object representing the camera intrinsics for the frame source, if they can be retrieved; otherwise, null.

Allows you to get and set properties of a MediaFrameSource and to get a VideoDeviceController, which provides camera controls such as exposure, focus, and zoom.

Gets an AudioDeviceController for a MediaFrameSource, which provides controls such as setting the volume level or muting the audio device.

An AudioDeviceController for the media frame source.

Gets a VideoDeviceController for a MediaFrameSource, which provides camera controls such as exposure, focus, and zoom.

A VideoDeviceController for the media frame source.

Asynchronously gets an object that contains the value of a MediaFrameSource property, if the property value is successfully retrieved, and describes the result status of the get operation.

The identifier of the media frame source property to be retrieved. An asynchronous operation that returns a MediaFrameSourceGetPropertyResult upon completion.

Asynchronously gets the value of the property with the specified ID from a MediaFrameSource, using an extended ID with custom header information and specifying the maximum buffer size required to store the result.

A byte array containing the extended identifier data. The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the Status property of the returned VideoDeviceControllerGetDevicePropertyResult object will be **MaxPropertyValueSizeRequired**. An asynchronous operation that, upon successful completion, returns a MediaFrameSourceGetPropertyResult object containing the status of the operation and, if successful, the returned property value.

Asynchronously sets the value of a MediaFrameSource property and returns a MediaFrameSourceSetPropertyStatus object describing the result status of the set operation.

The identifier of the media frame source property to be set. The value of the media frame source property to be set. An asynchronous operation that returns a MediaFrameSourceSetPropertyStatus upon completion.

Asynchronously sets the value of the property with the specified ID on a MediaFrameSource, using an extended ID with custom header information.

A byte array containing the extended identifier data. A byte array containing the value to be set for the property. An asynchronous operation that, upon successful completion, returns a MediaFrameSourceSetPropertyStatus value indicating the status of the operation.

Represents the value of a MediaFrameSource property, if it was successfully retrieved, and the result status of the get operation.

Gets a value describing the result status of the get operation that attempted to retrieve the MediaFrameSource property value.

A value describing the result status of the get operation

Gets an object containing the value of a MediaFrameSource property, if the value was successfully retreived.

An object containing the value of a media frame source property.

Specifies the result of a MediaFrameSourceController.GetPropertyAsync or MediaFrameSourceController.GetPropertyByExtendedIdAsync operation.

The operation failed because the media frame source device is unavailable.

The *maxPropertyValueSize* parameter to MediaFrameSourceController.GetPropertyByExtendedIdAsync is required.

The *maxPropertyValueSize* provided in the call to MediaFrameSourceController.GetPropertyByExtendedIdAsync is too small for the property value.

The operation failed because specified property is not supported by the media frame source.

The operation was successful.

The operation failed for an unknown reason.

Represents a group of media frame sources that can be used simultaneously by a MediaCapture.

Gets the human-readable name for the media frame source group.

The human-readable name for the media frame source group.

Gets a unique identifier for the media frame source group.

A unique identifier for the media frame source group.

Gets a list of MediaFrameSourceInfo objects that describe each media frame source in the group.

An asynchronous action that returns a list of MediaFrameSourceInfo upon successful completion.

Asynchronously retrieves a list of the available media frame source groups on the current device.

An asynchronous operation that returns a list of MediaFrameSourceGroup objects upon completion.

Asynchronously gets the media frame source group with the specified ID.

The unique identifier of a media frame source group. An asynchronous operation that returns a MediaFrameSourceGroup upon successful completion.

Gets a device selector string that can be used to initialize a DeviceWatcher, which allows you receive notifications when the set of available media frame source groups changes.

The device selector string for a media frame source group.

Provides information about a MediaFrameSource.

Gets an object representing the spatial coordinate system in which the data from a MediaFrameSource is expressed.

An object representing the spatial coordinate system of the media frame source.

Gets a DeviceInformation object that can be used to access properties of a MediaFrameSource device.

A DeviceInformation object representing a media frame source.

Gets the unique identifier for a MediaFrameSource. Use this identifier as the key when getting a **MediaFrameSource** instance from MediaCapture.FrameSources dictionary.

The unique identifier for a media frame source.

Gets a value indicating the stream type of a MediaFrameSource, such as photo, video, or audio.

A value indicating the stream type of a media frame source.

Gets the unique identifier of the MediaCaptureVideoProfile associated with the MediaFrameSourceInfo.

The unique identifier of the **MediaCaptureVideoProfile** associated with the MediaFrameSourceInfo.

Gets a read-only map of properties for a MediaFrameSource.

A read-only map of properties for a media frame source.

Gets the MediaFrameSourceGroup to which a MediaFrameSource belongs.

The group to which a media frame source belongs.

Gets a value indicating the kind of media frames generated by a MediaFrameSource, such as color, depth, or infrared.

A value indicating the kind of media frames generated by a media frame source.

Gets a read-only list of MediaCaptureVideoProfileMediaDescription objects which specify a group of capture settings that are supported by a video profile.

A read-only list of MediaCaptureVideoProfileMediaDescription objects.

Gets the relative panel location of the provided DisplayRegion when using the associated MediaFrameSource.

The **DisplayRegion** for which the relative panel location is retrieved. A member of the Panel enumeration indicating relative panel location of the provided **DisplayRegion**.

Specifies the kind of data produced by a MediaFrameSource.

The media frame source produces audio data.

The media frame source produces color data.

The media frame source produces custom data.

The media frame source produces depth data.

The media frame source produces image data.

The media frame source produces infrared data.

Specifies the result of a MediaFrameSourceController.SetPropertyAsync operation.

The operation failed because the media frame source device is unavailable.

The operation failed because the supplied value is not valid for the specified property.

The operation failed because the media frame source was not opened with SharingMode set to ExclusiveControl.

The operation failed because specified property is not supported by the media frame source.

The operation was successful.

The operation failed for an unknown reason.

Provides data for the MultiSourceMediaFrameReader.FrameArrived event.

Provides access to time-correlated frames from multiple MediaFrameSource and provides notifications when new frames arrive. This is useful if you need to process frames from different sources, such as a depth camera and an rbg camera, and you need to make sure that the frames from each source were captured close to each other in time.

Specifies the way that the system should manage frames acquired from a **MultiSourceMediaFrameReader** when a new frame arrives before the app has finished processing the previous frame.

A value that specifies the frame reader's acquisition mode.

Occurs when a new frame arrives from all of the media frame sources associated with the MultiSourceMediaFrameReader.

Disposes of the object and associated resources.

Asynchronously starts the reading of time-corellated frames from one or more MediaFrameSource objects.

An asynchronous operation that returns a MultiSourceMediaFrameReaderStartStatus on completion.

Asynchronously stops the reading of time-corellated frames from one or more MediaFrameSource objects.

An asynchronous action

Attempts to obtain a MultiSourceMediaFrameReference object which provides access to the latest time-correlated frames from one or more MediaFrameSource objects.

A MultiSourceMediaFrameReference providing access to the latest frames from the media frame sources.

Specifies the status of a MultiSourceMediaFrameReader start operation. A value from this enumeration is returned by the MultiSourceMediaFrameReader.StartAsync method.

The reader could not be started because the capture device is unavailable.

The reader could not be started due to insufficient system resources.

MultiSourceMediaFrameReader is not supported for the current device.

The frame reader was started successfully.

There was an unknown failure

A wrapper class that provides access to time-correlated frames obtained from one or more MediaFrameSource objects. Call TryGetFrameReferenceBySourceId to get the MediaFrameReference representing a frame from a particular media frame source.

Disposes of the object and associated resources.

Attempts to get a time-correlated MediaFrameReference for the specified media frame source.

The Id property of the MediaFrameSourceInfo object representing the media frame source from which a frame reference should be retreived. A MediaFrameReference representing a time-correlated media frame.

Represents a frame from a MediaFrameSource that provides data in a video frame represented by a IDirect3DSurface or SoftwareBitmap.

Gets an object that describes the distortion model of the camera that generated the VideoMediaFrame.

An object that describes the distortion model of the camera that generated the VideoMediaFrame.

Gets a DepthMediaFrame containing depth data for the VideoMediaFrame, if the frame contains depth data.

A DepthMediaFrame containing depth data.

Gets an IDirect3DSurface object containing the image data for the VideoMediaFrame.

An IDirect3DSurface object containing the image data for the VideoMediaFrame.

Gets the MediaFrameReference wrapper object associated with the VideoMediaFrame, which provides access to format information and other properties of the media frame.

The MediaFrameReference wrapper object associated with the VideoMediaFrame.

Gets an InfraredMediaFrame containing depth data for the VideoMediaFrame, if the frame contains infrared data.

A InfraredMediaFrame containing infrared data.

Gets a SoftwareBitmap object containing the image data for the VideoMediaFrame.

A SoftwareBitmap object containing the image data for the VideoMediaFrame.

Gets an object describing the format of the VideoMediaFrame image data.

An object describing the format of the VideoMediaFrame image data.

Creates a copy of the VideoMediaFrame as a VideoFrame object.

The VideoFrame containing a copy of the VideoMediaFrame image data.

Describes the image format of a VideoMediaFrame.

Gets an object that describes the format of the depth data in a video media frame, if the frame contains depth data.

An object that describes the format of the depth data in a video media frame.

Gets the height of the video media frame, in pixels.

The height of the video media frame, in pixels.

Gets an object that provides information about the format of the media frame that is not specific to video frames.

An object that provides information about the format of the media frame.

Gets the width of the video media frame, in pixels.

The width of the video media frame, in pixels.

Represents a connection with a casting device.

Gets the casting device with which a connection has been made.

The casting device.

Gets and sets the content source that is being casted through the connection to the casting device. The content can be set and changed at any time and doing so does not disconnect the connection.

The content source that is being casted to the casting device.

Gets the current state of the connection.

The current state of the connection.

Indicates an error occurred while attempting to make a casting connection.

Indicates a change in the State property.

Closes the casting connection.

Terminates a casting connection. The content that was rendering remotely returns to the local element that you retrieved the casting source from.

The status of the termination.

Starts the process of casting to a casting device. When called, this method pairs the c sting device, if necessary, and verifies access to the casting device with the user. If the user denies the app access to the device, casting fails. Otherwise, a connection is established, and content is sent to the device. During this time, the connection state changes to connecting, then to connected. If a casting source is set, the state changes to rendering once playback begins.

The content to be casted. The status of the casting connection request.

Represents arguments for the ErrorOccurred event from the CastingConnection

Gets the particular error that triggered the casting error event, ErrorOccurred.

The error status when starting or ending a casting connection.

Gets human-readable message to accompany the error status code, ErrorStatus.

The human-readable message.

Indicates the error status when starting or ending a casting connection.

The device did not respond to the attempt to start or end theconnection.

The device returned an error when attempting to start or end the connection.

The device was locked and a start or end the connection could not be made.

The casting source was invalid.

The device could not provide protected playback.

Starting or ending the connection was successful.

An unknown error occurred when attempting to start or end the connection.

Indicates the current state of a casting connection. Rendering is used when actively playing content.

The casting connection is active.

The connection is connecting.

The casting connection has been disconnected.

The connection is being disconnected.

The casting connection is actively playing content.

Represents a physical device that is capable of supporting casting connections and rendering media content sent to it.

A human-readable name for the device, retrieved from the device itself.

The human-readable name for the device.

An icon representing the device.

The icon.

The device ID. This is the same ID used with Windows.Devices.Enumeration APIs.

The device's ID.

Creates a new CastingConnection object. This method does not establish a connection to the casting device.

The object that represents the casting connection.

Indicates whether the given device (a DeviceInformation object) supports casting.

The device you want to know about. True if the device supports casting; false otherwise.

Gets a CastingDevice object for a given a device ID (acquired from a query using the Windows.Devices.Enumeration APIs).

The device ID. The object representing the casting device.

Gets an AQS filter string to be used with the Windows.Devices.Enumeration APIs for a given CastingPlaybackTypes.

The casting playback type. The AQS filter string.

Gets an AQS filter string to be used with the Windows.Devices.Enumeration APIs for a given CastingSource.

The casting source. The AQS filter string.

Gets the media types supported by the device. containing

The media types, CastingPlaybackTypes, supported by the device.

Represents a device picker that contains a list of casting devices for the user to choose from.

Creates a CastingDevicePicker object.

Gets the colors of the picker UI.

The appearance details of the picker UI.

Gets the filter information for which devices to show in the picker.

The filter information.

Indicates that the user has dismissed the picker UI.

Indicates that the user has selected a device from the picker.

Hides the device picker UI.

Shows the casting device picker UI, which flies out from an edge of the provided rectangle.

The rectangle from which the picker UI should fly out.

Shows the casting device picker UI, which flies out from the specified edge of the provided rectangle.

The rectangle from which the picker should fly out. The edge of the rectangle from which the picker should fly out.

Represents the filter used to determine which devices to show in a casting device picker UI. The filter parameters are OR-ed together to build the resulting filter. In other words, if SupportsAudio and SupportsVideo are both true, the picker will display Audio-only devices, video-only devices, and audio/video devices.

Gets the casting sources supported.

The list of supported casting sources.

Gets and sets whether the devices in the device picker should support audio playback.

If true, the picker will show audio-capable casting devices.

Gets and sets whether the devices in the device picker should support rending still images.

If true, the picker will show casting devices capable of rendering still images.

Gets and sets whether the devices in the device picker should support video playback.

If true, the picker will show video-capable casting devices.

Represents the event arguments for the CastingDeviceSelected event on the CastingDevicePicker object.

Represents the CastingDevice that has been selected by the user in a casting device picker.

The casting device that the user has selected.

Indicates the capabilities of a particular casting device.

The casting device supports audio playback.

The casting device does not support playback.

The casting device supports image playback.

The casting device supports video playback.

Represents the media content that can be sent to another device.

Gets or sets an alternative URI for the content for use with DLNA ByRef.

The alternative URI for the content.

Specifies the color of closed caption UI elements.

Black

Blue

Cyan

The default color.

Green

Magenta

Red

White

Yellow

Specifies the edge effect of closed caption text.

The default edge effect.

Depressed edge.

Drop shadow.

No edge effect.

Raised edge.

Uniform edge

Specifies the opacity of closed caption text.

Default opacity.

100% opaque.

75% opaque.

25% opaque.

Completely transparent.

Exposes properties for retrieving the closed caption formatting settings that the user can set through the system's closed captioning settings page.

Gets the background color of lines of closed caption text.

The background color of lines of closed caption text.

Gets the background opacity of lines of closed caption text.

The background opacity of lines of closed caption text.

Gets the computed background color of lines of closed caption text.

The computed background color of lines of closed caption text.

Gets the computed font color for closed caption text.

The computed font color for closed caption text.

Gets the computed region color for closed caption text.

The computed region color for closed caption text.

Gets the font color for closed caption text.

The font color for closed caption text.

Gets the font effect for closed caption text.

The font effect for closed caption text.

Gets the font opacity for closed caption text.

The font opacity for closed caption text.

Gets the font size for closed caption text.

The font size for closed caption text.

Gets the font style for closed caption text.

The font style for closed caption text.

Gets the region color for closed caption text.

The region color for closed caption text.

Gets the region opacity for closed caption text.

The region opacity for closed caption text.

Specifies the size of closed caption text.

Default text size.

50% text size.

150% text size.

100% text size.

200% text size.

Specifies the style of closed caption text.

Casual.

Cursive.

The default style.

Monospaced without serifs

Monospaced with serifs.

Proportional without serifs.

Proportional with serifs.

Small capitals.

Specifies how the content is treated, based on the user's content settings.

Can be shown in the content catalog and consumed.

Can be shown in the content catalog, but will be blocked by RequestContentAccessAsync.

Can't be shown in the content catalog. It's rating is higher than the user's settings, determined by MaxBrowsableAgeRating.

(Xbox only) If multiple users are logged in and the content is blocked for at least one user, content is allowed with a warning displayed.

Contains information used to filter an app's content catalog.

Gets the region of the user's content restrictions.

A String, representing the geographic region.

Gets the maximum allowed age rating level to show in a content catalog. No content rated above this level should be displayed. For example, if the **MaxBrowsableAgeRating** is 13, MPAA:R rated movies should not be displayed.

An integer, that represents an age.

Gets the maximum allowed rating level for content consumption.

An integer that represents the rating level.

Specifies the type of a piece of content.

Apps on Windows 8.1 and Xbox.

Apps on Windows 8.1 and Xbox.

In-app content for Windows 8.1 and Xbox apps.

In-app content for Windows 8.1 and Xbox apps.

In-app content for Windows 8.1 and Xbox apps.

In-app content for Windows 8.1 and Xbox apps.

Contains information about a piece of content. An app creates a **RatedContentDescription** object, for each piece of content to be used in the GetRestrictionLevelAsync and RequestContentAccessAsync methods.

Initializes a new instance of the **RatedContentDescription** class.

The ID of the content, as specified by the app developer. The title of the content. Specifies the type of a piece of content, defined by RatedContentCategory.

Specifies the type of a piece of content, defined by RatedContentCategory.

Specifies the type of a piece of content, defined by RatedContentCategory.

The unique content ID of a piece of content, in the app's content catalog.

The ID of the content as a string.

The thumbnail image associated with the content.

An image associated with the content.

Provides all existing third-party and Microsoft Store age ratings for a piece of content.

Specifies the age rating, for a piece of content.

The display title of a piece of content.

The title of the content as a string. Read/Write.

Contains all behavior and functionality related to a user's Family Safety content settings.

Initializes a new instance of the **RatedContentRestrictions** class.

Initializes a new instance of the **RatedContentRestrictions** class, with the specified age rating the app uses, to restrict content usage.

The max age rating.

An event handler to notify apps when there are changes to the user's content settings.

Gets information that is used filter an app's content catalog.

Returns a ContentRestrictionsBrowsePolicy object.

Gets the policy that applies to a piece of content, for content browsing and consumption.

The rated content info. This method returns these values:

Determines whether the user is allowed to consume a piece of content.

The rated content info. Returns true, if the user can consume the content. Otherwise, returns false.

Represents arguments for a CurrentSessionChanged event.

Represents a playback session from another app providing info about that session and possibly allowing control.

Gets the App user model Id of the source app of the session.

The app user model id.

Occurs when the session's MediaProperties have changed.

Occurs when the session's playback info has changed.

Occurs when the timeline properties of this session change.

Gets the GlobalSystemMediaTransportControlsSessionPlaybackInfo for this session, accurate to the time of the call.

The current playback info for this session.

Gets the GlobalSystemMediaTransportControlsSessionTimelineProperties instance that represents this sessions timeline state.

The object representing the timeline property values.

Attempts to change the MediaPlaybackAutoRepeatMode on the session.

The requested auto repeat mode. Bool indicating success.

Attempts to change the channel down on the session.

True indicates success; False otherwise

Attempts to change the channel up on the session.

True indicates success; False otherwise

Attempts to change the playback position on the session to the requested value.

The requested playback position to seek to. True indicates success; False otherwise

Attempts to change the playback rate on the session to the requested value.

The requested playback rate to change to True indicates success; False otherwise

Attempts to change whether the session is actively shuffling or not.

The requested shuffle state to switch to. True indicates success; False otherwise

Attempts to put the session into a FastForward state.

True indicates success; False otherwise

Attempts to get the media properties for this session.

GlobalSystemMediaTransportControlsSessionMediaProperties instance representing the session's current media item.

Attempts to request the session to pause.

True indicates success; False otherwise

Attempts to request the session to start playback.

True indicates success; False otherwise

Attempts to request that the session starts recording.

True indicates success; False otherwise

Attempts to request the session to rewind.

True indicates success; False otherwise

Attempts to request the session to skip next.

True indicates success; False otherwise

Attempts to request the session to skip previous.

True indicates success; False otherwise

Attempts to request the session to stop playback.

True indicates success; False otherwise

Attempts to request the session to start or pause playback, based on its current playback state.

True indicates success; False otherwise

Provides access to playback sessions throughout the system that have integrated with SystemMediaTransportControls to provide playback info and allow remote control.

Occurs when the current session has changed. This is the session that the system believes is the one the user would most likely want to control.

Occurs when the list of available sessions has changed due to a new session connecting or an existing one disconnecting.

Gets the current session. This is the session the system believes the user would most likely want to control.

A session object that represents this remote session.

Gets all of the available sessions.

A vector of all available sessions.

Requests an instance of the GlobalSystemMediaTransportControlsSessionManager.

A new instance of the Session Manager.

Holds information about the content that the current session has.

Gets the album's artist

The name of the album artist.

Gets the title of the album.

The title of the album.

Gets the total number of tracks on the album.

The total number of tracks on the album.

Gets the Artist's name.

The Artist name.

Gets the list of genres.

A list of all strings representing the genres.

The playback type of the content

The type of media.

Gets the subtitle.

The subtitle of the media.

A reference to a RandomAccessStream of the thumbnail image associated with this content.

The thumbnail image.

Gets the title.

The title.

The number associated with this track

The track number.

An object that describes what controls a session currently has enabled.

Whether the session currently supports ChannelDown.

True if channel down is supported; otherwise, false.

Whether the session currently supports ChannelUp.

True if channel up is supported; otherwise, false.

Whether the session currently supports the fast forward command.

True if fast forward is supported; otherwise, false.

Whether the session currently supports the next command.

True if next is supported; otherwise, false.

Whether the session currently supports the pause command.

True if pause is supported; otherwise, false.

Whether the session currently supports changing the playback position.

True if playback position is supported; otherwise, false.

Whether the session currently supports changing the playback rate.

True if playback rate is supported; otherwise, false.

Whether the session currently supports the Play command.

True if play is supported; otherwise, false.

Whether the session currently supports the play pause toggle command (where play or pause is picked depending on state).

True if play pause toggle is supported; otherwise, false.

Whether the session currently supports the previous command.

True if previous is supported; otherwise, false.

Whether the session currently supports the record command.

True if record is supported; otherwise, false.

Whether the session currently supports control of its repeat mode.

True if repeat mode is supported; otherwise, false.

Whether the session currently supports the rewind command.

True if rewind is supported; otherwise, false.

Gets a value indicating whether the session currently allows control of its shuffle state.

True if shuffle control is supported; otherwise, false.

Whether the session currently supports the stop command.

True if stop is supported; otherwise, false.

The object that holds all of the playback information about a session (Play state, Controls, playback type etc.)

Specifies the repeat mode of the session.

A value representing the current auto-repeat mode.

Specifies which controls the session has enabled.

A GlobalSystemMediaTransportControlsSessionPlaybackControls object.

Specifies whether the session is currently playing content in a shuffled order or not.

True if the session is currently shuffling; otherwise, false.

The rate at which playback is happening.

A value indicating the playback rate, 1 being normal playback.

The current playback state of the session.

The playback status.

Specifies what type of content the session has.

The playback type.

The different states of playback the session could be in.

The media is changing.

The media is closed.

The media is opened.

The media is paused.

The media is playing.

The media is stopped.

Represents the timeline state of the session (Position, seek ranges etc.).

The end timestamp of the current media item.

A value representing the end time of the current media item.

The UTC time at which the timeline properties were last updated.

A value representing the last time the timeline properties were updated.

The furthest timestamp at which the content can currently seek to.

A value representing the max seek time of the current media item.

The earliest timestamp at which the current media item can currently seek to.

A value representing the min seek time of the current media item.

The playback position, current as of LastUpdatedTime.

A value representing the playback position of the current media item.

The starting timestamp of the current media item.

A value representing the start time of the current media item.

Represents arguments for a MediaPropertiesChanged event.

Represents arguments for a PlaybackInfoChanged event.

Represents arguments for a SessionsChanged event.

Represents arguments for a TimelinePropertiesChanged event.

Specifies the type of degredation, if any, applied to an AudioTrack by the audio decoder.

The audio track is downmixed from the number of channels in the encoding to two channels.

The audio track is downmixed from the number of channels in the encoding to six channels.

The audio track is downmixed from the number of channels in the encoding to eight channels.

The audio track is not degraded and is played as encoded.

Specifies the reason that the audio decoder degraded an AudioTrack.

The audio track was degraded due to a licensing requirement.

No reason is specified or no audio degradation has been applied to the track.

The audio track was degraded because the device does not support spatial audio.

Represents a description an audio media stream.

Creates an instance of AudioStreamDescriptor class using the specified AudioEncodingProperties.

The encoding properties for the audio stream. This includes information such as the sample rate and channel count of the stream.

Gets an object describing the encoding properties for the audio stream. These properties include the sample rate and channel count of the audio.

The encoding properties on the audio stream.

Gets a value indicating whether the stream is currently in use by a MediaStreamSource.

**true** if the stream is currently in use by a MediaStreamSource; otherwise, **false**.

Gets or sets an app-defined label that identifies an audio stream in a MediaEncodingProfile that contains multiple streams.

An app-defined label that identifies an audio stream

Gets or sets the RFC-1766 language code for the stream.

The RFC-1766 language code for the stream.

Gets or sets the number of samples inserted at the beginning of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream.

The number of samples inserted at the beginning of the audio stream by the encoder as padding.

Gets or sets the name of the stream.

The name of the stream.

Gets or sets the number of samples inserted at the end of the audio stream by the encoder as padding. Use this property to explicitly set the padding size the system will use to implement gapless playback for the audio stream.

The number of samples inserted at the end of the audio stream by the encoder as padding.

Creates a copy of the AudioStreamDescriptor.

A copy of the AudioStreamDescriptor.

Represents an audio track.

Gets the identifier for the audio track.

The identifier for the audio track.

Gets or sets the label for the audio track.

The label for the audio track.

Gets a string indicating the language of the audio track.

A string indicating the language of the audio track.

Gets the name of the AudioTrack.

The name of the AudioTrack.

Gets the MediaPlaybackItem containing the AudioTrack.

The MediaPlaybackItem containing the AudioTrack.

Gets support information for the AudioTrack. This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the MediaSource with which the audio track is associated.

The support information for the AudioTrack.

Gets a value indicating the type of data the track contains. For AudioTrack objects, this value is always MediaTrackKind.Audio.

A value indicating the type of data the track contains.

Occurs when an AudioTrack fails to open.

Gets the audio encoding properties for an AudioTrack.

The audio encoding properties of the AudioTrack.

Provides data for the OpenFailed event of an AudioTrack.

Gets the extended error code for an error that occurs when opening an AudioTrack.

The extended error code for an error that occurs when opening an AudioTrack.

Provides support information for an AudioTrack. This information includes the status of the audio decoder, information about any audio degradation applied by the decoder, and the status of the MediaSource with which the audio track is associated.

Gets the status of the audio decoder that is decoding the AudioTrack, including whether the encoding for the audio track is fully or partially supported and whether the decoder will degrade the audio.

The status of the audio decoder that is decoding the AudioTrack.

Gets a value indicating the type of degradation, if any, that is applied to the AudioTrack by the audio decoder.

The type of degradation, if any, that is applied to the AudioTrack by the audio decoder.

Gets a value indicating the reason that the audio decoder is degrading the AudioTrack, if the audio is degraded.

The reason that the audio decoder is degrading the **AudioTrack**.

Gets the status of the MediaSource with which the AudioTrack is associated.

The status of the MediaSource with which the AudioTrack is associated.

Represents a chapter cue that can be included in a TimedMetadataTrack.

Initializes a new instance of the **ChapterCue** class.

Gets or sets a value that specifies the duration of the chapter associated with the cue.

A value that specifies the duration of the chapter.

Gets the identifier for the timed metadata track.

The identifier for the timed metadata track.

Gets the start time of the cue.

The start time of the cue.

Gets the title of the chapter associated with the cue.

The title of the chapter

Specifies the category of a codec.

The codec is a decoder.

The codec is an encoder.

Provides information about a media codec that is installed on the system.

Gets a value that specifies whether the codec is an encoder or a decoder.

A value that specifies whether the codec is an encoder or a decoder.

Gets the friendly display name for the codec.

The friendly display name for the codec.

Gets a value that indicates whether the codec runs in your app's process space rather than in a separate app service.

True if the codec is runs in the app process space; false if the codec runs in a separate app service.

Gets a value specifying whether the codec operates on audio or video data.

A value specifying whether the codec operates on audio or video data.

Gets a read-only list of values that specify the media subtypes supported by the codec.

A read-only list of values that specify the media subtypes supported by the codec.

Specifies whether a codec operates on audio or video data.

The codec operates on audio data.

The codec operates on video data.

Provides the FindAllAsync method which allows you to enumerate all media codecs installed on the system.

Initializes a new instance of the **CodecQuery** class.

Returns a read-only list of all media codecs installed on the system that meet the specified requirements.

A value that specifies whether the method should return codecs that operate on video or audio data. A value that specifies whether the method should return codecs that are encoders or decoders. A value specifying the media encoding subtype that all returned codecs must support. This value can be a string representation of one of the subtype GUIDs listed in Audio Subtype GUIDs or Video Subtyp GUIDs. The CodecSubtypes class provides properties for most supported media subtypes that return the string representation of the subtype GUID. You can also specify a FOURCC code for this parameter. For more information, see FOURCC Codes.

Provides properties for most supported media subtypes that return the string representation of the GUID for the subtype. Use these property values to filter a query performed with CodecQuery.FindAllAsync. You can also compare the values returned by these properties to the values in the Subtypes collection of a CodecInfo object to determine if a codec supports a particular media subtype.

Gets the string representation of the GUID for the Advanced Audio Coding (AAC) audio subtype.

The string representation of the GUID for the Advanced Audio Coding (AAC) audio subtype.

Gets the string representation of the GUID for the Audio Data Transport Stream (ADTS) audio subtype.

Tne string representation of the GUID for the Audio Data Transport Stream (ADTS) audio subtype.

Gets the string representation of the GUID for the Apple Lossless Audio Codec (ALAC) audio subtype.

The string representation of the GUID for the Apple Lossless Audio Codec (ALAC) audio subtype.

Gets the string representation of the GUID for the Adaptive Multi-Rate (AMR-NB) audio subtype.

The string representation of the GUID for the Adaptive Multi-Rate (AMR-NB) audio subtype.

Gets the string representation of the GUID for the Adaptive Multi-Rate Wideband (AMR-WB) audio subtype.

The string representation of the GUID for the Adaptive Multi-Rate Wideband (AMR-WB) audio subtype.

Gets the string representation of the GUID for the Adaptive Multi-Rate (AMR-WP) audio subtype.

The string representation of the GUID for the Adaptive Multi-Rate (AMR-WP) audio subtype.

Gets the string representation of the GUID for the Dolby Digital Audio Coding 3 (AC-3) audio subtype.

The string representation of the GUID for the Dolby Digital Audio Coding 3 (AC-3) audio subtype.

Gets the string representation of the GUID for the Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF) audio subtype.

The string representation of the GUID for the Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF) audio subtype.

Gets the string representation of the GUID for the Dolby Digital Plus (DD Plus) audio subtype.

The string representation of the GUID for the Dolby Digital Plus (DD Plus) audio subtype.

Gets the string representation of the GUID for the encrypted audio data used with secure audio path audio subtype.

The string representation of the GUID for the encrypted audio data used with secure audio path audio subtype.

Gets the string representation of the GUID for the Digital Theater Systems (DTS) audio subtype.

The string representation of the GUID for the Digital Theater Systems (DTS) audio subtype.

Gets the string representation of the GUID for the Free Lossless Audio Codec (FLAC) audio subtype.

The string representation of the GUID for the Free Lossless Audio Codec (FLAC) audio subtype.

Gets the string representation of the GUID for the uncompressed IEEE floating-point audio subtype.

The string representation of the GUID for the uncompressed IEEE floating-point audio subtype.

Gets the string representation of the GUID for the MPEG Audio Layer-3 (MP3) audio subtype.

The string representation of the GUID for the MPEG Audio Layer-3 (MP3) audio subtype.

Gets the string representation of the GUID for the MPEG-1 audio subtype.

The string representation of the GUID for the MPEG-1 audio subtype.

Gets the string representation of the GUID for the Windows Media Audio 9 Voice codec audio subtype.

The string representation of the GUID for the Windows Media Audio 9 Voice codec audio subtype.

Gets the string representation of the GUID for the Opus audio subtype.

The string representation of the GUID for the Opus audio subtype.

Gets the string representation of the GUID for the uncompressed PCM audio subtype.

The string representation of the GUID for the uncompressed PCM audio subtype.

Gets the string representation of the GUID for the Windows Media Audio 9 Professional codec over S/PDIF audio subtype.

The string representation of the GUID for the Windows Media Audio 9 Professional codec over S/PDIF audio subtype.

Gets the string representation of the GUID for the Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 audio subtype.

The string representation of the GUID for the Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 Lossless codec audio subtype.

Gets the string representation of the GUID for the Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec audio subtype.

The string representation of the GUID for the Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec audio subtype.

Gets the string representation of the GUID for the Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec audio subtype.

The string representation of the GUID for the Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec audio subtype.

Gets the string representation of the GUID for the 8-bit per channel planar YUV 4:2:0 video subtype.

The string representation of the GUID for the 8-bit per channel planar YUV 4:2:0 video subtype.

Gets the string representation of the GUID for the DVCPRO 25 (525-60 or 625-50) video subtype.

The string representation of the GUID for the DVCPRO 25 (525-60 or 625-50) video subtype.

Gets the string representation of the GUID for the DVCPRO 50 (525-60 or 625-50) video subtype.

The string representation of the GUID for the DVCPRO 50 (525-60 or 625-50) video subtype.

Gets the string representation of the GUID for the DVC/DV Video video subtype.

The string representation of the GUID for the DVC/DV Video video subtype.

Gets the string representation of the GUID for the DVCPRO 100 (1080/60i, 1080/50i, or 720/60P) video subtype.

The string representation of the GUID for the DVCPRO 100 (1080/60i, 1080/50i, or 720/60P) video subtype.

Gets the string representation of the GUID for the HD-DVCR (1125-60 or 1250-50) video subtype.

The string representation of the GUID for the HD-DVCR (1125-60 or 1250-50) video subtype.

Gets the string representation of the GUID for the SDL-DVCR (525-60 or 625-50) video subtype.

The string representation of the GUID for the SDL-DVCR (525-60 or 625-50) video subtype.

Gets the string representation of the GUID for the SD-DVCR (525-60 or 625-50) video subtype.

The string representation of the GUID for the SD-DVCR (525-60 or 625-50) video subtype.

Gets the string representation of the GUID for the H.263 video subtype.

The string representation of the GUID for the H.263 video subtype.

Gets the string representation of the GUID for the H.264 video subtype.

The string representation of the GUID for the H.264 video subtype.

Gets the string representation of the GUID for the H.264 elementary stream video subtype.

The string representation of the GUID for the H.264 elementary stream video subtype.

Gets the string representation of the GUID for the H.265 video subtype.

The string representation of the GUID for the H.265 video subtype.

Gets the string representation of the GUID for the High Efficiency Video Coding (HEVC) Main profile and Main Still Picture profile video subtype.

The string representation of the GUID for the High Efficiency Video Coding (HEVC) Main profile and Main Still Picture profile video subtype.

Gets the string representation of the GUID for the High Efficiency Video Coding Elementary Stream (HEVC-ES) profile video subtype.

The string representation of the GUID for the High Efficiency Video Coding Elementary Stream (HEVC-ES) profile video subtype.

Gets the string representation of the GUID for the MPEG-4 part 2 video subtype.

The string representation of the GUID for the MPEG-4 part 2 video subtype.

Gets the string representation of the GUID for the Motion JPEG video subtype.

The string representation of the GUID for the Motion JPEG video subtype.

Gets the string representation of the GUID for the Microsoft MPEG 4 codec version 3 video subtype.

The string representation of the GUID for the Microsoft MPEG 4 codec version 3 video subtype.

Gets the string representation of the GUID for the ISO MPEG 4 codec version 1 video subtype.

The string representation of the GUID for the ISO MPEG 4 codec version 1 video subtype.

Gets the string representation of the GUID for the MPEG-4 part 2 video subtype.

The string representation of the GUID for the MPEG-4 part 2 video subtype.

Gets the string representation of the GUID for the MPEG-2 video subtype.

The string representation of the GUID for the MPEG-2 video subtype.

Gets the string representation of the GUID for the MPEG-1 video subtype.

The string representation of the GUID for the MPEG-1 video subtype.

Gets the string representation of the GUID for the Windows Media Screen codec version 1 video subtype.

The string representation of the GUID for the Windows Media Screen codec version 1 video subtype.

Gets the string representation of the GUID for the Windows Media Video 9 Screen codec video subtype.

The string representation of the GUID for the Windows Media Video 9 Screen codec video subtype.

Gets the string representation of the GUID for the VP8 video subtype.

The string representation of the GUID for the VP8 video subtype.

Gets the string representation of the GUID for the VP9 video subtype.

The string representation of the GUID for the VP9 video subtype.

Gets the string representation of the GUID for the Windows Media Video codec version 7 video subtype.

The string representation of the GUID for the Windows Media Video codec version 7 video subtype.

Gets the string representation of the GUID for the Windows Media Video 8 video subtype.

The string representation of the GUID for the Windows Media Video 8 video subtype.

Gets the string representation of the GUID for the Windows Media Video 9 video subtype.

The string representation of the GUID for the Windows Media Video 9 video subtype.

Gets the string representation of the GUID for the SMPTE 421M (VC-1). video subtype.

The string representation of the GUID for the SMPTE 421M (VC-1). video subtype.

Represents a data cue that can be included in a TimedMetadataTrack.

Initializes a new instance of the DataCue class.

Gets the data associated with the cue.

The data associated with the cue.

Gets or sets the duration of the cue.

The duration of the cue.

Gets the identifier for the data cue.

The identifier for the data cue.

Gets the collection of custom properties associated with the data cue.

The collection of custom properties associated with the data cue.

Gets the start time of the cue.

The start time of the cue.

Provides data for the FaceDetected event.

Gets the FaceDetectionEffectFrame associated with a FaceDetected event.

The FaceDetectionEffectFrame associated with a FaceDetected event.

Represents an effect that attempts to detect faces in a video stream.

Gets or sets the time span for which face detection should be performed.

The time span for which face detection should be performed.

Gets or sets a value indicating whether face detection is enabled.

True if face detection is enabled; otherwise, false.

Occurs when a face is detected. See FaceDetectedEventArgs.

Sets properties on the IMediaExtension.

The property set.

Represents the definition of a face detection video effect.

Initializes a new instance of the FaceDetectionEffectDefinition class.

Gets a string containing the activatable class ID of the face detection effect definition.

The activatable class ID of the face detection effect definition.

Gets or sets a value that prioritizes the speed of face detection and the quality of detection results.

A value that prioritizes the speed of face detection and the quality of detection results.

Gets the set of properties for configuring the FaceDetectionEffectDefinition object.

The set of properties for configuring the FaceDetectionEffectDefinition object.

Gets or sets a value indicating whether synchronous face detection is enabled.

True if synchronous face detection is enabled; otherwise, false.

Represents a video frame that includes a list of faces detected by the FaceDetectionEffect.

Gets the list of objects representing the faces detected in the frame.

The list of objects representing the faces detected in the frame. For more information, see DetectedFace.

Gets or sets the duration of the face detection effect frame.

The duration of the face detection effect frame.

Gets the extended property set which enables getting and setting properties on the media frame.

The extended properties map.

Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream.

True if the video frame is the first frame after a gap in the stream; otherwise, false.

Gets a value indicating whether the frame is read-only.

True if the frame is read-only; otherwise, false.

Gets or sets the relative time of the frame within the video stream.

The relative time of the frame within the video stream.

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system.

Gets a string indicating the type of data the frame contains.

A string indicating the type of data the frame contains.

Disposes of the object and associated resources.

Specifies the mode used for face detection.

The prioritization of detection speed and result quality are balanced.

The speed of face detection is prioritized over the accuracy of the face detection results.

The accuracy of face detection results is prioritized over the speed of face detection.

Provides the ability to enable and disable High Dynamic Range (HDR) analysis for the SceneAnalysisEffect.

Gets or sets a value that specifies whether High Dynamic Range (HDR) analysis is enabled for the SceneAnalysisEffect.

True if HDR analysis is enabled; otherwise, false.

Provides the results of a High Dynamic Range (HDR) analysis operation from the SceneAnalysisEffect.

Gets a value indicating the certainty of the results of the HDR analysis.

A value indicating the certainty of the results of the HDR analysis where 1 is full certainty and 0 is no certainty.

Gets a set of FrameController objects representing the suggested frame controllers settings for capturing a variable photo sequence with the High Dynamic Range (HDR) technique.

A set of FrameController objects representing the suggested frame controllers settings.

Represents a image cue that can be included in a TimedMetadataTrack.

Initializes a new instance of the **ImageCue** class.

Gets or sets the duration of the cue.

The duration of the cue.

Gets or sets the extent of the **ImageCue**, which is the rendered size of the assoociated image either in pixels or in percentage of available space.

The extent of the **ImageCue**

Gets the identifier for the timed metadata track.

The identifier for the timed metadata track.

Gets or sets the position of the image associated with the **ImageCue**, relative to the top left corner of the video frame.

The position of the image associated with the **ImageCue**

Gets or sets the image associated with the image cue.

The image associated with the image cue.

Gets the start time of the cue.

The start time of the cue.

Defines the interface implemented by all media cues.

Gets or sets the duration of the media cue.

The duration of the media cue.

Gets or sets the identifier for the media cue.

The identifier for the media cue.

Gets or sets the start time of the media cue.

The start time of the media cue.

Represents a media source that delivers media samples to a media pipeline.

Defines an interface implemented by a audio or video stream descriptor.

Specifies whether the stream is currently in use by the MediaStreamSource.

**true** if the stream is currently in use by the MediaStreamSource; otherwise, **false**.

Gets or sets the RFC-1766 language code for the stream.

The RFC-1766 language code for the stream.

Gets or sets the name of the stream.

The name of the stream.

Defines an interface implemented by a audio or video stream descriptor.

Gets or sets an app-defined label that identifies a stream in a MediaEncodingProfile that contains multiple streams.

An app-defined label that identifies a stream.

Defines the interface implemented by media tracks.

Gets the identifier of the media track.

The identifier of the media track.

Gets or sets the label for the media track.

The label for the media track.

Gets a string indicating the language of the media track.

A string indicating the language of the media track.

Gets a value indicating the type of data the track contains.

A value indicating the type of data the track contains.

Provides data for the InitializeMediaStreamSourceRequested event.

Gets the IRandomAccessStream associated with the media stream source request.

The **IRandomAccessStream** associated with the media stream source request.

Gets the uninitialized MediaStreamSource object that the app service should initialize and use to provide samples to the requesting app.

The uninitialized **MediaStreamSource** object.

Gets a Deferral object that instructs the system to wait for the app service to complete media source stream initialization before continuing processing the request.

A **Deferral** object.

Represents a media track list that allows a single item to be selected at a time.

Gets or set the currently selected media track in the list.

The currently selected media track in the list.

Occurs when the SelectedIndex property changes.

Defines the interface implemented by a custom stream that provides metadata tracks.

Gets the list of timed metadata tracks provided by the object that implements this interface.

The list of timed metadata tracks provided by the object that implements this interface.

This class allows you to submit a set of image frames, captured in low-light settings and in close temporal proximity, and receieve a single image that has been processed to improve image lighting and fidelity.

Gets the maximum number of frames that can be submitted to the **FuseAsync** method.

The maximum number of frames that can be submitted to the **FuseAsync** method.

Gets a list of BitmapPixelFormat values that define the supported pixel formats for the **FuseAsync** method.

A list of supported pixel formats.

Asynchronously fuses a set of images into a single image that has been computed to improve image lighting and fidelity.

The collection of image frames to be processed. An asynchronous operation that returns a **LowLightFusionResult** upon successful completion. The app should call **Close** on the returned object to free up the allocated resources.

Represents the result of a low-light fusion operation initiated with a call to **FuseAsync**.

Gets the image containing the processed result of the low-light fusion operation.

The image containing the processed result of the low-light fusion operation.

Disposes of the object and associated resources.

Enables deferred binding of media content associated with a MediaSource.

Initializes a new instance of the MediaBinder class.

Gets the MediaSource object associated with the MediaBinder.

The MediaSource object associated with the MediaBinder.

Gets or sets an app-specified string that is used to identify the media content that the app should bind when the Binding event is raised.

An app-specified string that is used to identify the specific media content that the app should bind.

Occurs when a media player is ready for the media content to be bound to a MediaSource. Use the handler for this to set the media content for the source by calling SetStream, SetStreamReference, or SetUri.

Provides data for the Binding event and methods for binding media content to the associated MediaSource.

Gets the MediaBinder associated with the binding event.

The MediaBinder associated with the binding event.

Occurs when the binding operation is cancelled.

Informs the system that the app might continue to perform work after the Binding event handler returns.

The requested deferral.

Binds an adaptive media source to the MediaSource associated with the event.

The AdaptiveMediaSource representing the media content.

Binds a DownloadOperation to the MediaSource associated with the event.

The **DownloadOperation** to bind to the **MediaSource**.

Binds a storage file to the MediaSource associated with the event.

The StorageFile containing media content.

Sets the media content to be bound to the MediaSource.

A stream containing the media content. A string specifying the content type of the media content.

Binds a media content stream reference to the MediaSource associated with the event.

A stream reference containing the media content to be bound. A string specifying the content type of the media content.

Sets the URI of the media content to be bound to the MediaSource.

The URI of the media content to be bound.

Provides data for the TimedMetadataTrack.CueEntered and TimedMetadataTrack.CueExited events.

Gets the cue that triggered the event.

The cue that triggered the event.

Specifies the status of a media decoder when decoding a media item.

The media item can be decoded by the decoder, but with a degradation from the encoding.

The encoding of the media item is fully supported by the decoder.

The media item uses encoding properties that are not supported by the decoder.

The encoding subtype of the media item is not supported by the decoder.

Represents a media source. Provides a common way to reference media from different sources and exposes a common model for accessing media data regardless of the underlying media format.

Gets the AdaptiveMediaSource associated with the **MediaSource**.

The AdaptiveMediaSource associated with the **MediaSource**.

Gets a set of properties that can be used to associate app-specific data with a MediaSource.

A set of properties that can be used to associate app-specific data with a MediaSource.

Retrieves the DownloadOperation with which the **MediaSource** is associated

Gets the duration of the content in the MediaSource.

The duration of the content in the MediaSource.

A collection of external timed metadata tracks associated with the MediaSource.

The collection of external timed metadata tracks.

A collection of external timed text sources associated with the MediaSource.

The collection of external timed text sources.

Gets a value indicating whether the media source is currently open.

True if the media source is open; otherwise, false.

Gets the MediaStreamSource associated with the **MediaSource**.

The MediaStreamSource associated with the **MediaSource**.

Gets the MseStreamSource associated with the **MediaSource**.

The MseStreamSource associated with the **MediaSource**.

Gets the current state of the MediaSource.

The current state of the MediaSource.

Gets the URI associated with the **MediaSource**.

The URI associated with the **MediaSource**.

Occurs when a MediaSource open operation completes.

Occurs when the current state of the MediaSource changes.

Closes the MediaSource.

Creates an instance of MediaSource from the provided AdaptiveMediaSource.

The AdaptiveMediaSource from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided DownloadOperation.

The DownloadOperation from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided IMediaSource.

The IMediaSource from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided MediaBinder.

The MediaBinder with which the **MediaSource** is associated. The new media source.

Creates an instance of MediaSource from the provided AdaptiveMediaSource.

The AdaptiveMediaSource from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided MediaStreamSource.

The MediaStreamSource from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided MseStreamSource.

The MediaStreamSource from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided IStorageFile.

The IStorageFile from which the MediaSource is created. The new media source.

Creates an instance of MediaSource from the provided IRandomAccessStream.

The stream from which the MediaSource is created. The MIME type of the contents of the stream. The new media source.

Creates an instance of MediaSource from the provided IRandomAccessStreamReference.

The stream reference from which the MediaSource is created. The MIME type of the contents of the stream. The new media source.

Creates an instance of MediaSource from the provided Uri.

The URI from which the MediaSource is created. The new media source.

opens the backing data source for the **MediaSource** and reads the metadata and track information.

An asynchronous action.

Resets the internal state of the MediaSource.

Enables the implementation of an app service that provides a custom media source that can be consumed by UWP apps.

Initializes a new instance of the **MediaSourceAppServiceConnection** class.

An AppServiceConnection object representing the connection to the endpoint for an app service.

Raised by the system to request the initialization of a new MediaStreamSource.

Notifies the system that the app service is ready to receive media stream source requests.

Represents an error that occurred with a MediaSource.

Gets the extended error code for the MediaSourceError.

The extended error code for the MediaSourceError.

Provides data for the MediaSource.MediaSourceOpenOperationCompleted event.

Represents the error that occurred while asynchronously opening the MediaSource.

The error that occurred while asynchronously opening the MediaSource.

Specifies the state of a MediaSource.

The **MediaSource** has been closed.

The **MediaSource** failed to open the associated media content.

The **MediaSource** has been initialized.

The **MediaSource** has successfully opened the associated media content.

The **MediaSource** is in the process of opening the associated media content.

Provides data for the StateChanged event of a MediaSource object.

Gets the new current state of the MediaSource.

The new current state of the MediaSource.

Gets the previous state of the MediaSource before the state changed.

The previous state of the MediaSource before the state changed.

Specifies the status of a MediaSource when opening media items associated with the source.

The MediaSource is fully supported.

The MediaSource status is unknown.

Represents a media sample used by the MediaStreamSource.

Gets the buffer which encapsulates the MediaStreamSample data.

The buffer.

Gets and sets the decode timestamp for this MediaStreamSample.

The decode timestamp.

Gets the IDirect3DSurface which encapsulates the MediaStreamSample data.

The surface.

Gets or sets a value to indicate that the previous MediaStreamSample in the sequence is missing.

**true** if the previous MediaStreamSample in the sequence is missing; otherwise, **false**. The default value is **false**.

Gets the duration of the sample.

The duration of the sample.

Gets the extended property set which enables getting and setting properties on the MediaStreamSample.

The extended properties map.

Gets or sets a value that indicates the MediaStreamSample contains a keyframe.

**true** if the MediaStreamSample contains a frame that can be decoded independently from other frames; otherwise, **false**. The default value is **false**.

Gets a MediaStreamSampleProtectionProperties object, which is used for getting and setting properties that are specific to the Digital Rights Management (DRM) protection of the MediaStreamSample.

A collection of properties that are specific to the Digital Rights Management (DRM) protection of the MediaStreamSample.

Gets the time at which a sample should be rendered. This is also referred to as the presentation time.

The time at which the MediaStreamSample should be rendered.

Occurs when the MediaStreamSample has been processed by the media pipeline.

Creates a MediaStreamSample from an [IBuffer](https://docs.microsoft.com/previous-versions/hh438362(v=vs.85)).

The buffer that contains the media data used to create the MediaStreamSample. The presentation time of this sample. The sample created from the data in *buffer*.

Creates a MediaStreamSample from an IDirect3DSurface.

The surface that contains the media data used to create the MediaStreamSample. The presentation time of this sample. The sample created from the data in *surface*.

Asynchronously creates a MediaStreamSample from an [IInputStream](https://docs.microsoft.com/previous-versions/hh438387(v=vs.85)).

The stream that contains the media data used to create the MediaStreamSample. The length of the data in the sample. This is the number of bytes that will be read from *stream*. The presentation time of this MediaStreamSample. When this method completes, it returns the new file as a MediaStreamSample.

Contains properties for the MediaStreamSample.

Gets the number of items contained in the property set.

The number of items in the property set.

Removes all items from the property set.

Returns an iterator to enumerate the items in the property set.

The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty.

Gets an immutable view of the property set.

The immutable view.

Indicates if the specified key exists in the property set.

The key to check. **true** if the key exists; otherwise, **false**.

Adds the specified key and value to the property set.

The key to add. The value of the key. **True** if the method replaces a value that already exists for the *key*; **false** if this is a new key.

Retrieves the value for the specified key.

The key to retrieve the value for. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the property set.

The key to remove.

Represents a collection properties that are specific to the Digital Rights Management (DRM) protection of the MediaStreamSample.

Gets the Digital Rights Management (DRM) initialization vector from the MediaStreamSample.

The initialization vector.

Gets the Digital Rights Management (DRM) key identifier from the MediaStreamSample.

Receives the key identifier used to decrypt the data.

Gets the Digital Rights Management (DRM) sub-sample mapping from the MediaStreamSample.

Receives the sub-sample mapping.

Sets the Digital Rights Management (DRM) initialization vector for the MediaStreamSample.

The value to set the Digital Rights Management (DRM) initialization vector to.

Sets the Digital Rights Management (DRM) key identifier for the MediaStreamSample.

The value to set the Digital Rights Management (DRM) key identifier to.

Sets the Digital Rights Management (DRM) sub-sample mapping for the MediaStreamSample.

The value to set the Digital Rights Management (DRM) sub-sample mapping to.

Represents a media source that delivers media samples directly to the media pipeline.

Creates an instance of MediaStreamSource from the specified IMediaStreamDescriptor.

The AudioStreamDescriptor or VideoStreamDescriptor to create the MediaStreamSource from.

Creates an instance of MediaStreamSource from two IMediaStreamDescriptor objects.

The first AudioStreamDescriptor or VideoStreamDescriptor to create the MediaStreamSource from. The second AudioStreamDescriptor or VideoStreamDescriptor to create the MediaStreamSource from.

Gets or sets the amount of data that is buffered by the MediaStreamSource.

The duration of the buffer which corresponds to the number of MediaStreamSamples the MediaStreamSource requests. The default value is 3 seconds.

Gets or sets whether or not the application supports changing its position in the media time-line.

**true** if the application supports changing its position in the media time-line; otherwise, **false**. The default value is **false**.

Gets or sets the duration of the media time-line.

The duration of the media time-line. The default value is 0.

Gets or sets a value indicating whether the media content being processed is live.

True if the media content is live; otherwise false.

Gets the maxiumum supported playback rate for the **MediaStreamSource**.

The maxiumum supported playback rate for the **MediaStreamSource**.

Gets or sets the Digital Rights Management (DRM)MediaProtectionManager used to protect the media.

The media protection manager.

Gets the music properties which are used for music-related metadata.

The music properties.

Gets or sets the thumbnail which is a reference to a stream for a video thumbnail image or music album art.

The reference to the thumbnail stream.

Gets the video properties which are used for video related metadata.

The video properties.

Occurs when the MediaStreamSource is shutting down.

Occurs when the MediaStreamSource is paused and stops requesting MediaStreamSample objects for an unspecified period of time, but is expected to resume requesting MediaStreamSample objects from the current position.

Occurs when a sample from the MediaStreamSource is rendered.

Occurs when the MediaStreamSource request a MediaStreamSample for a specified stream.

Occurs when the MediaStreamSource is ready to start requesting MediaStreamSample objects. The event can specify a position in the media time-line from which the first MediaStreamSample should be delivered.

Occurs when the MediaStreamSource will stop requesting MediaStreamSample objects for a certain stream and will start requesting MediaStreamSample objects from a different stream instead.

Adds a Digital Rights Management (DRM) protection key which is used by the MediaProtectionManager to encrypt and decrypt the specified stream.

The stream the key is used to encrypt and decrypt. The key used to encrypt and decrypt the stream. The Digital Rights Management (DRM) licence for the media.

Adds a new stream descriptor to the MediaStreamSource.

The descriptor to add.

Notifies the MediaStreamSource that an error has occurred which is preventing the application from continuing to deliver data to the MediaStreamSource.

The cause of the error.

Sets the range of data that the application is currently buffering.

The smallest time stamp of a MediaStreamSample buffered by the application. The largest time stamp of a MediaStreamSample buffered by the application.

Provides data for the MediaStreamSource.Closed event.

Gets the object that represents the notification that the MediaStreamSource has been closed.

Provides information regarding why the MediaStreamSource was closed.

Specifies the reason why a MediaStreamSource was closed.

The app reported an error by calling the NotifyError method on the MediaStreamSource.

No error has occurred.

The MediaStreamSource object does not have an event handler for the SampleRequested event.

A failure occurred while initializing the protection system

An unspecified error has occurred.

One or more media streams use an encoding format which cannot be handled by the media pipeline.

Components needed to implement the protection system are missing.

Represents an object to be used by the MediaStreamSource.closed event to provide information to the application.

Gets the reason why the media stream source was closed.

The reason why the media stream source was closed.

Specifies errors related to MediaStreamSource.

The network connection to the server was lost.

The application encountered an error while attempting to decode the media data.

The application failed to connect to a streaming media server or web server.

The application failed to open a file

An unspecified error has occurred in the application.

The application ran out of memory.

An unspecified network related error has occurred.

The application does not support the media storage format or media encoding format.

Provides data for the MediaStreamSource.SampleRendered event, which occurs when a sample from a MediaStreamSource is rendered. Use SampleLag property to determine if there is a lag in the rendering of a sample, in which case you may decide to switch to a lower-bandwidth stream.

Gets a time span representing the lag with which a sample was rendered.

The lag with which a sample was rendered.

Represents an object to be used by the MediaStreamSource.SampleRequest event to provide information to the application.

Sets the MediaStreamSample requested by the MediaStreamSource. Applications deliver a MediaStreamSample to the MediaStreamSource by assigning a value to this property.

The sample which is delivered to the MediaStreamSource when this property is set. The default value is **null**.

Gets the IMediaStreamDescriptor interface of the stream for which a MediaStreamSample is being requested.

The stream for which the MediaStreamSample is being requested.

Defers assigning a MediaStreamSample to MediaStreamSourceSampleRequest object.

The deferral.

Provides a status update to the MediaStreamSource while the application is temporarily unable to deliver a requested MediaStreamSample.

A value between 0 to 100 that indicates the progress towards being able to deliver the requested MediaStreamSample.

Provides a way for the application to asynchronously report that it has completed retrieving the MediaStreamSample.

Reports that the application has completed retrieving the MediaStreamSample.

Provides the data for the SampleRequested event.

Gets the object that represents the request for a MediaStreamSample.

Provides information regrading the request for a MediaStreamSample.

Provides data for the MediaStreamSource.Starting event.

Gets the object that represents the request to start accumulating MediaStreamSample data.

Provides information regrading the request to start accumulating MediaStreamSample data.

Represents a request from the MediaStreamSource.Starting event for the application to start accumulating MediaStreamSample objects from a specific position in the media.

Specifies a reference to a TimeSpan object which represents a time position in the media time-line from which the application should return MediaStreamSample objects.

A reference that points to a TimeSpan which specifies the position in the media time-line to start sending MediaStreamSample objects. If the reference is **null**, the application should continue to return MediaStreamSample objects from the current position.

Defers completing the MediaStreamSource.Starting event.

The deferral.

Specifies the starting position in the media time-line for subsequent MediaStreamSamples that will be delivered to the MediaStreamSource.

The actual starting point in the media time-line chosen by the application.

Provides a way for the application to asynchronously report that it has completed processing the MediaStreamSource.Starting event.

Reports that the application has completed processing the Starting event.

Represents an object to be used by the MediaStreamSource.SwitchStreamsRequest event to provide information to the application.

Gets the stream descriptor for the stream that is now selected by the MediaStreamSource.

The selected stream.

Gets the stream descriptor for the stream which is no longer selected by the MediaStreamSource.

The previously selected stream.

Defers completing the MediaStreamSource.SwitchStreamsRequested event.

The deferral.

Provides a way for the application to asynchronously report that it has completed the MediaStreamSource.SwitchStreamsRequested event.

Reports that the application has completed processing the MediaStreamSource.SwitchStreamsRequested event.

Provides data for the MediaStreamSource.SwitchStreamsRequested event.

Gets the object that represents the request to switch the streams.

Provides information regrading the request to switch the streams.

Specifies the type of a media track.

The track is an audio track.

The track is a timed metadata track.

The track is a video track.

Specifies how a MseSourceBuffer object appends a buffer.

Append in segments.

Append sequentially.

Specifies the status at the end of stream.

End of stream had a decode error.

End of stream had a network error.

End of stream was successful.

End of stream had an unknown error.

Specifies the ready state of a MseStreamSource object.

The MseStreamSource is closed.

The MseStreamSource is ended.

The MseStreamSource is open.

Represents a media source extensions (MSE) source buffer.

Gets and sets the append-window-end interval.

The interval value.

Gets and sets the append-window-start interval.

The interval value.

Gets how the MseSourceBuffer object is buffered.

The buffered value in terms of a MseTimeRange.

Gets a value indicating whether the buffer is updating.

True if the buffer is updating; otherwise, false.

Gets and sets how the MseSourceBuffer object appends a buffer.

A MseAppendMode -typed value that specifies how MseSourceBuffer appends a buffer.

Gets and sets the timestamp offset into the MseSourceBuffer object.

The timestamp offset value.

Occurs when the MseSourceBuffer is aborted.

Occurs when the MseSourceBuffer has an error.

Occurs when the MseSourceBuffer is updated.

Occurs when the MseSourceBuffer update has ended.

Occurs when the MseSourceBuffer update is starting.

Aborts media source extensions (MSE) source buffer.

Appends a buffer to the MseSourceBuffer object.

The buffer to append.

Appends a stream to the MseSourceBuffer object.

The stream to append.

Appends a stream to the MseSourceBuffer object.

The stream to append. The maximum size of the stream.

Removes media for the specified time range.

The start of the time range to remove. The end of the time range to remove.

Represents a list of media source extensions (MSE) source buffers.

Gets the list of MseSourceBuffer objects.

The list of MseSourceBuffer.

Occurs when a MseSourceBuffer object is added.

Occurs when a MseSourceBuffer object is removed.

Represents a media source extensions (MSE) stream source.

Instantiates a new instance of an uninitialized MseStreamSource.

Gets the list of media source extensions (MSE) source buffers that are active on the stream source.

The list of MSE source buffers that are active.

Gets and sets the duration of the stream source.

The duration of the stream source.

Gets or sets the seekable time range for a Media Source Extension.

The time range within which the user can seek during media playback.

Gets a value that specifies the ready state of the MseStreamSource.

A MseReadyState -typed value that specifies the ready state of the MseStreamSource.

Gets the list of media source extensions (MSE) source buffers on the stream source.

The list of MSE source buffers.

Occurs when the MseStreamSource is closed.

Occurs when the MseStreamSource is ended.

Occurs when the MseStreamSource is opened.

Adds a source buffer to the stream source.

A string that describes the source buffer's MIME type. The MseSourceBuffer object for the source buffer added.

Specifies the status at the end of stream.

A MseEndOfStreamStatus -typed value that specifies the status at the end of stream.

Specifies whether a content type is supported.

A string that describes the content type. **true** if the content type specified by *contentType* is supported; otherwise, **false**.

Removes a source buffer from the stream source.

The MseSourceBuffer object for the source buffer removed.

Describes the start and end of a time range.

The ending time interval expressed in 100-nanosecond units.

The starting time interval expressed in 100-nanosecond units.

Represents an effect that analyzes video frames to determine if any of the supported variable photo sequence capture techniques may produce a higher-quality captured image.

Gets or sets the duration of the time window during which video frames are analyzed.

The duration of the time window during which video frames are analyzed.

Gets a HighDynamicRangeControl object that is used to enable or disable High Dynamic Range (HDR) analysis.

A HighDynamicRangeControl object that is used to enable or disable High Dynamic Range (HDR) analysis.

Raised when the scene analysis is complete. See SceneAnalyzedEventArgs

Sets properties on the IMediaExtension.

The property set.

Represents the definition of a scene analysis video effect.

Initializes a new instance of the SceneAnalysisEffectDefinition class.

Gets a string containing the activatable class ID of the scene analysis effect definition.

The activatable class ID of the scene analysis effect definition.

Gets the set of properties for configuring the SceneAnalysisEffectDefinition object.

The set of properties for configuring the SceneAnalysisEffectDefinition object.

Represents a video frame that includes the results of the scene analysis operation.

Gets a value that specifies the recommended image processing to improve image quality and fidelity of captured images based on the current capture conditions.

A value from that specifies the recommended image processing.

Gets or sets the duration of the scene analysis effect frame.

The duration of the scene analysis effect frame.

Gets the extended property set which enables getting and setting properties on the media frame.

The extended properties map.

Gets a CapturedFrameControlValues object that indicates the capture settings used for the frame.

A CapturedFrameControlValues object that indicates the capture settings used for the frame.

Gets a HighDynamicRangeOutput object that provides recommended FrameController objects and a value indicating the certainty of the HDR analysis.

A HighDynamicRangeOutput object that provides the results of the HDR analysis.

Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream.

True if the video frame is the first frame after a gap in the stream; otherwise, false.

Gets a value indicating whether the frame is read-only.

True if the frame is read-only; otherwise, false.

Gets or sets the relative time of the frame within the video stream.

The relative time of the frame within the video stream.

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

A timestamp relative to the system.

Gets a string indicating the type of data the frame contains.

A string indicating the type of data the frame contains.

Disposes of the object and associated resources.

Specifies the recommended image processing to improve image quality and fidelity of captured images based on the current capture conditions, as determined by the SceneAnalysisEffect.

High Dynamic Range (HDR) processing is recommended.

Low-light processing is recommended.

No image processing is recommended.

Provides data for the SceneAnalysisEffect.SceneAnalyzed event.

Gets the result frame from the scene analysis operation.

The result frame from the scene analysis operation.

Represents a speech cue that can be included in a TimedMetadataTrack. This cue can be used to receive events based on metadata included in a text-to-speech (TTS) stream, such as word boundaries, sentence boundaries, and Speech Sythesis Markup Language (SSML) bookmarks.

Initializes a new instance of the **SpeechCue** class.

Gets or sets the duration of the cue.

The duration of the cue.

Gets or sets the offset into the string contained in the Text property of the last character in the word or sentence associated with the cue.

The offset into the string contained in the Text property of the last character in the word or sentence associated with the cue.

Gets the identifier for the timed metadata track

The identifier for the timed metadata track

Gets or sets the offset into the string contained in the Text property of the first character in the word or sentence associated with the cue.

The offset into the string contained in the Text property of the first character in the word or sentence associated with the cue.

Gets the start time of the cue.

The start time of the cue.

Gets or sets the text associated with the speech cue.

The text associated with the speech cue.

Specifies the types of metadata that may be present in a TimedMetadataTrack.

The metadata contains caption text.

The metadata contains chapter information.

The metadata contains custom data.

The metadata contains data.

The metadata contains description text.

The metadata contains images to be used as subtitles.

The metadata contains speech metadata, such as word boundaries, sentence boundaries, and Speech Sythesis Markup Language (SSML) bookmarks.

The metadata contains subtitle text.

Represents a description a timed metada media stream.

Creates an instance of the TimedMetadataStreamDescriptor class using the specified TimedMetadataEncodingProperties.

The encoding properties for the timed metadata stream.

Gets an object describing the encoding properties for the timed metadata stream.

The encoding properties on the timed metadata stream.

Gets a value indicating whether the stream is currently in use by a MediaStreamSource.

**true** if the stream is currently in use by a MediaStreamSource; otherwise, **false**.

Gets or sets an app-defined label that identifies a timed metadata stream in a MediaEncodingProfile that contains multiple streams.

An app-defined label that identifies a timed metadata stream.

Gets or sets the RFC-1766 language code for the stream.

The RFC-1766 language code for the stream.

Gets or sets the name of the stream.

The name of the stream.

Creates a copy of the TimedMetadataStreamDescriptor.

A copy of the TimedMetadataStreamDescriptor.

Represents a timed metadata track. The track contains a list of IMediaCue objects and raises events at the beginning and end of the time window of each cue.

Initializes a new instance of the TimedMetadataTrack class.

An identifier for the new timed metadata track. A string indicating the language of the new timed metadata track. A value indicating the kind of metadata contained in the new track.

Gets the list of media cues in the TimedMetadataTrack that are currently active. A cue is considered active after its StartTime has been reached until its Duration has been exceeded.

The list of media cues in the TimedMetadataTrack that are currently active.

Gets a read-only list of the media cues in the TimedMetadataTrack.

A read-only list of the media cues in the timed metadata track.

Gets the custom string value containing routing information for cues.

The custom string value containing routing information for cues.

Gets the identifier for the timed metadata track.

The identifier for the track.

Gets or sets the label for the timed metadata track.

The label for the timed metadata track.

Gets a string indicating the language of the timed metadata track.

A string indicating the language of the timed metadata track.

Gets the name of the TimedMetadataTrack.

The name of the TimedMetadataTrack.

Gets the MediaPlaybackItem containing the TimedMetadataTrack.

The MediaPlaybackItem containing the TimedMetadataTrack.

Gets a value indicating the kind of metadata contained in the track.

A value indicating the kind of metadata contained in the track.

Gets a value specifying the type of the media track. For TimedMetadataTrack this value will always be MediaTrackKind.TimedMetadata.

A value specifying the type of the media track.

Occurs when a media time window of a media cue is entered. The time window is defined by the StartTime and Duration of the cue.

Occurs when a media time window of a media cue is exited. The time window is defined by the StartTime and Duration of the cue.

Raised when an error occurs with the TimedMetadataTrack.

Adds the specified media cue to the TimedMetadataTrack.

The media cue to add.

Removes the specified media cue from the TimedMetadataTrack.

The media cue to remove.

Provides information about an error that occurred with a timed metadata track.

Gets the error code associated with the timed metadata track error.

The error code associated with the timed metadata track error.

Gets the extended error code for the TimedMetadataTrackError.

The extended error code for the TimedMetadataTrackError.

Specifies the type of error that occurred with a TimedMetadataTrack.

The error was related to the format of the timed metadata track data.

The error occurred internal to the system.

A network error occurred.

No error code.

Provides data for the TimedMetadataTrack.TrackFailed event.

Gets an object representing the error that occurred with the timed metadata track.

An object representing the error that occurred with the timed metadata track.

Represents a text cue in a TimedMetadataTrack.

Initializes a new instance of the TimedTextCue class.

Gets or sets the TimedTextRegion of the cue, which defines the style of the rendering area for the cue.

The TimedTextRegion of the cue

Gets or sets the TimedTextStyle of the cue, which defines the style of the rendered text.

The TimedTextStyle of the cue

Gets or sets the duration of the cue.

The duration of the cue.

Gets or sets an identifier for the cue.

An identifier for the cue.

Gets the collection of TimedTextLine objects that convey the text of the cue.

A collection of TimedTextLine objects.

Gets the start time of the cue.

The start time of the cue.

Specifies the alignment of a TimedTextRegion relative to the video frame.

The text region is aligned in the direction of the end of the text.

The text region is aligned in the direction of the start of the text.

The text region is aligned in the center.

Represents a floating point value that is used to convey the values of timed text style properties.

The units of the value, either pixels or percentage.

The value.

Specifies the direction timed text is flowed.

Text is flowed left to right.

Text is flowed right to left.

Specifies the font styles that can be used for the display timed text.

The timed text uses italic font style.

The timed text uses normal font style.

The timed text uses oblique font style.

Represents a line of text that is displayed with a TimedTextCue.

Initializes a new instance of the TimedTextLine class.

Gets a list of TimedTextSubformat objects that provide formatting for substrings within the TimedTextLine.

A list of TimedTextSubformat objects that provide formatting for substrings within the timed text line.

Gets or sets the text content of the TimedTextLine.

The text content of the TimedTextLine.

Specifies the alignment of a TimedTextLine relative to the TimedTextRegion in which it is displayed.

The text line is aligned in the center of the region.

The text line is aligned in the direction of the end of the text.

The text line is aligned in the direction of the start of the text.

Represents the size of padding around a timed text region.

The padding after the timed text region.

The padding before the timed text region.

The padding towards the end of the timed text.

The padding towards the start of the timed text.

The units in which the other members of the structure are expressed.

Represents 2D coordinate that is used to convey the values of timed text style properties.

The units of the coordinates, either pixels or percentage.

The X coordinate of the point.

The Y coordinate of the point.

Exposes properties for customizing the appearance of the rendering area of a TimedTextCue.

Initializes a new instance of the TimedTextRegion class.

Gets or sets the background color of the TimedTextRegion.

The background color of the TimedTextRegion.

Gets or sets the display alignment of the TimedTextRegion.

The display alignment of the TimedTextRegion.

Gets or sets the extent of the TimedTextRegion, which is the rendered size of the region either in pixels or in percentage of available space.

The extent of the TimedTextRegion.

Gets or sets a value indicating whether text overflowing the region is clipped.

True if overflowing text is clipped; otherwise, false.

Gets or sets a value that indicates the height of each line of content.

A value that indicates the height of each line of content.

Gets or sets a string representing the name of the TimedTextRegion.

The name of the TimedTextRegion.

Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a TimedTextRegion.

A value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a TimedTextRegion.

Gets or sets the position of the TimedTextRegion, relative to the top left corner of the video frame.

The position of the TimedTextRegion

Gets a value indicating the method in which lines of text scroll through the region.

A value indicating the method in which lines of text scroll through the region.

Gets or sets a value indicating whether text wraps when it reaches the edge of the TimedTextRegion.

A value indicating whether text wraps when it reaches the edge of the region.

Gets or sets a value indicating the direction that text flows within the TimedTextRegion.

A value indicating the direction that text flows within the region.

Gets or sets the Z-order of the TimedTextRegion, relative to other active regions on the screen, in case they overlap.

The Z-order of the TimedTextRegion.

Specifies the method in which lines of text scroll through the region.

Text lines pop on to the region discretely.

Text lines roll up onto the region.

Represents a size that is used to convey the values of timed text style properties.

The height.

The units of the size, either pixels or percentage.

The width.

Represents a source of timed text data.

Occurs when the TimedTextSource is resolved.

Creates a new instance of TimedTextSource from the provided stream.

The stream from which the timed text source is created. The new timed text source.

Creates a new instance of TimedTextSource with the specified default language from the provided stream.

The stream from which the timed text source is created. A string specifying the default language for the timed text source. The new timed text source.

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index streams.

A stream containing the image data for image-based subtitles. A stream containing the index data for image-based subtitles. The new timed text source.

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index streams and sets the default language.

A stream containing the image data for image-based subtitles. A stream containing the index data for image-based subtitles. A string indicating the default language for the timed text source. The new timed text source.

Creates a new instance of TimedTextSource from the provided URI.

The URI from which the timed text source is created. The new timed text source.

Creates a new instance of TimedTextSource with the specified default language from the provided URI.

The URI from which the timed text source is created. A string specifying the default language for the timed text source. The new timed text source.

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index URIs.

The URI of the image data from which the timed text source is created. The URI of the index data from which the timed text source is created. The new timed text source.

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index URIs and sets the default language.

The URI of the image data from which the timed text source is created. The URI of the index data from which the timed text source is created. A string indicating the default language for the timed text source. The new timed text source.

Provides data for the TimedTextSource.Resolved event.

Gets an object representing the asynchronous error that occurred when the TimedTextSource was resolved.

An object representing the asynchronous error that occurred when the TimedTextSource was resolved.

Gets the list of TimedMetadataTrack objects resulting from resolving the TimedTextSource.

The list of TimedMetadataTrack objects.

Defines the style of the rendered text in a TimedTextCue. You can set the style of a substring within a TimedTextLine by using the Subformats property.

Initializes a new instance of the TimedTextStyle class.

Gets or sets the background color of timed text.

The background color of timed text.

Gets or sets a value indicating the direction that timed text is flowed.

A value indicating the direction that the timed text is flows.

Gets or sets the font family of timed text.

The font family of timed text.

Gets or sets the font size of timed text.

The font size of timed text.

Gets or sets a value that specifies the font style of timed text.

A value that specifies the font style of timed text.

Gets or sets the weight of timed text.

The weight of timed text.

Gets or sets the color of the timed text glyphs.

The color of the timed text glyphs.

Gets or sets a value indicating if the background color stays visible when no text is being displayed.

A value indicating if the background color stays visible when no text is being displayed.

Gets or sets a value indicating whether strikethrough text is enabled for the timed text.

True if strikethrough text is enabled; otherwise, false.

Gets or sets a value indicating whether overline text is enabled for the timed text.

True if overline text is enabled; otherwise, false.

Gets or sets a value indicating whether underline text is enabled for the timed text.

True if underline text is enabled; otherwise, false.

Gets or sets the alignment of timed text lines.

The alignment of timed text lines.

Gets or sets the name of the timed text style.

The name of the timed text style.

Gets or sets the outline color of timed text.

The outline color of timed text.

Gets or sets the radius of the blur applied to outline of the timed text.

The radius of the blur applied to outline of the timed text.

Gets or sets the thickness of the outline of the timed text.

The thickness of the outline of the timed text.

Defines a TimedTextStyle for a substring in a TimedTextLine. of the cue, which defines the style of the rendered text.

Initializes a new instance of the TimedTextSubformat class.

Gets or sets the length of the substring to which the SubformatStyle applies.

The length of the substring to which the formatting style applies.

Gets or sets the staring index of the substring to which the SubformatStyle applies.

The starting index of the substring to which the formatting style applies.

Gets or sets the TimedTextStyle object that conveys the formatting of a substring in a TimedTextLine.

The object that conveys the formatting of a substring in a TimedTextLine.

Specifies the units in which timed a timed text style value is expressed.

The style value is expressed as a percentage.

The style value is expressed in pixels.

Specifies the weight of timed text.

The text is bold.

The text is normal weight.

Specifies the wrapping behavior of timed text.

The text is not wrapped.

The text is wrapped.

Specifies the direction timed text is written.

Text is written from left to right within a line. Lines are written top to bottom.

Text is written from left to right within a line. Lines are written top to bottom.

Text is written from right to left within a line. Lines are written top to bottom.

Text is written from right to left within a line. Lines are written top to bottom.

Text is written from top to bottom within a line. Lines are written left to right.

Text is written from top to bottom within a line. Lines are written left to right.

Text is written from top to bottom within a line. Lines are written right to left.

Represents an effect that stabilizes a video stream.

Gets or sets a value indicating whether video stabilization is enabled.

True if video stabilization is enabled; otherwise, false.

Occurs when the value of the VideoStabilizationEffect.Enabled property changes.

Gets the recommended video stream configuration for video stabilization, given the specified video device controller and encoding properties.

The video device controller. The encoding properties. An object representing the optimal video stream configuration for video stabilization.

Sets properties on the IMediaExtension.

The property set.

Represents the definition of a video stabilization effect.

Initializes a new instance of the VideoStabilizationEffectDefinition class.

Gets a string containing the activatable class ID of the video stabilization effect definition.

The activatable class ID of the video stabilization detection effect definition

Gets the set of properties for configuring the VideoStabilizationEffectDefinition object.

The set of properties for configuring the VideoStabilizationEffectDefinition object.

Provides data for the VideoStabilizationEffect.EnabledChanged event.

Gets a value indicating the reason why the VideoStabilizationEffect.Enabled property changed.

A value indicating the reason why the VideoStabilizationEffect.Enabled property changed.

Specifies the reason why the VideoStabilizationEffect.Enabled property changed.

The pixel rate of the video stream was too high.

The value was changed programmatically from app code.

The video stabilization effect was running slowly.

Represents a description a video media stream.

Creates an instance of the VideoStreamDescriptor class using the specified VideoEncodingProperties.

The encoding properties for the video stream. This includes information such as the resolution and frame rate of the content.

Gets an object describing the encoding properties for the video stream. These properties include the resolution and frame rate of the video.

The encoding properties on the video stream.

Gets a value indicating whether the stream is currently in use by a MediaStreamSource.

**true** if the stream is currently in use by a MediaStreamSource; otherwise, **false**.

Gets or sets an app-defined label that identifies a video stream in a MediaEncodingProfile that contains multiple streams.

An app-defined label that identifies a video stream.

Gets or sets the RFC-1766 language code for the stream.

The RFC-1766 language code for the stream.

Gets or sets the name of the stream.

The name of the stream.

Creates a copy of the Windows.Media.Core.VideoStreamDescriptor.

A copy of the Windows.Media.Core.VideoStreamDescriptor.

Represents a video track.

Gets the identifier for the video track.

The identifier for the video track.

Gets or sets the label for the video track.

The label for the video track.

Gets a string indicating the language of the video track.

A string indicating the language of the video track.

Gets the name of the VideoTrack.

The name of the VideoTrack.

Gets the MediaPlaybackItem containing the VideoTrack.

The MediaPlaybackItem containing the VideoTrack.

Gets support information for the VideoTrack. This information includes the status of the video decoder and the status of the MediaSource with which the video track is associated.

The support information for the VideoTrack.

Gets a value indicating the type of data the track contains. For VideoTrack objects, this value is always MediaTrackKind.Video.

A value indicating the type of data the track contains.

Occurs when a VideoTrack fails to open.

Gets the encoding properties for the VideoTrack.

The encoding properties for the VideoTrack.

Provides data for the OpenFailed event of a VideoTrack.

Gets the extended error code for an error that occurs when opening a VideoTrack.

The extended error code for an error that occurs when opening a VideoTrack.

Provides support information for a VideoTrack. This information includes the status of the video decoder and the status of the MediaSource with which the video track is associated.

Gets the status of the video decoder that is decoding the VideoTrack, including whether the encoding for the video track is fully or partially supported.

The status of the video decoder that is decoding the VideoTrack.

Gets the status of the MediaSource with which the VideoTrack is associated.

The status of the MediaSource with which the VideoTrack is associated.

Provides information about how the app's current sound level is affected by system policy.

Gets the current sound level of the app.

The current sound level of the app.

Occurs when the system policy changes the sound level of the app.

Represents settings for an AdvancedPhotoControl object.

Initializes a new instance of the AdvancedPhotoCaptureSettings class.

Gets or sets the advanced capture mode for which an AdvancedPhotoControl will be configured.

The advanced capture mode for which an AdvancedPhotoControl will be configured.

Provides functionality for controlling the advanced photo capture behavior on a capture device.

Gets the current advanced capture mode of the AdvancedPhotoControl.

The current advanced capture mode of the AdvancedPhotoControl.

Gets a value indicating whether the AdvancedPhotoControl is supported on the current capture device.

True if the AdvancedPhotoControl is supported; otherwise, false.

Gets a list of the advanced capture modes supported by the current capture device.

A list of the advanced capture modes supported by the current capture device.

Configures the AdvancedPhotoControl object with the specified settings.

The object defining the configuration settings.

Defines the advanced photo capture modes.

The system dynamically determines the advanced photo capture mode.

High Dynamic Range (HDR) capture mode.

Low light capture mode.

Standard capture mode.

Controls device settings on the microphone.

Mutes or unmutes the microphone.

True if the microphone is muted; false otherwise.

Gets or sets the volume of the microphone.

The volume of the microphone. The value ranges from 0.0 (silent) to 100.0 (full volume).

Gets a list of the supported encoding properties for the device.

The type of media stream for which to get the properties. A list of the supported encoding properties.

Gets the encoding properties for the specified media stream type for the device.

The type of media stream for which to get the properties. The encoding properties.

Sets the encoding properties asynchronously for the specified media stream type for the device.

The type of media stream for which to set the properties. The encoding properties to set. An IAsyncAction object that is used to control the asynchronous operation.

Represents a single audio device module, which may be a hardware effect processing unit or any other audio configuration module defined by an audio driver.

Gets the GUID identifier of the module, which is defined by the audio device module owner.

The GUID identifier of the module

Gets the friendly name of the audio device module for display in UI.

The friendly name of the audio device module.

Gets an identifier, defined by the driver developer, that disambiguates between multiple instances of the same module class in the driver topology.

An identifier that disambiguates between multiple instances of the same module class in the driver topology.

Gets the major version of the audio device module.

The major version of the audio device module.

Gets the minor version of the audio device module.

The minor version of the audio device module.

Asynchronously sends data to the audio device module and receives the result.

A buffer containing the command data to send to the audio device module. An asynchronous operation the returns a ModuleCommandResult upon successful completion.

Provides data for the AudioDeviceModulesManager.ModuleNotificationReceived event which is raised when audio device module changes occur.

Gets the audio device module that triggered the change event.

The audio device module that triggered the change event.

Gets a buffer containing data that identifies the change that occurred in the module. This data is defined by the module developer.

Manages the collections of audio device modules for a audio device pin instance or for a particular audio endpoint.

Gets an instance of the **AudioDeviceModulesManager** class for the specified audio device ID.

The identifier of the audio device for which the **AudioDeviceModulesManager** is retrieved.

Occurs when a change occurs in one of the audio device modules associated with the audio device for which the **AudioDeviceModulesManager** was initialized.

Retreives a list of all audio device modules associated with the audio device for which the **AudioDeviceModulesManager** was initialized.

A list of all audio device modules.

Retrieves a list of all audio device modules with the specified ID. Each audio device module in the list will have the same ID, but each will have a different value for the AudioDeviceModule.InstanceId property.

The identifier of the audio device modules to be retrieved. A list of all audio device modules with the specified ID.

Indicates the role of an audio device.

The audio device is used for communications.

The audio device is used in the default role.

Defines the options for auto focus range.

Full range.

Macro.

Normal range.

Defines the state of a camera stream.

Frames in the stream are being dropped for privacy reasons.

The camera stream is not currently streaming.

The camera stream has been shut down.

The camera stream is currently streaming.

Defines the possible capture scene modes.

Indicates that the best settings and exposure optimization are automatically performed.

Indicates that the captured framed is optimized for photos that are backlit.

Indicates that the captured framed is optimized for beach photos.

Indicates that the captured framed is optimized for candlelight photos.

Indicates that the captured framed is optimized for photos of landscape.

Indicates that the captured framed is optimized for macro photos.

Indicates that no optimization is performed on the captured frame.

Indicates that the captured framed is optimized for night photos

Indicates that the captured framed is optimized for low-light portrait photos.

Indicates that the captured framed is optimized for portrait photos.

Indicates that the captured framed is optimized for photos that include snow.

Indicates that the captured framed is optimized for sports photos.

Indicates that the captured framed is optimized for sunset photos.

Defines the values for the primary use of the capture device.

The capture device does not have a primary use.

The capture device is used primarily for photos.

The capture device is used primarily for video.

Defines the values for the possible color temperature presets.

Indicates that the color temperature is set automatically.

Indicates that the color temperature is adjusted for a scene lit by candlelight.

Indicates that the color temperature is adjusted for a cloudy scene.

Indicates that the color temperature is adjusted for a daylight scene.

Indicates that the color temperature is adjusted for a scene lit by a flash.

Indicates that the color temperature is adjusted for a scene lit by fluorescent light.

Indicates that the color temperature is set manually.

Indicates that the color temperature is adjusted for a scene lit by tungsten light.

Contains information about a default audio capture device change event.

Gets the ID of the newly selected audio capture device that caused the change event.

ID of the newly selected audio capture device that caused the change event.

Gets the role of the newly selected audio capture device that caused the change event.

The role of the newly selected audio capture device that caused the change event.

Contains information about a default audio render device change event.

Gets the ID of the newly selected default audio render device that caused the change event.

ID of the newly selected default audio render device that caused the change event.

Gets the role of the newly selected default audio render device that caused the change event.

The role of the newly selected default audio render device that caused the change event.

Provides functionality for modifying exposure levels of captured photos.

Gets the maximum exposure time.

The maximum exposure time.

Gets the minimum exposure time.

The minimum exposure time.

Gets the smallest exposure compensation increment supported by the capture device.

The smallest exposure compensation increment.

Gets a value that specifies if the capture device supports the exposure compensation control.

**true** if the exposure compensation control is supported; otherwise, **false**.

Gets the exposure compensation level.

The exposure time.

Asynchronously sets the exposure compensation.

The exposure compensation level to set the Value property to. The minimum and maximum values are specified by Min and Max. The object that is used to control the asynchronous operation.

Provides functionality for controlling the exposure settings on a capture device.

Gets a value that indicates if auto exposure is enabled.

**true** if auto exposure is enabled; otherwise, **false**.

Gets the maximum exposure time.

The maximum exposure time.

Gets the minimum exposure time.

The minimum exposure time.

Gets the smallest exposure time increment supported by the capture device.

The smallest exposure time increment.

Gets a value that specifies if the capture device supports the exposure control.

**true** if the exposure control is supported; otherwise, **false**.

Gets the exposure time.

The exposure time.

Asynchronously enables or disable auto exposure.

Specifies whether or not to enable or disable auto exposure. The object that is used to control the asynchronous operation.

Asynchronously sets the exposure time.

The exposure time to set the Value property to. The minimum and maximum values are specified by Min and Max. The object that is used to control the asynchronous operation.

When supported, allows an app to specify whether the camera driver can dynamically adjust the frame rate of video capture in order to improve video quality in low-light conditions.

Gets or sets a value that specifies if ExposurePriorityVideoControl is enabled.

True if ExposurePriorityVideoControl is enabled; otherwise, false.

Gets or sets a value that specifies if ExposurePriorityVideoControl is supported on the current device.

True if the ExposurePriorityVideoControl is supported; otherwise, false.

Provides functionality for controlling the flash settings on a capture device.

Gets or sets a value indicating whether focus assist light is enabled on the capture device.

A value indicating whether focus assist light is enabled on the capture device.

Gets a value indicating whether focus assist light is supported by the capture device.

A value indicating whether focus assist light is supported by the capture device.

Gets or sets a value that specifies if flash is automatically set.

**true** if auto flash is set; otherwise, **false**.

Gets a value that specifies if the flash on the capture device is enabled or disabled.

**true** if the flash is enabled; otherwise, **false**.

Gets or sets the intensity of the flash.

The power percent the torch LED is set to.

Gets a value that specifics if the device allows the torch LED power settings to be changed.

**true** if the device allows the torch LED power settings to be changed; otherwise, **false**.

Gets a value that specifies if the red eye reduction is enabled or disabled.

**true** if red eye reduction is enabled; otherwise, **false**.

Gets a value that specifies if the capture device supports red eye reduction.

**true** if the capture device supports red eye reduction; otherwise, **false**.

Gets a value that specifies if the capture device supports the flash control.

**true** if the capture device supports the FlashControl; otherwise, **false**.

Provides functionality for controlling the focus settings on a capture device.

Gets a value that specifics if the capture device supports the FocusChanged event.

**true** if the focus changed event is supported; otherwise, **false**.

Gets a MediaCaptureFocusState value indicating the current focus state of the capture device.

A value indicating the current focus state of the capture device.

Gets the maximum focus length.

The maximum focus.

Gets the minimum focus length.

The minimum focus length.

Gets the capture device's current focus mode.

The capture device's current focus mode.

Gets the focus preset.

The focus preset.

Gets the smallest focus increment supported by the capture device.

The smallest focus increment.

Gets a value that specifies if the capture device supports the focus control.

**true** if the capture device supports the FocusControl; otherwise, **false**.

Gets a list of values indicating the manual focus distances that are supported by the capture device.

A list of values indicating the manual focus distances that are supported by the capture device.

Gets a list of values indicating the focus modes that are supported by the capture device.

A list of values indicating the focus modes that are supported by the capture device.

Gets a list of values indicating the auto focus ranges that are supported by the capture device.

A list of values indicating the auto focus ranges that are supported by the capture device.

Gets the focus presets that the capture device supports.

The supported focus presets.

Gets the current value that the focus is set to.

The value that the focus is set to. The minimum and maximum values for the focus are specified by Min and Max.

Gets a value that indicates whether WaitForFocus is supported by the capture device.

A value indicating whether WaitForFocus is supported by the capture device.

Configures the FocusControl object with values specified in the provided FocusSettings object.

The focus settings to use to configure the FocusControl object.

Asynchronously focuses the device.

The object that is used to control the asynchronous operation.

Locks the capture device's focus.

An asynchronous action.

Asynchronously sets the focus Preset.

The focus preset to set the Preset property to. The object that is used to control the asynchronous operation.

Asynchronously sets the focus Preset, specifying if the operation must complete before the device is focused.

The focus preset to set the Preset property to. Specifies if the asynchronous operation must complete before the device is focused. The object that is used to control the asynchronous operation.

Asynchronously sets the focus Value.

The value to set the focus to. The minimum and maximum values are specified by Min and Max. The object that is used to control the asynchronous operation.

Unlocks the capture device's focus if it has previously been locked with a call to LockAsync.

An asynchronous action.

Defines the values for focus mode.

Use autofocus.

Continuously adjust focus.

Use manual focus.

Focus once.

Defines the values for the possible focus presets.

Indicates that focus is automatically set by the capture.

Indicates that the capture device uses a hyperfocal autofocus range.

Indicates that the capture device uses an infinite autofocus range.

Indicates that the capture device uses a close autofocus range.

Indicates that the capture device uses a normal autofocus range.

Indicates that focus is manually set.

Represents settings for a FocusControl object.

Initializes a new instance of the FocusSettings class.

Gets or sets a value indicating the auto focus range setting.

A value indicating the auto focus range setting.

Gets or sets a value that indicates to the driver if it should disable determining a focus position when the focus search fails.

**true** if the driver should not determine a focus position if the focus search fails. **false** if the driver should determine a focus position if the focus search fails.

Gets or sets a value indicating the manual focus distance setting.

A value indicating the manual focus distance setting.

Gets or sets a value indicating the focus mode setting.

A value indicating the focus mode setting.

Gets or sets the focus value setting.

The focus value setting.

Gets or sets a value indicating whether the capture device should wait for focus before capturing.

A value indicating whether the capture device should wait for focus before capturing.

When supported, allows an app to enable High Dynamic Range (HDR) video recording on the capture device.

Gets or sets a value indicating the current High Dynamic Range (HDR) video recording mode of the capture device.

The current High Dynamic Range (HDR) video recording mode of the capture device.

Gets a value that indicates if the capture device supports the HdrVideoControl.

True if the HdrVideoControl is supported; otherwise, false.

Gets the list of HdrVideoMode values indicating the modes supported by the capture device.

The list of supported HdrVideoMode values.

Defines the High Dynamic Range (HDR) video modes.

The system dynamically enables HDR video capture when appropriate.

HDR video capture is disabled.

HDR video capture is enabled.

Called when the default audio device is changed for either audio render or capture.

Gets the ID of the newly selected audio device that raised the device change event.

ID of the newly selected audio device that raised the device change event.

Gets the role of the newly selected audio device that raised the device change event.

The role of the newly selected audio device that raised the device change event.

Controls device settings on a video camera or microphone.

Gets a list of the supported encoding properties for the device.

The type of media stream for which to get the properties. A list of the supported encoding properties.

Gets the encoding properties for the specified media stream type for the device.

The type of media stream for which to get the properties. The encoding properties.

Sets the encoding properties asynchronously for the specified media stream type for the device.

The type of media stream for which to set the properties. The encoding properties to set. An IAsyncAction object that is used to control the asynchronous operation.

Provides functionality for controlling the infrared torch LED settings on a capture device.

Gets the current operation mode of the infrared LED.

The current operation mode of the infrared LED.

Gets a value that indicates if the capture device supports the InfraredTorchControl.

**true** if the infrared control is supported; otherwise, **false**.

Gets the maximum infrared LED power value supported by the capture device.

The maximum infrared LED power value supported by the capture device.

Gets the minimum infrared LED power value supported by the capture device.

The minimum infrared LED power value supported by the capture device.

Gets or sets the current infrared LED power value.

The power value the infrared LED is set to.

Gets the supported power step value.

The supported power step value.

SupportedModes property is used to find out modes that the infrared LED supports.

Read-only list of supported InfraredTorchModes.

Defines the Infrared torch modes.

“AlternatingFrameIllumination” mode means that the infrared LED is on for every other frame.

“Off” mode means that the infrared LED is constantly off

“On” mode means that the infrared LED is constantly on

Provides functionality for controlling the ISO film speed settings on a capture device.

Gets a value indicating whether auto ISO speed is enabled.

A value indicating whether auto ISO speed is enabled.

Gets the maximum ISO speed supported by the capture device.

The maximum ISO speed supported by the capture device.

Gets the minimum ISO speed supported by the capture device.

The minimum ISO speed supported by the capture device.

Gets the ISO film speed preset.

The ISO speed preset.

Gets the smallest ISO speed increment supported by the capture device.

The smallest ISO speed increment supported by the capture device.

Gets a value the specifies if the capture device supports the ISO speed control.

**true** if the ISO control is supported; otherwise, **false**.

Gets the ISO presets that the capture device supports.

The supported ISO presets.

Gets the current ISO speed value.

The current ISO speed value.

Sets the ISO speed to automatic.

An asynchronous action.

Asynchronously sets the ISO film speed Preset.

SetPresetAsync may not be available in future versions of Windows Phone. Starting with Windows Phone 8.1, use SetAutoAsync, Auto, SetValueAsync, and Value instead The ISO preset value to set the Preset property to. The object that is used to control the asynchronous operation.

Sets the ISO speed value.

The ISO speed value. An asynchronous action.

Defines the possible values for ISO speed presets.

IsoSpeedPreset may not be available in future versions of Windows Phone. Starting with Windows Phone 8.1, use SetAutoAsync, Auto, SetValueAsync, and Value instead

The film speed is automatically set.

The film speed is set to 100 ISO.

The film speed is set to 12800 ISO.

The film speed is set to 1600 ISO.

The film speed is set to 200 ISO.

The film speed is set to 25600 ISO.

The film speed is set to 3200 ISO.

The film speed is set to 400 ISO.

The film speed is set to 50 ISO.

The film speed is set to 6400 ISO.

The film speed is set to 80 ISO.

The film speed is set to 800 ISO.

Provides functionality for managing the low shutter lag photo capture mode on the capture device.

Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height.

The desired thumbnail size.

Gets a value that specifies if hardware acceleration is supported for thumbnails.

**true** if hardware acceleration for thumbnails is supported; otherwise, **false**.

Gets a value that enables and disables thumbnail support.

**true** if thumbnails are enabled; otherwise, **false**.

Gets or sets the media format for the thumbnails.

The media format for the thumbnails.

Gets the current frame rate at which pictures can be taken.

The current frame rate.

Gets the highest frame rate supported when video and photos are being captured concurrently.

The media encoding properties. The highest concurrent frames per second.

Provides functionality for managing the low shutter lag photo sequence mode on the capture device.

Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height.

The desired thumbnail size.

Gets a value that specifies if hardware acceleration is supported for thumbnails in photo sequence mode.

**true** if hardware acceleration is supported for thumbnails in photo sequence mode; otherwise, **false**.

Gets the maximum number of past photos that can be stored.

The maximum number of past photos.

Gets the maximum number of photos that can be taken per second.

The maximum number of photos per second.

Gets or sets a value that specifies the number of past photos to store.

The number of past photos to store. To determine the maximum number of past photos that can be stored, check the MaxPastPhotos property.

Gets or sets the number of photos that are taken per second.

The number of photos taken per second.

Gets a value that specifies if the capture device supports low shutter lag photo sequence mode.

**true** if photo sequence mode is supported; otherwise, **false**.

Gets a value that enables and disables thumbnail support in photo sequence mode.

**true** if thumbnails are enabled; otherwise, **false**.

Gets or sets the media format for the thumbnails.

The media format for the thumbnails.

Gets the current frame rate at which pictures can be taken.

The current frame rate.

Gets the highest frame rate supported when video and photos sequences are being captured concurrently.

The media encoding properties. The highest concurrent frames per second.

Defines the options for manual focus distance.

Focus to the hyperfocal distance.

Focus to infinity.

Focus to the nearest distance.

Defines the different focus states the capture device can be in.

The attempt to focus has failed.

Focused.

The focus has been lost.

Searching for focus.

The focus state is uninitialized.

Defines the optimizations that the media capture device can use.

The default driver settings are used.

Low latency is prioritized.

Low latency is prioritized, with low power consumption prioritized second.

Low latency is prioritized, with high picture quality prioritized second.

Low power consumption is prioritized.

Low power consumption and high picture quality are prioritized.

High picture quality is prioritized.

Defines the behavior when media capture is paused with a call to PauseAsync or PauseRecordAsync.

The hardware resources are released while capturing is paused.

The calling app keeps control of the hardware resources, such as the camera, while capturing is paused.

Provides methods used to select devices for capturing and rendering audio, and for capturing video.

Raised when the default audio capture device is changed.

Raised when the default audio render device is changed.

Returns the identifier string of a device for capturing audio.

The identifier string of the audio capture device.

Returns the identifier string of a device for rendering audio.

The identifier string of the audio rendering device.

Returns the identifier string of the default device for capturing audio in the specified role.

The specified audio device role (console, media, or communications). The identifier string of the default device.

Returns the identifier string of the default device for rendering audio in the specified role.

The specified audio device role (console, media, or communications). The identifier string of the default device.

Returns the identifier string of a device for capturing video.

The identifier string of the video capture device.

Gets or sets a device setting on a camera.

Gets the capabilities of the camera for this camera setting.

The capabilities, including the supported range of values, the default value, and the step size.

Indicates whether automatic adjustment of the camera setting is enabled.

True if automatic adjustment is enabled; false otherwise. Returns true if the method succeeds, or false otherwise.

Gets the value of the camera setting.

The current value of the setting. The units depend on the setting. Returns true if the method succeeds, or false otherwise.

Enables or disables automatic adjustment of the camera setting.

True to enable automatic adjustment; or false to disable automatic adjustment. If false, call TrySetValue to adjust the setting. Returns true if the method succeeds, or false otherwise.

Sets the camera setting.

The new value of the camera setting. The units depend on the setting. Returns true if the method succeeds, or false otherwise.

Gets the capabilities of a camera setting.

Queries whether the camera supports automatic adjustment of the setting.

True if the camera supports automatic adjustment of the setting; otherwise false.

Gets the default value of the camera setting.

The default value.

Sets the maximum value of the camera setting.

The maximum value.

Gets the minimum value of the camera setting.

The minimum value.

Ges the step size for the setting. The step size is the smallest increment by which the property can change.

The step size.

Indicates whether the camera supports this camera setting.

True if the camera supports the setting; otherwise false.

Represents the result of an audio device module command, executed with a call to AudioDeviceModule.SendCommand.

Gets a buffer containing result of the audio device module command, defined by the audio device module developer.

A buffer containing result of the audio device module command.

Gets a value that specifies the status of the audio device module command.

A value that specifies the status of the audio device module command.

When supported, allows an app to enable optical image stabilization on the capture device.

Gets or sets a value indicating the current optical image stabilization mode of the capture device.

The current optical image stabilization mode of the capture device.

Gets a value that indicates if the capture device supports the OpticalImageStabilizationControl.

True if the OpticalImageStabilizationControl is supported; otherwise, false.

Gets the list of OpticalImageStabilizationMode values indicating the modes supported by the capture device.

The list of supported OpticalImageStabilizationMode values.

Defines the optical image stabilization modes.

The system dynamically enables optical image stabilization when appropriate.

Optical image stabilization is disabled.

Optical image stabilization is enabled.

When supported, allows an app to enable the capture device driver to optimize camera capture functionality based on the panel location of the camera.

Gets a value indicating whether photo confirmation is supported by the capture device.

A value indicating whether photo confirmation is supported by the capture device.

Gets or sets the panel on which the camera is located, allowing the camera driver to optimize capture based on the camera location.

A value from the Windows.Devices.Enumeration.Panel enumeration, indicating the location of the camera.

Provides functionality for controlling the photo confirmation settings on a capture device.

Gets or sets a value indicating whether photo confirmation is enabled.

A value indicating whether photo confirmation is enabled.

Gets or sets the desired pixel format for photo confirmation frames.

The desired pixel format for photo confirmation frames.

Gets a value indicating whether photo confirmation is supported by the capture device.

A value indicating whether photo confirmation is supported by the capture device.

Represents a region of interest which is a rectangular region on the image which is used for functions such as focus and exposure.

Creates a new instance of the RegionOfInterest control.

Gets or sets a value that specifies if auto exposure is enabled.

**true** if auto exposure is enabled; otherwise, **false**.

Gets or sets a value that specifies if auto focus is enabled.

**true** if auto focus is enabled; otherwise, **false**.

Gets or sets a value that specifies if auto white balance is enabled.

**true** if auto white balance; otherwise, **false**.

Gets or sets the rectangle that defines the region of focus.

The rectangle that defines the region of focus.

Gets or sets a value indicating whether the Bounds Rect is in pixels or is mapped to a range of 0 to 1.0.

A value indicating whether the Bounds Rect is in pixels or is mapped to a range of 0 to 1.0.

Gets or sets the type of region represented by the RegionOfInterest object.

The type of region represented by the RegionOfInterest object.

Gets or sets the weight of the region of interest.

Gets or sets the weight of the region of interest which is a value from 0-100.

Defines the different types of regions of interest that can be detected the capture device.

The region of interest is a detected face.

The type of region of interest is unknown.

Provides functionality to mange the regions of interest on a device.

Gets a value that specifies if auto exposure is supported on the capture device.

**true** if auto exposure is supported; otherwise, **false**.

Gets a value that specifies if auto focus is supported on the capture device.

**true** if auto focus is supported; otherwise, **false**.

Gets a value that specifies if auto white balance is supported on the capture device.

**true** if auto white balance is supported; otherwise, **false**.

Gets the maximum number of regions of interest that can be specified.

The maximum number of regions of interest.

Asynchronously clears the regions of interests.

The object that is used to control the asynchronous operation.

Asynchronously sets the regions of interest.

The regions of interest. The object that is used to control the asynchronous operation.

Asynchronously sets the regions of interest and specifies if the values should be locked.

The regions of interests. Specifies if the values should be locked. The object that is used to control the asynchronous operation.

Provides functionality for controlling the scene mode settings on a capture device.

Gets the scene modes supported on the capture device.

The supported scene modes.

Gets the current scene mod ethe capture device is set to.

The scene mode.

Asynchronously sets the color temperature Value.

The scene mode to set the Value property to. The object that is used to control the asynchronous operation.

Specifies the status of the audio device module command, executed with a call to AudioDeviceModule.SendCommand.

The command failed because device is not available.

The command was successful.

Provides functionality for controlling the torch LED settings on a capture device.

Gets or sets a value that enables and disables the torch LED on the device.

**true** if the torch LED is enabled; otherwise, **false**.

Gets or sets the intensity of the torch LED.

The power percent the torch LED is set to.

Gets a value that specifics if the device allows the torch LED power settings to be changed.

**true** if the power settings can be modified; otherwise, **false**.

Gets a value that specifies if the capture device supports the torch control.

**true** if the capture device supports the torch control; otherwise, **false**.

Controls device settings on the camera.

Gets the advanced photo capture control for this video device.

The advanced photo capture control

Gets a MediaDeviceControl object that can be used to get or set the whether back-light compensation is enabled on the camera.

A MediaDeviceControl object that provides methods to get and set the back-light compensation.

Gets a MediaDeviceControl object that can be used to get or set the brightness level on the camera.

A MediaDeviceControl object that provides methods to get and set the brightness.

Gets a MediaDeviceControl object that can be used to get or set the contrast level on the camera.

A MediaDeviceControl object that provides methods to get and set the contrast.

Gets or sets a value that indicates the optimizations the capture device should use to prioritize high quality picture, low latency, or low power consumption during video capture.

A value that indicates the optimizations the capture device should use.

Gets a MediaDeviceControl object that can be used to get or set the camera's exposure time.

A MediaDeviceControl object that provides methods to get and set the exposure time.

Gets the exposure compensation control for this video device.

The exposure compensation control

Gets the exposure control for this video device.

The exposure control.

Gets the ExposurePriorityVideoControl associated with the VideoDeviceController.

The ExposurePriorityVideoControl associated with the VideoDeviceController.

Gets the flash control for this video device.

The flash control.

Gets a MediaDeviceControl object that can be used to get or set the camera's focus setting.

A MediaDeviceControl object that provides methods to get and set the focus.

Gets the focus control for this video device.

The focus control.

Gets the HdrVideoControl associated with the VideoDeviceController. This allows you to enable and disable High Dynamic Range (HDR) video capture mode on devices that support it.

The HdrVideoControl associated with the VideoDeviceController.

Gets a MediaDeviceControl object that can be used to get or set the camera's hue setting.

A MediaDeviceControl object that provides methods to get and set the hue.

Gets a string containing the identifier for the video device controller.

The identifier for the video device controller.

Gets the infrared torch control for selected video device.

The infrared torch control.

Gets the ISO film speed control for this video device.

The ISO film speed control.

Gets the low shutter lag photo control for this video device.

The low shutter lag photo control.

Gets the low shutter lag photo sequence control for this video device.

The photo sequence control.

Gets the OpticalImageStabilizationControl associated with the VideoDeviceController.

The OpticalImageStabilizationControl associated with the VideoDeviceController.

Gets a MediaDeviceControl object that can be used to get or set the camera's pan setting.

A MediaDeviceControl object that provides methods to get and set the pan.

Gets the photo confirmation control for this video device.

The photo confirmation control for this video device.

Gets or sets the primary use for the device.

The primary use for the device.

Gets the regions of interest control for this video device.

The regions of interest control.

Gets a MediaDeviceControl object that can be used to get or set the camera's roll setting.

A MediaDeviceControl object that provides methods to get and set the roll.

Gets the scene mode control for this video device.

The scene mode control.

Gets a MediaDeviceControl object that can be used to get or set the camera's tilt setting.

A MediaDeviceControl object that provides methods to get and set the tilt.

Gets the torch control for this video device.

The torch control.

Gets the VariablePhotoSequenceController associated with the VideoDeviceController.

The VariablePhotoSequenceController associated with the VideoDeviceController.

Gets the VideoTemporalDenoisingControl associated with the VideoDeviceController. This allows you to enable and disable temporal denoising, which uses image data from adjacent frames to reduce the appearance of noise in captured video, on devices that support it.

The VideoTemporalDenoisingControl associated with the VideoDeviceController.

Gets a MediaDeviceControl object that can be used to get or set the white balance on the camera.

A MediaDeviceControl object that provides methods to get and set the white balance.

Gets the white balance control for this video device.

The white balance control.

Gets a MediaDeviceControl object that can be used to get or set the camera's zoom setting.

A MediaDeviceControl object that provides methods to get and set the zoom.

Gets the ZoomControl associated with the VideoDeviceController.

The ZoomControl associated with the VideoDeviceController.

Gets a list of the supported encoding properties for the video device.

The type of media stream for which to get the properties. A list of the supported encoding properties.

Gets the value of the property with the specified ID from the capture device driver. You can use this method to query properties that are specific to a particular camera.

The identifier of the property for which the value is retrieved. The property value.

Gets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and specifying the maximum buffer size required to store the result. You can use this method to query properties that are specific to a particular camera.

A byte array containing the extended identifier data. The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the Status property of the returned VideoDeviceControllerGetDevicePropertyResult object will be **MaxPropertyValueSizeRequired**. A VideoDeviceControllerGetDevicePropertyResult object containing the status of the operation and, if successful, the returned property value.

Gets a the value of the property from the capture device driver with the ID with custom header information. You can use this method to query properties that are specific to a particular camera.

The identifier of the property for which the value is retrieved. The size of the buffer that should be allocated to store the result of the operation. If the driver does not require that a size be specified for the returned property, set this value to null. If the size is required, and you do not provide a value, the Status property of the returned VideoDeviceControllerGetDevicePropertyResult object will be **MaxPropertyValueSizeRequired**. A VideoDeviceControllerGetDevicePropertyResult object containing the status of the operation and, if successful, the returned property value.

Gets the encoding properties for the specified media stream type for the video device.

The type of media stream for which to get the properties. The encoding properties.

Sets the value of the property with the specified ID on the capture device driver. You can use this method to set properties that are specific to a particular camera.

The identifier of the property for which the value is set. The new value of the property.

Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and providing the value as a byte array.

A byte array containing the extended identifier data. A byte array containing the data to be assigned to the specified property. A VideoDeviceControllerSetDevicePropertyStatus object describing the status of the operation.

Sets the value of the property with the specified ID from the capture device driver, using an extended ID with custom header information and providing the value as an object.

A byte array containing the extended identifier data. An object representing the data to be assigned to the specified property. A VideoDeviceControllerSetDevicePropertyStatus object describing the status of the operation.

Sets the encoding properties asynchronously for the specified media stream type for the video device.

The type of media stream for which to set the properties. The encoding properties to set. An IAsyncAction object that is used to control the asynchronous operation.

Gets the local power line frequency.

The power line frequency. Returns true if the method succeeded, or false otherwise.

Sets the local power line frequency.

The power line frequency. Returns true if the method succeeded, or false otherwise.

Represents the result of an operation to get the value of a video device controller driver property.

Gets a value that specifies the status of an operation to get the value of a video device controller driver property.

A value specifythat specifies the status of an operation to get the value of a video device controller driver property.

Gets an object representing the result value of an operation to get the value of a video device controller driver property.

An object representing the result value of an operation to get the value of a video device controller driver property. If the value of Status is not **Success**, this value will be null.

Specifies the status of an operation to get the value of a video device controller driver property.

The operation failed because the buffer containing the extended ID data for the property was smaller than expected by the device driver.

The operation failed because the device is not available.

The operation failed because a maximum property value size is required for the specified property.

The operation failed because the specified maximum property value size is too small for the property value. You can retry the operation with a larger maximum property value size.

The operation failed because the specified property is not supported by the device.

The operation completed successfully.

The operation failed due to an unknown failure.

Specifies the status of an operation to set the value of a video device controller driver property.

The operation failed because the device is not available.

The operation failed because the specified property value is invalid.

The operation failed because the app does not have exclusive control of the video capture device and is therefore not currently permitted to change the device settings. For more information, see MediaCaptureInitializationSettings.SharingMode.

The operation failed because the specified property is not supported by the device.

The operation completed successfully.

The operation failed due to an unknown failure.

When supported, allows an app to enable temporal denoising for video capture.

Gets or sets a value indicating the current video temporal denoising mode of the capture device.

The current video temporal denoising mode of the capture device.

Gets a value that indicates if the capture device supports the VideoTemporalDenoisingControl.

True if the VideoTemporalDenoisingControl is supported; otherwise, false.

Gets the list of VideoTemporalDenoisingMode values indicating the modes supported by the capture device.

The list of supported VideoTemporalDenoisingMode values.

Defines the video temporal denoising modes.

The system dynamically enables temporal denoising when appropriate.

Temporal denoising is off.

Temporal denoising is on.

Provides functionality for controlling the white balance settings on a capture device.

Gets the maximum white balance value.

The maximum white balance value.

Gets the minimum white balance value.

The minimum white balance value.

Gets the color temperature preset.

The color temperature preset.

Gets the step value.

The step value.

Gets a value that specifies if the capture device supports the white balance control.

**true** if the capture device supports the white balance control; otherwise, **false**.

Gets the color temperature value.

The color temperature value.

Asynchronously sets the color temperature Preset.

The color temperate preset to set the Preset property to. The object that is used to control the asynchronous operation.

Asynchronously sets the color temperature Value.

The temperature value to set the Value property to. The object that is used to control the asynchronous operation.

Provides functionality for controlling the zoom settings on a capture device.

Gets the maximum zoom value supported by the capture device.

The maximum zoom value supported by the capture device.

Gets the minimum zoom value supported by the capture device.

The minimum zoom value supported by the capture device.

Gets a value indicating the current zoom transition mode.

A value indicating the current zoom transition mode.

Gets the smallest zoom value increment supported by the capture device.

The smallest zoom value increment supported by the capture device.

Gets a value indicating whether zoom control is supported by the capture device.

A value indicating whether zoom control is supported by the capture device.

Gets the list of ZoomTransitionMode values indicating the modes supported by the capture device.

The list of supported ZoomTransitionMode values.

Gets or sets the zoom value to be used by the capture device.

The zoom value to be used by the capture device.

Configures the zoom control with the provided zoom settings.

The zoom settings.

Represents zoom settings that can be applied to the ZoomControl by calling the Configure method.

Initializes a new instance of the ZoomSettings class.

Gets or sets a ZoomTransitionMode value indicating how the capture device should transition to the new zoom value specified with the Value property.

A value indicating how the capture device should transition to the new zoom value.

Gets or sets the zoom value to which the ZoomControl will transition.

The zoom value to which the ZoomControl will transition.

Defines the zoom transition modes.

The default zoom transition mode for the device. Can be Direct or Smooth, depending on the device.

The zoom transition is instantaneous.

The zoom transition is smooth.

Represents the intrinsics that describe the camera distortion model.

Constructs an instance of a CameraIntrinsics.

The focal length of the camera. The principal point of the camera. The radial distortion coefficient of the camera. The tangential distortion coefficient of the camera. The image width of the camera, in pixels. The image height of the camera, in pixels.

Gets the focal length of the camera.

The focal length of the camera.

Gets the image height of the camera, in pixels.

The image height of the camera, in pixels.

Gets the image width of the camera, in pixels.

The image width of the camera, in pixels.

Gets the principal point of the camera.

The principal point of the camera.

Gets the radial distortion coefficient of the camera.

The radial distortion coefficient of the camera.

Gets the tangential distortion coefficient of the camera.

The tangential distortion coefficient of the camera.

Gets a matrix that transforms a 3D point to video frame pixel coordinates without compensating for the distortion model of the camera. The 2D point resulting from this transformation will not accurately map to the pixel coordinate in a video frame unless the app applies its own distortion compensation. This is useful for apps that choose to implement GPU-based distortion compensation instead of using UndistortPoint, which uses the CPU to compute the distortion compensation.

Gets a matrix that transforms a 3D point to the video frame pixel coordinates without compensating for the distortion model of the camera.

Applies the distortion model of the camera to an undistorted point so that the resulting point's location is distorted as if it were captured by the camera's lens.

The point to undestort. An undistorted point.

Applies the distortion model of the camera to an array of undistorted points so that the resulting points' locations are distorted as if they were captured by the camera's lens.

The array of points to undestort. An array of undistorted points.

Projects an array of camera space points into screen space pixel coordinates.

The array of camera space points to project into screen space. The array of screen space pixel coordinates.

Projects a camera space point into screen space pixel coordinates.

The camera space point to project into screen space. The screen space pixel coordinates.

Transforms a point to compensate for the distortion model of the camera, resulting in an undistorted point.

The point to undistort. An undistorted point.

Transforms an array of points to compensate for the distortion model of the camera, resulting in an array of undistorted points.

The array of points to undistort. An array of undistorted points.

Unprojects pixel coordinates into a camera space ray from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0.

The pixel coordinates to unproject into camera space. The X, Y coordinates of the unprojected pixel on the plane at Z = 1.0.

Unprojects an array pixel coordinates into a camera space rays from the camera origin, expressed as a X, Y coordinates on the plane at Z = 1.0.

The array of pixel coordinates to unproject into camera space. The array of X, Y coordinates of the unprojected pixels on the plane at Z = 1.0.

Maps 2D points in a MediaFrameSource to 3D space or to a frame from a different **MediaFrameSource** using data from a DepthMediaFrame.

Disposes of the object and associated resources.

Maps a point from one MediaFrameSource to another, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

The source point to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. The coordinate system of the target media frame source to which the point is mapped. The camera intrinsics describing the projection and distortion models of the media frame source to which the point is mapped. A mapped point.

Maps an array of points from one MediaFrameSource to another, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

An array of source points to be mapped to the coordinate system of a different media frame source, which is specified in the *targetCoordinateSystem* parameter. The coordinate system of the target media frame source to which the points are mapped. The camera intrinsics describing the projection and distortion models of the media frame source to which the points are mapped. An array mapped points.

Unprojects a 2D point from a MediaFrameSource to a point in 3D space, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

The 2D source point within the MediaFrameSource to map. The coordinate system to which the point is unprojected. An point in 3D space.

Unprojects an array of 2D points from a MediaFrameSource to a point in 3D space, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

The array of 2D source points within the MediaFrameSource to map. The coordinate system to which the points are unprojected. An array of points in 3D space.

Provides information about the variable photo sequence capabilities of the capture device.

Gets the exposure capabilities of the capture device for variable photo sequences.

The exposure capabilities of the capture device for variable photo sequences.

Gets the exposure compensation capabilities of the capture device for variable photo sequences.

The exposure capabilities of the capture device for variable photo sequences.

Gets the flash capabilities of the capture device for variable photo sequences.

The flash capabilities of the capture device for variable photo sequences.

Gets the focus capabilities of the capture device for variable photo sequences.

The focus capabilities of the capture device for variable photo sequences.

Gets the ISO speed capabilities of the capture device for variable photo sequences.

The ISO speed capabilities of the capture device for variable photo sequences.

Gets whether the capture device supports photo confirmation for variable photo sequences.

Whether the capture device supports photo confirmation for variable photo sequences.

Represents the settings for a frame in a variable photo sequence.

Initializes a new instance of the FrameController class.

Gets the exposure compensation settings for a frame in a variable photo sequence.

The exposure compensation settings for a frame in a variable photo sequence.

Gets the exposure settings for a frame in a variable photo sequence.

The exposure settings for a frame in a variable photo sequence.

Gets the flash settings for a frame in a variable photo sequence.

The flash settings for a frame in a variable photo sequence.

Gets the focus settings for a frame in a variable photo sequence.

The focus settings for a frame in a variable photo sequence.

Gets the ISO speed settings for a frame in a variable photo sequence.

The ISO speed settings for a frame in a variable photo sequence.

Gets or sets whether photo confirmation is enabled for a frame in a variable photo sequence.

Whether photo confirmation is enabled for a frame in a variable photo sequence.

Provides information about the exposure time capabilities of the capture device for frames in a variable photo sequences.

Gets the maximum exposure time supported by the capture device.

The maximum exposure time supported by the capture device.

Gets the minimum exposure time supported by the capture device.

Gets the minimum exposure time supported by the capture device.

Gets the smallest exposure time increment supported by the capture device.

Gets the smallest exposure time increment supported by the capture device.

Gets a value that indicates if the capture device supports the exposure control for variable photo sequences.

True if the capture device supports the exposure control; otherwise, false.

Provides information about the exposure compensation capabilities of the capture device for frames in a variable photo sequences.

Gets the maximum exposure compensation supported by the capture device.

The maximum exposure compensation supported by the capture device.

Gets the minimum exposure compensation supported by the capture device.

The minimum exposure compensation supported by the capture device.

Gets the smallest exposure time compensation increment supported by the capture device.

The smallest exposure time compensation increment supported by the capture device.

Gets a value that indicates if the capture device supports the frame exposure compensation control for frames in a variable photo sequence.

True if the capture device supports the frame exposure control; otherwise, false.

Represents the exposure compensation settings for a frame in a variable photo sequence.

Gets or sets the exposure compensation time for a frame in a variable photo sequence.

The exposure compensation time for a frame in a variable photo sequence.

Represents the exposure time settings for a frame in a variable photo sequence.

Gets or sets a value indicating whether auto exposure is enabled for a frame in a variable photo sequence.

A value indicating whether auto exposure is enabled for a frame in a variable photo sequence.

Gets or sets the exposure time for a frame in a variable photo sequence.

The exposure time for a frame in a variable photo sequence.

Provides information about the flash capabilities of the capture device for frames in a variable photo sequences.

Gets a value indicating whether flash power is supported for frames in a variable photo sequences.

True if flash power is supported; otherwise, false.

Gets a value indicating whether red eye reduction is supported for frames in a variable photo sequences.

True if red eye reduction is supported; otherwise, false.

Gets a value that indicates if the capture device supports the flash control for frames in a variable photo sequence.

True if the capture device supports the flash control; otherwise, false.

Represents the flash settings for a frame in a variable photo sequence.

Gets or sets a value indicating whether flash settings are automatically set for a frame in a variable photo sequence.

True if the flash settings are automatically set for a frame in a variable photo sequence; otherwise, false.

Gets or sets the flash mode for a frame in a variable photo sequence.

The flash mode.

Gets or sets the flash power for a frame in a variable photo sequence.

The flash power percentage, from 0 to 100, for a frame in a variable photo sequence.

Gets or sets a value indicating if red eye reduction is enabled for a frame in a variable photo sequence.

True if red eye reduction is enabled; otherwise, false.

Specifies the flash mode for a frame in a variable photo sequence.

The flash is disabled.

The flash is enabled.

The flash uses the global flash mode.

Provides information about the focus capabilities of the capture device for frames in a variable photo sequences.

Gets the maximum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters.

The maximum focus length supported by the capture device for a frame in a variable photo sequence.

Gets the minimum focus length supported by the capture device for a frame in a variable photo sequence, specified in millimeters.

The minimum focus length supported by the capture device for a frame in a variable photo sequence.

Gets the smallest focus increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters.

The smallest focus increment supported by the capture device for a frame in a variable photo sequence.

Gets a value that indicates if the capture device supports the focus control for frames in a variable photo sequence.

True if the capture device supports the focus control; otherwise, false.

Represents the focus settings for a frame in a variable photo sequence.

Gets or sets the focus value for a frame in a variable photo sequence.

The focus value for a frame in a variable photo sequence.

Provides information about the ISO speed capabilities of the capture device for frames in a variable photo sequences.

Gets the maximum ISO speed supported by the capture device for a frame in a variable photo sequence.

The maximum ISO speed supported by the capture device for a frame in a variable photo sequence.

The minimum ISO speed supported by the capture device for a frame in a variable photo sequence.

The minimum ISO speed supported by the capture device for a frame in a variable photo sequence.

Gets the smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters.

The smallest ISO speed increment supported by the capture device for a frame in a variable photo sequence, specified in millimeters.

Gets a value that indicates if the capture device supports the ISO speed control for frames in a variable photo sequence.

True if the capture device supports the ISO speed control; otherwise, false.

Represents the ISO speed settings for a frame in a variable photo sequence.

Gets or sets a value indicating whether ISO speed is automatically set for a frame in a variable photo sequence.

True if the ISO speed is automatically set for a frame in a variable photo sequence; otherwise, false.

Gets or sets the ISO speed for a frame in a variable photo sequence.

The ISO speed for a frame in a variable photo sequence.

Represents the settings for a variable photo sequence.

Gets the list of FrameController objects that determine the settings for each frame in a variable photo sequence.

The list of FrameController objects that determine the settings for each frame in a variable photo sequence.

Gets a FrameControlCapabilities object that provides information about the variable photo sequence capabilities of the capture device.

A FrameControlCapabilities object that provides information about the variable photo sequence capabilities of the capture device.

Gets the maximum number of photos that can be taken per second in a variable photo sequence.

The maximum number of photos that can be taken per second in a variable photo sequence.

Gets or sets the number of photos that are taken per second in a variable photo sequence.

The number of photos that are taken per second in a variable photo sequence.

Gets a value that indicates whether variable photo sequences are supported by the capture device.

A value that indicates whether variable photo sequences are supported by the capture device.

Gets the current frame rate at which pictures can be taken in a variable photo sequence.

The current frame rate at which pictures can be taken in a variable photo sequence.

Gets the highest frame rate supported when video and a variable photo sequence are being captured concurrently.

The media encoding properties. The highest supported concurrent frame rate.

Represents a DIAL application running on a remote device.

Gets the application's registered DIAL name.

The DIAL name.

Gets the current status of the application on the remote device.

The app status, a value from DialAppStateDetails.

Initiates the launching of the app on the remote device. When this method is called, the DialDevice is paired if necessary, the user is prompted to allow access to the device, connection is established, app existence is validated on the device, and finally the application is launched with the provided argument.

Optional. Indicates the result of attempting to launch the app.

Stops the app on the remote device, if the remote device supports this functionality.

The result of sending the request to stop the app.

The result of attempting to launch an app on a remote device.

The app failed to launch.

The app successfully launched.

An error occurred while attempting to retrieve the state.

The app was not found.

The state of the application on the remote device.

An error occurred while attempting to retrieve the state.

The app is running on the remote device.

The app is stopped on the remote device.

The state cannot be determined.

Represents the state of the DIAL app.

Gets the entire XML response that is provided by the app when state of the app was requested.

The full XML response.

Gets the state of the application at the time the GetAppStateAsync was completed.

The app state.

The result of attempting to stop an app from running on a remote device.

An error occurred while attempting to retrieve the state.

The app cannot be stopped because the operation isn't supported.

The app failed to stop.

The app is successfully stopped.

Represents the remote device capable of running DIAL apps.

Gets the friendly name for the DIAL device.

The friendly name for the DIAL device.

Gets the remote device's ID. You can use this ID with the Windows.Devices.Enumeration APIs as well.

The ID of the remote device.

Gets a stream containing the thumbnail image for the DIAL device.

A stream containing the thumbnail image for the DIAL device.

Indicates whether or not the device supports launching DIAL apps.

The device you want to get information for. True if app launching is supported; false, otherwise.

Returns a DialDevice object for a given a device ID (acquired from a query using the Windows.Devices.Enumeration APIs).

The ID of the device you want a DialDevice object for. The DialDevice object for the given device ID.

Returns an AQS filter string to be used with the Windows.Devices.Enumeration APIs (such as the CreateWatcher API) for a given Dial app.

The name of the app. The AQS filter.

Creates a new DialApp object. This method does not establish a connection to the device or validate that the app exists. That is done when any function is called on the resulting DialApp object.

The name of the app. This becomes the AppName property of the new object. The DialApp object for the app.

The possible statuses a DIAL device can have in the DIAL device picker. You can use these to adjust the sub-status and other visual attributes for a particular device in the picker.

The device is connected.

The device is attempting to connect.

The device is disconnected.

The device is attempting to disconnect.

The device shows an error.

The device is not connected.

Represents a picker flyout that contains a list of remote devices for the user to choose from.

Creates a new DialDevicePicker object.

Used to change the colors of the picker.

The color of the picker.

Gets the filter used to choose what devices to show in the picker.

The dial device picker filter.

Indicates that the device picker was light dismissed, which means that the user clicked or touched anywhere other than the picker UI, and so the picker will be closed.

Indicates that the user selected a device from the picker.

Indicates that the user clicked on the disconnect button in the picker.

Hides the picker.

Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event.

The rectangle from which to show the picker. The device the user selected from the picker.

Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event.

The rectangle from which to show the picker. The edge of the rectangle from which to show the picker. The DialDevice object selected.

Updates the picker UI to reflect the status fo a given remote device.

The remote device whose status you want to display. The status you want displayed.

Displays the picker to the user. When called, the picker flies out from an edge of the provided rectangle.

The rectangle from which you want the picker to show.

Displays the picker to the user. When called, the picker flies out from the specified edge of the provided rectangle.

The rectangle from which you want the picker to show. The edge from which you want the picker to show.

Represents the filter used to determine which devices to show in a DialDevicePicker. The filter parameters are OR-ed together to build the resulting filter.

Gets a list of DIAL apps supported by the remote devices. Defaults to an empty list (no filter). You can add one or more app names and filter the devices list to those that can launch one the supported apps.

The list of supported apps.

Represents the event arguments for the DialDeviceSelected event on the DialDevicePicker object.

Gets the DialDevice object that represents the remote device that has been selected by the user in a DialDevicePicker.

The remote device that the user selected.

Represents the event arguments for the DisconnectButtonClicked event on the DialDevicePicker object.

Gets the DialDevice object that represents the remote device that the user wants to disconnect.

The device object.

Provides a mechanism for server apps to supply requested data to the DIAL REST service, which can be queried by client apps.

Gets an instance of the **DialReceiverApp** class.

An instance of the **DialReceiverApp** class.

Retrieves the a map of key/value pairs representing the data previously set with SetAdditionalDataAsync.

A map of key/value pairs representing the data previously set with **SetAdditionalDataAsync**.

Asynchronously gets the unique device name of the DIAL server device.

An asynchronous operation that returns a string on completion.

Used by the server app to send a set of data in key/value pairs to the DIAL REST service so that it can be queried from a client app.

The set of key/value pairs to send to the DIAL REST service. Clients retrieve the additional data by making an HTTP GET request to the DIAL REST service application URL.  UWP client apps can perform this task by calling DialDevice.GetDialApp followed by DialApp.GetAppStateAsync, and then accessing the DialAppStateDetails.FullXml property to retrieve the additional data.  The additional data is added to the DIAL app XML in accordance with the DIAL specification.

Represents a single audio track for accompanying a video clip.

Gets the list of audio effect definitions for processing the background audio track.

The list of audio effect definitions for processing the background audio track.

Specifies how long to wait before starting background audio playback.

The length of time between the start of video playback and the start of background audio playback. This value can be negative to start background audio before video playback.

Original playback time of the background audio track, without the effects of the TrimTimeFromStart and TrimTimeFromEnd properties.

The original duration of the background audio track is equal to TrimmedDuration + TrimTimeFromStart + TrimTimeFromEnd.

Duration of the background audio track with TrimTimeFromStart and TrimTimeFromEnd applied to playback.

The trimmed duration of the background audio track is equal to OriginalDuration - (TrimTimeFromStart + TrimTimeFromEnd ).

The amount of time to trim from the end of the background audio track.

The trim time must be greater than or equal to 0 and less than the length of the background audio track.

The amount of time to trim from the beginning of the background audio track.

The trim time must be greater than or equal to 0 and less than the length of the background audio track.

An associative collection for storing custom properties associated with the background audio track.

The values stored in the IMap must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the background audio track.

Gets or sets the volume of the background audio track.

A value between 0 and 1 represents a reduction in the volume level of the background audio track where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the background audio track.

Creates a BackgroundAudioTrack object that is identical to this instance.

A BackgroundAudioTrack object that is a copy of this instance.

Creates a background audio track object with audio content copied from an embedded audio track object.

An embedded audio track to use as the source audio for the background audio track. A new background audio track object containing audio content copied from the embedded audio track.

Creates a background audio track from an audio file.

A StorageFile object representing the source audio file. A new background audio track object containing the contents of the audio file.

Gets the AudioEncodingProperties for the background audio track.

The AudioEncodingProperties for the background audio track.

Represents an audio track embedded in the media clip.

Gets the AudioEncodingProperties for the embedded audio track.

The AudioEncodingProperties for the embedded audio track.

Represents a single media object.

Gets the list of audio effect definitions for processing the media clip.

The list of audio effect definitions for processing the media clip.

The list of embedded audio tracks in this media clip.

Each member in the list is an EmbeddedAudioTrack object.

The time when the media clip stops playing within a MediaComposition.

Time is measured relative to the beginning of the media clip.

Original playback time of the media clip, without the effects of TrimTimeFromStart and TrimTimeFromEnd properties.

The original duration of the media clip is equal to TrimmedDuration + TrimTimeFromStart + TrimTimeFromEnd.

The index of the audio track within the media clip that is used for playback.

The default value of 0 selects the first audio track within the media clip.

The time when the media clip starts playing within a MediaComposition.

Time is measured relative to the beginning of the media clip.

Duration of the media clip with TrimTimeFromStart and TrimTimeFromEnd applied to playback.

The trimmed duration of the media clip is equal to OriginalDuration - (TrimTimeFromStart + TrimTimeFromEnd ).

The amount of time to trim from the end of the media clip.

The trim time must be greater than or equal to 0 and less than the length of the media clip.

The amount of time to trim from the beginning of the media clip.

The trim time must be greater than or equal to 0 and less than the length of the media clip.

An associative collection for storing custom properties associated with the media clip.

The values stored in the IMap must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a clip name, an application-related clip identifier, or a clip description.

Gets the list of video effect definitions for processing the media clip.

The list of video effect definitions for processing the media clip.

Gets or sets the volume of the media clip.

A value between 0 and 1 represents a reduction in the volume level of the media clip where 0 is silence and 1 is normal volume. A value greater than 1 represents a boost in the volume of the media clip.

Creates a MediaClip object that is identical to this instance.

A MediaClip object that is a copy of this instance.

Creates a solid color video clip that displays a single color for a specified length of time. Solid color video clips are typically used to create an explicit gap between video segments.

The color to display in the video clip. How long to display the color in the video clip. A new media clip object containing the color-based video clip.

Creates a video clip from a video file.

A StorageFile object representing the source video file. A new media clip object containing a video clip of the video file.

Creates a video clip that displays a single image for a specified length of time.

A StorageFile object representing the source image file. How long to display the image in the video clip. A new media clip object containing the image-based video clip.

Creates a video clip from a Microsoft Direct3D surface.

The Microsoft Direct3D surface. The initial duration of the created video clip. A new media clip object containing the video clip.

Gets the VideoEncodingProperties for the media clip.

The VideoEncodingProperties for the media clip.

Represents a collection of media clips and background audio tracks.

Initializes a new instance of the MediaComposition class.

A collection of background audio tracks for playback in the media composition.

The collection of BackgroundAudioTrack objects.

A collection of media clips for playback in the media composition.

The collection of MediaClip objects.

The total playback time of the media composition.

The sum of the trimmed durations of all media clips in the composition.

Gets the list of overlay layers for the media composition.

The list of overlay layers for the media composition.

An associative collection for storing custom properties associated with the media composition.

The values stored in the IMap must be strings. These values are app-defined and are not used by the operating system. You can use this collection to store, for example, a description of the media composition.

Creates a MediaComposition object that is identical to this instance.

A MediaComposition object that is a copy of this instance.

Create a new default media encoding profile which can be modified if necessary.

The newly created MediaEncodingProfile.

Creates a new MediaStreamSource.

The newly created MediaStreamSource.

Creates a new MediaStreamSource using the specified MediaEncodingProfile.

The MediaEncodingProfile used to specify the encoding properties of the new MediaStreamSource. The newly created MediaStreamSource.

Creates a new MediaStreamSource used to preview the edited media.

The width of the preview media. The height of the preview media. The new MediaStreamSource used to preview the edited media.

Asynchronously gets an image stream that represents a thumbnail of the media composition.

Specifies the point in the timeline of the MediaComposition from which to render the thumbnail, offset from the start of the MediaComposition. Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. Specifies the frame precision algorithm to use when retrieving the thumbnail. An image stream representing resulting thumbnail.

Asynchronously gets a vector view of thumbnails of the media composition.

Specifies the points in the timeline of the MediaComposition from which to render the thumbnails, offset from the start of the MediaComposition. Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. Specifies the frame precision algorithm to use when retrieving the thumbnails. A vector view on the resulting thumbnails.

Asynchronously loads a MediaComposition from a StorageFile.

The file from which to load the MediaComposition. An async operation which can be used to track the success or failure of the operation.

Asynchronously renders the MediaComposition to the specified file.

The file to which this MediaComposition is rendered. An async operation which can be used to track the success or failure of the operation.

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference.

The file to which this MediaComposition is rendered. Specifies whether to be fast or precise when trimming the media. An async operation which can be used to track the success or failure of the operation.

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference and encoding profile.

The file to which this MediaComposition is rendered. Specifies whether to be fast or precise when trimming the media. Specifies the encoding profile to use for rendering the media. An async operation which can be used to track the success or failure of the operation.

Asynchronously serializes the MediaComposition to disk so that it can be loaded and modified in the future.

The file to which the MediaComposition is saved. An async action which can be used to track the success or failure of the operation.

Represents an overlay that can be used in a media composition.

Initializes a new instance of the MediaOverlay class.

The media clip to be used for the overlay.

Initializes a new instance of the MediaOverlay class.

The media clip to be used for the overlay. The position of the overlay. The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque.

Gets or sets a value indicating whether audio is enabled for the MediaOverlay.

True if audio is enabled; otherwise, false.

Gets the media clip to be used for the overlay.

The media clip to be used for the overlay.

Gets or sets the time span from the start of the clip after which the media overlay should be rendered.

The time span from the start of the clip after which the media overlay should be rendered.

Gets the opacity of the overlay.

The opacity of the overlay, in the range of 0.0 to 1.0, where 0.0 is completely transparent and 1.0 is completely opaque.

Gets the position of the overlay.

The position of the overlay.

Creates a MediaOverlay object that is identical to this instance.

A MediaOverlay object that is a copy of this instance.

Represents a layer of a media overlay.

Initializes a new instance of the MediaOverlayLayer class.

Initializes a new instance of the MediaOverlayLayer class.

The definition of the custom compositor associated with the media overlay layer. This is

Gets the definition of the custom compositor associated with the media overlay layer, if there is one.

The definition of the custom compositor associated with the media overlay layer.

Gets the list of overlays for this media overlay layer.

The list of overlays for this media overlay layer.

Creates a MediaOverlayLayer object that is identical to this instance.

A MediaOverlayLayer object that is a copy of this instance.

Used to specify if media trimming should use a faster or a more precise algorithm during transcoding.

Use the faster trimming algorithm during transcoding.

Use the more precise trimming algorithm during transcoding.

Used to specify the frame precision algorithm when retrieving a thumbnail.

Use a more precise algorithm to get a thumbnail to the nearest frame.

Use a faster but less precise algorithm to get the thumbnail.

Represent an audio capture effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode.

Occurs when audio process chain changes.

Gets the list of audio effects on the device.

The list of audio effects.

Represents an audio effect.

Gets the type of the audio effect.

The type of the audio effect

Represents an audio effect definition.

Creates a new AudioEffectDefinition object with the specified activatable class ID.

The activatable class ID of the audio effect definition.

Creates a new AudioEffectDefinition object with the specified activatable class ID, configuring the object with the specified settings.

The activatable class ID of the audio effect definition. Configuration properties for the specified audio effect definition.

The activatable class ID of the audio effect definition.

The activatable class ID of the audio effect definition, such as "AudioClipEffect".

The set of properties for configuring an AudioEffectDefinition object.

The set of properties for the audio effect definition, represented as tuples.

Provides functionality for creating audio capture and render effects manager objects.

Creates a AudioCaptureEffectsManager object for the specified device for a specific media category.

The device id. The media category. The new audio capture effects manager.

Creates a AudioCaptureEffectsManager object for the specified device for a specific media category and audio processing mode.

The device id. The media category. The audio processing mode. The new audio capture effects manager.

Creates a AudioRenderEffectsManager object for the specified device for a specific media category and audio processing mode.

The device id. The audio render category. The new audio render effects manager.

Creates a AudioRenderEffectsManager object for the specified device for a specific media category.

The device id. The audio render category. The audio precessing mode. The new audio render effects manager.

Defines values for audio effect types.

An acoustic echo cancellation effect.

A automatic gain control effect.

A bass boost effect.

A bass management effect.

A beam forming effect.

A constant tone removal effect.

A dynamic range compression effect.

An environmental effect.

A equalizer effect.

A loudness equalizer effect.

A noise suppression effect.

Other.

A room correction effect.

A speaker compensation effect.

A speaker fill effect.

A speaker protection effect.

A virtual headphones effect.

A virtual surround sound effect.

Represent an audio render effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode.

Gets the label that is associated with this audio effects provider setting.

The string to use as the label for the audio effects provider setting.

Gets the thumbnail image that is associated with this audio effects provider.

The thumbnail image for the audio effects provider.

Occurs when audio process chain changes.

Gets the list of audio effects on the device.

The list of audio effects.

Displays the audio effect settings page.

Not supported starting in windows 10

Provides context for performing a custom overlay operation within the CompositeFrame method.

Gets the background frame for an overlay operation.

The background frame for an overlay operation.

Gets the output frame for an overlay operation.

The output frame for an overlay operation.

Gets the list of Direct3D surfaces to be used in an overlay operation.

The list of Direct3D surfaces to be used in an overlay operation.

Gets a MediaOverlay object for the provided Direct3D surface.

The Direct3D surface. The created MediaOverlay object.

Exposes the methods and properties of an AudioEffectDefinition object. Implement this interface when you create a custom audio effect definition.

The activatable class ID of the audio effect definition.

The activatable class ID of the audio effect definition, such as "AudioClipEffect".

The set of properties for configuring an AudioEffectDefinition object.

The set of properties for the audio effect definition, represented as tuples.

The interface you implement to create a custom audio effect.

Gets the encoding properties supported by the custom audio effect.

A list of supported encoding properties.

Gets a value that indicates whether the input frame is used for the output of the audio effect.

True if the input frame is used for output; otherwise, false.

Called when the audio effect should close and clean up allocated resources.

The reason the effect was closed.

Called to allow audio effect implementations optionally discard any stored state related to samples that have already been received.

Called when samples are available for processing by a custom audio effect.

The context object that provides the input and output frames for the process operation.

Called to set the encoding properties of a custom audio effect.

The encoding properties.

The interface you implement to create a custom video effect.

Gets a value indicating whether the video effect will modify the contents of the input frame.

True, if the effect will not modify the input frame; otherwise, false.

Gets the encoding properties supported by the custom video effect.

A list of supported encoding properties.

Gets a value that indicates whether the custom video effect supports the use of GPU memory or CPU memory.

A value that indicates the custom video effect's supported memory types.

Gets a value that indicates whether the custom video effect is time independent.

True, if the video effect is time independent; otherwise, false.

Called when the video effect should close and clean up allocated resources.

The reason the effect was closed.

Called to allow video effect implementations optionally discard any stored state related to frames that have already been received.

Called when frames are available for processing by a custom video effect.

The context object that provides the input and output frames for the process operation.

Called to set the encoding properties of a custom video effect.

The encoding properties. The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties.

The interface you implement to create a custom video compositor.

Gets a value that indicates whether the custom video effect is time independent.

True, if the video effect is time independent; otherwise, false.

Called when the video compositor should close and clean up allocated resources.

The reason the compositor was closed.

Called when frames are available for composition by a custom video compositor.

The context object that provides the input and output frames for the composition operation.

Called to allow video compositor implementations optionally discard any stored state related to frames that have already been received.

Called to set the encoding properties of a custom video compositor.

The encoding properties. The Microsoft Direct3D device that can be used to create resources based on the media format described by the encoding properties.

The interface defining a custom video compositor definition.

Gets the activatable class ID of the video compositor.

The activatable class ID of the video compositor.

Gets the set of properties for configuring the video compositor object.

The set of properties for configuring the video compositor object.

Exposes the methods and properties of a VideoEffectDefinition object. Implement this interface when you create a custom video effect definition.

The activatable class ID of the video effect definition.

The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect".

The set of properties for configuring the VideoEffectDefinition object.

The set of properties for the video effect definition, represented as tuples.

Specifies the reason why a media effect was closed.

The operation is complete.

The effect has been unloaded.

An unknown error has occurred.

The media effect does not support the required encoding format.

Specifies the types of memory that can be used for a media operation.

CPU memory.

GPU memory.

Both GPU and CPU memory.

Provides context for performing a custom audio effect operation within the ProcessFrame method.

Gets the input frame for an audio effect operation.

The input frame for an audio effect operation.

Gets the output frame for an audio effect operation.

The output frame for an audio effect operation.

Provides context for performing a custom video effect operation within the ProcessFrame method.

Gets the input frame for a video effect operation.

The input frame for a video effect operation.

Gets the output frame for a video effect operation.

The output frame for a video effect operation.

Represents the definition of a custom video compositor.

Initializes a new instance of the VideoCompositorDefinition class.

The activatable class ID of the video compositor.

Initializes a new instance of the VideoCompositorDefinition class.

The activatable class ID of the video compositor. The set of properties for configuring the video compositor object.

Gets the activatable class ID of the video compositor.

The activatable class ID of the video compositor.

Gets the set of properties for configuring the video compositor object.

The set of properties for configuring the video compositor object.

Represents a video effect definition.

Creates a new VideoEffectDefinition object with the specified activatable class ID.

The activatable class ID of the video effect definition.

Creates a new VideoEffectDefinition object with the specified activatable class ID, configuring the object with the specified settings.

The activatable class ID of the video effect definition. Configuration properties for the specified video effect definition.

Gets the activatable class ID of the video effect definition.

The activatable class ID of the video effect definition, such as "Windows.Media.VideoStabilizationEffect".

Gets the set of properties for configuring the VideoEffectDefinition object.

The set of properties for the video effect definition, represented as tuples.

Represents the definition of a video transform effect.

Initializes a new instance of the VideoTransformEffectDefinition class.

Gets the activatable class ID of the video transform effect definition.

The activatable class ID of the video transform effect definition.

Gets or sets the rectangle within which the video will be cropped, specified in pixels.

The rectangle within which the video will be cropped

Gets or sets the direction in which the video will be mirrored.

The direction in which the video will be mirrored.

Gets or sets the output size of the video, in pixels.

The output size of the video, in pixels.

Gets or sets the color that will be used to fill pixels in the frame that are not filled with video, such as when video is letterboxed.

The color that will be used to fill pixels in the frame that are not filled with video

Gets or sets the media processing algorithm that is used for the video transform.

The media processing algorithm that is used for the video transform.

Gets the set of properties for configuring the VideoTransformEffectDefinition object.

The set of properties for configuring the VideoTransformEffectDefinition object.

Gets or sets the angle and direction in which the video will be rotated.

The angle and direction in which the video will be rotated.

Gets a VideoTransformSphericalProjection object that allows you to configure the spherical projection parameters used by the video transform effect.

A VideoTransformSphericalProjection object.

Enables configuration of the spherical projection parameters used by the VideoTransformEffectDefinition.

Gets or sets a value from the SphericalVideoFrameFormat enumeration specifying the spherical projection format of the video.

The spherical projection format of the video.

Gets or sets the horizontal field of view, expressed in degrees, used for spherical video projection.

The horizontal field of view, expressed in degrees.

Gets or sets a value specifying whether spherical projection is enabled for the VideoTransformEffectDefinition.

True if spherical projection is enabled; otherwise, false.

Gets or sets a value that specifies the projection mode used for spherical video.

A value that specifies the projection mode used for spherical video.

Gets or sets a quaternion that specifies the current view orientation used to project spherical video.

The current view orientation.

Represents a face that was detected in a SoftwareBitmap or a VideoFrame.

Gets the bounds the detected face occupies in the SoftwareBitmap or VideoFrame.

The bounds of the detected face.

Detects faces in a SoftwareBitmap.

Gets a value indicating whether the FaceDetector class is supported on the current device.

True if FaceDetector; otherwise, false.

Gets or sets the maximum detectable face size, in pixels.

The maximum detectable face size, in pixels.

Gets or sets the minimum detectable face size, in pixels.

The minimum detectable face size, in pixels.

Creates a new instance of the FaceDetector class.

An asynchronous operation that returns a FaceDetector instance upon successful completion.

Asynchronously detects faces in the provided SoftwareBitmap.

The image data to be processed for face detection. An asynchronous operation that returns a list of DetectedFace objects upon successful completion.

Asynchronously detects faces in the provided SoftwareBitmap within the specified search area.

The image data to be processed for face detection. The bounds within the SoftwareBitmap in which face detection will be performed. An asynchronous operation that returns a list of DetectedFace objects upon successful completion.

Returns a list of the bitmap pixels formats supported by the FaceDetector on the current device.

A list of the bitmap pixels formats supported by the FaceDetector on the current device.

Queries whether the specified bitmap pixel format is supported by the FaceDetector on the current device.

The bitmap pixel format for which support is queried. True if the specified bitmap pixel format is supported; otherwise, false.

Detects faces in VideoFrame objects and tracks faces across subsequent video frames.

Gets a value indicating whether the FaceTracker class is supported on the current device.

True if FaceTracker; otherwise, false.

Gets or sets the maximum detectable face size, in pixels.

The maximum detectable face size, in pixels.

Gets or sets the minimum detectable face size, in pixels.

The minimum detectable face size, in pixels.

Creates a new instance of the FaceTracker class.

An asynchronous operation that returns a FaceTracker instance upon successful completion.

Returns a list of the bitmap pixels formats supported by the FaceTracker on the current device.

A list of the bitmap pixels formats supported by the FaceTracker on the current device.

Queries whether the specified bitmap pixel format is supported by the FaceTracker on the current device.

The bitmap pixel format for which support is queried. True if the specified bitmap pixel format is supported; otherwise, false.

Asynchronously processes a VideoFrame for face detection.

The VideoFrame in which faces are detected or tracked. An asynchronous operation that returns a list of DetectedFace objects upon successful completion.

Specifies the access mode with which photos are imported.

Photos are imported with read and delete access.

Photos are imported with read-only access.

Photos are imported with read and write access.

Specifies the connection transport used for photo import.

The connection transport is Bluetooth.

The connection transport is Internet Protocol.

The connection transport is unknown.

The connection transport is USB.

Specifies the content type of an imported item.

The item is an image.

The content type is unknown.

The item is a video.

Specifies the content types that are included in a photo import operation.

Include images and videos.

Include images and videos located in the Camera Roll directory or any of its subdirectories.

Include only images.

Include only videos.

Represents the result of a operation that deletes imported media items from the source.

Gets a list of items that were deleted from the source.

A list of items that were deleted from the source.

Gets a value indicating whether the delete operation has succeeded.

True if the delete operation has succeeded; otherwise, false.

Gets the number of photos deleted in the operation.

The number of photos deleted in the operation.

Gets the size of the deleted photos, in bytes.

The size of the deleted photos, in bytes.

Gets the photo import session associated with the delete operation.

The photo import session associated with the delete operation.

Gets the number of sibling files deleted in the operation.

The number of sibling files deleted in the operation.

Gets the size of the deleted sibling files, in bytes.

The size of the deleted sibling files, in bytes.

Gets the number of sidecar files deleted in the operation.

The number of sidecar files deleted in the operation.

Gets the size of the deleted sidecar files, in bytes.

The size of the deleted sidecar files, in bytes.

Gets the total number of items deleted in the operation.

The total number of items deleted in the operation.

Gets the total size of the all deleted items, in bytes.

The total size of the all deleted items, in bytes.

Gets the number of videos deleted in the operation.

The number of videos deleted in the operation.

Gets the size of the deleted videos, in bytes.

The size of the deleted videos, in bytes.

Represents the result of a operation that finds media items on a source.

Gets a list of items that were found on the source.

A list of items that were found on the source.

Gets a value indicating whether the find operation has succeeded.

True if the find operation has succeeded; otherwise, false.

Gets the photo import mode that determines which types of files are included in the ImportItemsAsync operation.

The photo import mode.

Gets the number of photos found on the source.

The number of photos found on the source.

Gets the size of the photos found on the source, in bytes.

The size of the found photos, in bytes.

Gets the number of photos that are currently selected to be included in the ImportItemsAsync operation.

The number of photos that are currently selected.

Gets the size of the photos that are currently selected to be included in the ImportItemsAsync operation, in bytes.

The size of the photos that are currently selected, in bytes.

Gets the number of sibling files that are currently selected to be included in the ImportItemsAsync operation.

The number of sibling files that are currently selected.

Gets the size of the sibling files that are currently selected to be included in the ImportItemsAsync operation, in bytes.

The size of the sibling files that are currently selected.

Gets the number of sidecar files that are currently selected to be included in the ImportItemsAsync operation.

The number of sidecar files that are currently selected.

Gets the size of the sidecar files that are currently selected to be included in the ImportItemsAsync operation, in bytes.

The size of the sidecar files that are currently selected.

Gets the total number of items that are currently selected to be included in the ImportItemsAsync operation.

The total number of items that are currently selected

Gets the total size of the all items that are currently selected to be included in the ImportItemsAsync operation, in bytes.

The total size of the all items that are currently selected, in bytes.

Gets the number of videos that are currently selected to be included in the ImportItemsAsync operation.

The number of videos that are currently selected.

Gets the size of the videos that are currently selected to be included in the ImportItemsAsync operation, in bytes.

The size of the videos that are currently selected, in bytes.

Gets the photo import session associated with the find operation.

The photo import session associated with the find operation.

Gets the number of sibling files found on the source.

The number of sibling files found on the source.

Gets the size of the found sibling files, in bytes.

The size of the found sibling files, in bytes.

Gets the number of sidecar files found on the source.

The number of sidecar files found on the source.

Gets the size of the found sidecar files, in bytes.

The size of the found sidecar files, in bytes.

Gets the total number of items found on the source.

The total number of items found on the source.

Gets the total size of all items found on the source, in bytes.

The total size of all items found on the source, in bytes.

Gets the number of videos found on the source.

The number of videos found on the source.

Gets the size of the videos found on the source, in bytes.

The size of the found videos, in bytes.

Occurs when an item is imported.

Occurs when the set of items selected to be included in the ImportItemsAsync operation changes.

Adds all items in the specified date range to the current selection.

The start of the date range. The length of the date range.

Asynchronously imports the selected items from the source.

An asynchronous operation that returns a PhotoImportImportItemsResult on successful completion.

Selects all items found on the source to be included in the ImportItemsAsync operation.

Selects all new items found on the source to be included in the ImportItemsAsync operation.

An asynchronous operation.

Deselects all items found on the source, preventing them from being included in the ImportItemsAsync operation.

Sets the photo import mode that determines which types of files are included in the ImportItemsAsync operation.

The photo import mode.

Represents the result of a operation that imports media items from the source.

Gets a value indicating whether the import operation has succeeded.

True if the import operation has succeeded; otherwise, false.

Gets a list of items that were imported from the source.

A list of items that were imported from the source.

Gets the number of photos imported in the operation.

The number of photos imported in the operation.

Gets the size of the imported photos, in bytes.

The size of the imported photos, in bytes.

Gets the photo import session associated with the import operation.

The photo import session associated with the import operation.

Gets the number of sibling files imported in the operation.

The number of sibling files imported in the operation.

Gets the size of the imported sidecar files, in bytes.

The size of the imported sidecar files, in bytes.

Gets the number of sidecar files imported in the operation.

The number of sidecar files imported in the operation.

Gets the size of the imported sidecar files, in bytes.

The size of the imported sidecar files, in bytes.

Gets the total number of items imported in the operation.

The total number of items imported in the operation.

Gets the total size of the all imported items, in bytes.

The total size of the all imported items, in bytes.

Gets the number of videos imported in the operation.

The number of videos imported in the operation.

Gets the size of the imported videos, in bytes.

The size of the imported videos, in bytes.

Asynchronously deletes the items that were imported from the source.

An asynchronous operation that returns a PhotoImportDeleteImportedItemsFromSourceResult on successful completion.

Specifies the types of files that are included in an import operation.

Sibling files are ignored.

Sidecar files are ignored.

Sidecar files and sibling files are ignored.

All files are imported.

Represents an media item that has been imported from a source.

Gets the content type of the imported item.

The content type of the imported item.

Gets the creation date of the imported item.

The creation date of the imported item.

Gets a list of the names of files associated with this item that were deleted.

A list of the names of files associated with this item that were deleted.

Gets a list of the names of files associated with this item that were imported.

A list of the names of files associated with this item that were imported.

Gets a value indicating whether the item is currently selected for import.

True if the item is currently selected; otherwise, false.

Gets the key used to identify the item.

The key used to identify the item.

Gets the name of the item.

The name of the item.

Gets the file system path of the PhotoImportItem.

The file system path of the PhotoImportItem.

Gets the sibling file associated with the item, if one exists.

The sibling file associated with the item

Gets the list of sidecar files associated with the item, if any exists.

The list of sidecar files associated with the item

Gets the size of the item, in bytes.

The size of the item, in bytes.

Gets a random access stream containing the thumbnail image associated with the item.

A random access stream containing the thumbnail image associated with the item.

Gets the list of video segments associated with the item.

The list of video segments associated with the item.

Provides data for the PhotoImportFindItemsResult.ItemImported event.

Gets the imported item associated with the PhotoImportFindItemsResult.ItemImported event.

The imported item.

Specifies the initial selection state for items that are discovered using PhotoImportSession.FindItemsAsync.

All found items are initially selected.

New found items are initially selected.

No found items are initially selected.

Provides APIs for determining if photo import is supported on the current device, finding sources from which to import photos, and getting references to any pending photo import operations.

Finds all currently available sources from which photos can be imported.

An asynchronous operation that returns a list of available sources on successful completion.

Gets the list of all pending photo import operations.

The list of all pending photo operations.

Gets a value indicating if photo import is supported on the current device.

An asynchronous operation that returns true if photo import is supported. Otherwise, returns false.

Represents an in-progress photo import operation.

Causes in-progress delete from source operations to continue.

An asynchronous operation that returns a PhotoImportDeleteImportedItemsFromSourceResult object on successful completion.

Causes in-progress find operations to continue.

An asynchronous operation that returns a PhotoImportFindItemsResult object on successful completion.

Causes in-progress import items operations to continue.

An asynchronous operation that returns a PhotoImportImportItemsResult object on successful completion.

Gets the photo import session associated with the operation.

The photo import session associated with the operation.

Gets the current stage of the in-progress operation.

The current stage of the in-progress operation.

Specifies the current power source of the source device containing items to be imported.

The current power source is a battery.

The current power source is external.

The current power source is unknown.

The progress data for an asynchronous photo import operation.

The number of bytes that have been imported.

The current import progress, expressed as a floating point value from 0 to 1.

The number of items that have been imported.

The total number of bytes to be imported.

The total number of items to be imported.

Provides data for the PhotoImportFindItemsResult.SelectionChanged event.

Gets a value indicating whether no items are selected after the selection has changed.

True if no items are selected; otherwise, false.

Represents a photo import session with a photo import source.

Gets or sets a value specifying whether the session date should be appended to the destination folder name.

True if the session date should be appended to the folder name; otherwise, false.

Gets or sets the prefix for the destination file name.

The prefix for the destination file name.

Gets or sets the destination folder for the photo import session.

The destination folder for the photo import session.

Gets a value indicating whether the deselected items for the session should be remembered.

True if the deselected items for the session should be remembered; otherwise, false.

Gets a unique identifier for the import session.

A unique identifier for the import session.

Gets an object representing the source device associated with the photo import session.

An object representing the source device associated with the photo import session.

Gets or sets a value indicating the method used for naming subfolders within the destination folder.

A value indicating method used for naming subfolders within the destination folder.

Gets or sets a value indicating the date format used by the session for subfolders.

A value indicating the date format used by the session for subfolders.

Closes the photo import session and releases associated resources.

Asynchronously finds items on the source device that are available for import.

A value indicating whether the find operation includes images, videos, or both in the results. A value indicating whether all items, no items, or only new items in the results are initially marked as selected. An asynchronous operation that returns a PhotoImportFindItemsResult on successful completion.

Represents a sidecar file or a sibling file to a PhotoImportItem.

Gets the date of the sidecar or sibling file.

The date of the sidecar or sibling file.

Gets the name of the sidecar or sibling file.

The name of the sidecar or sibling file.

Gets the size of the sidecar or sibling file, in bytes.

The size of the sidecar or sibling file, in bytes.

Represents the source device for a photo import session.

The battery level of the source device.

A value from 0 to 100 that indicates the power level of the device battery, with 0 being none, and 100 being fully charged.

Gets the connection protocol that is being used to communicate with the source device.

The connection protocol that is being used to communicate with the source device.

Gets a value indicating the transport mechanism that is being used for importing items from the source device.

A value indicating the transport mechanism that is being used for importing items from the source device.

Gets the current date and time on the device.

The current date and time on the device.

Gets a human-readable description of the source device.

A human-readable description of the device.

Gets the human-readable display name for the source device.

The human-readable display name for the source device.

Gets a unique 16-byte identifier that is common across multiple transports supported by the device.

A unique 16-byte identifier that is common across multiple transports supported by the device.

Gets a value indicating if the source device is locked.

True if the source device is locked; otherwise, false.

Gets a value indicating if the source device is a mass storage device.

True if the source device is a mass storage device; otherwise, false.

Gets the source device's human-readable manufacturer name.

The source device's human-readable manufacturer name.

Gets the device model name.

The device model name.

Gets a value indicating the type of power source being used by the source device, if it is known.

A value indicating the type of power source being used by the source device.

Gets the serial number of the device.

The serial number of the device.

Gets a list of objects representing the different storage media exposed by the source device.

A list of objects representing the different storage media exposed by the source device.

Gets a reference to a stream containing the thumbnail image for the source device.

A reference to a stream containing the thumbnail image for the source device.

Gets a value indicating the type of the source device.

A value indicating the type of the storage device.

Creates a new photo import session.

The new PhotoImportSession object.

Creates a new instance of PhotoImportSource from the specified root folder.

The root folder from which the photo import source is created. An asynchronous operation that returns a PhotoImportSource upon successful completion.

Creates a new instance of PhotoImportSource from the specified device ID.

The root folder from which the photo import source is created. An asynchronous operation that returns a PhotoImportSource upon successful completion.

Specifies the type of device that is being used as a photo import source.

The device is an audio recorder.

The device is a camera.

The device is a generic photo import source.

The device is a media player.

The device is a personal information manager.

The device is a phone.

The device is a video camera.

Specifies the stages of the photo import process.

Imported items are currently being deleted from the source.

Items are currently being found.

Items are currently being imported

The photo import process has not started.

Represents a storage medium exposed by a photo import source device.

Gets the available space on the storage medium, in bytes.

The available space on the storage medium, in bytes.

Gets the capacity of the storage media, in bytes.

The capacity of the storage media, in bytes.

Gets a description of the storage medium.

A description of the storage medium.

Gets the name of the storage medium.

The name of the storage medium.

Gets the serial number of the storage medium.

The serial number of the storage medium.

Gets the type of the storage medium.

The type of the storage medium.

Gets a value indicating the access modes supported by the storage medium.

A value indicating the access modes supported by the storage medium.

Refreshes the information about the storage medium.

Specifies the type of a storage medium.

The storage medium is fixed.

The storage medium is removable.

The storage medium type is undefined.

Specifies the method used for naming subfolders within the destination folder.

Subfolders are created based on the EXIF date of the imported files.

Subfolders are created based on the file date of the imported files.

No subfolders are created.

Subfolders are created to match the folder structure of the import source.

Specifies the date format of a subfolder for a photo import operation.

The date format specifies a year.

The date format specifies year and month.

The date format specifies a year, month, and day.

Represents an imported video segment.

Gets the date of the imported video segment.

The date of the imported video segment.

Gets the name of the imported video segment.

The name of the imported video segment.

Gets the sibling file associated with the imported video segment.

The sibling file associated with the imported video segment.

Gets the sidecar file associated with the imported video segment.

The sidecar file associated with the imported video segment.

Gets the size of the imported video segment, in bytes.

The size of the imported video segment, in bytes.

Describes the encoding properties of an audio stream.

Creates a new instance of the AudioEncodingProperties class.

Gets or sets the audio bit rate.

The average bit rate of the audio stream, in bits per second.

Gets or sets the number of bits per audio sample.

The number of bits per audio sample.

Gets or sets the number of audio channels.

The number of audio channels.

Gets a value indicating whether the audio is encoded with spatial audio information.

True if the audio is encoded with spatial audio information; otherwise, false.

Gets additional format properties for the audio stream.

A property set that contains format properties.

Gets or sets audio sampling rate.

The number of audio samples per second.

Gets or sets the subtype of the format.

The subtype.

Gets the format type.

The format type. For audio streams, the format type is "Audio".

Creates a copy of the **AudioEncodingProperties** object.

A copy of the **AudioEncodingProperties** object.

Creates an instance of AudioEncodingProperties for Advanced Audio Coding (AAC) audio.

The audio sampling rate. The number of audio channels. The audio bit rate. The audio encoding properties.

Creates an instance of AudioEncodingProperties for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format.

The audio sampling rate. The number of audio channels. The audio bit rate. The audio encoding properties.

Creates an instance of AudioEncodingProperties for Apple Lossless Audio Codec (ALAC) audio.

The audio sampling rate. The number of audio channels. The number of bits per sample. The audio encoding properties.

Creates an instance of AudioEncodingProperties for Free Lossless Audio Codec (FLAC) audio.

The audio sampling rate. The number of audio channels. The number of bits per sample. The audio encoding properties.

Creates an instance of AudioEncodingProperties for MPEG Audio Layer-3 (MP3) audio.

The audio sampling rate. The number of audio channels. The audio bit rate. The audio encoding properties.

Creates an instance of AudioEncodingProperties for Pulse Code Modulation (PCM) audio.

The audio sampling rate. The number of audio channels. The audio bit depth. The audio encoding properties.

Creates an instance of AudioEncodingProperties for Windows Media Audio (WMA).

The audio sampling rate. The number of audio channels. The audio bit rate. The audio encoding properties.

Gets the media format user data.

Receives the media format data.

Sets the media format user data.

The media data to set.

Describes the level of quality of the audio encoding. The higher the quality, the better the audio fidelity, and the larger the resulting file.

**Auto** fills in the proper settings based on the current camera settings. So when **Auto** is used, settings that are manually modified are ignored. For example, if you create a preset profile using one the static create methods, such as CreateM4a, and specify **Auto** as the encoding quality, any changes you make to the properties will be overwritten with values based on the current camera settings.

Stereo, Professional audio sampling rate (48 kHz), 192 kilobits per second (kbps) data transfer rate.

Mono, CD quality sampling rate (44.1 kHz), 96 kilobits per second (kbps) data transfer rate.

Stereo, CD quality sampling rate (44.1 kHz), 128 kilobits per second (kbps) data transfer rate.

Describes a media container format.

Creates a new instance of the ContainerEncodingProperties class.

Gets additional format properties for the media container.

A property set that contains format properties.

Gets or sets the subtype of the media container.

The subtype.

Gets the format type.

The format type. For media containers, the format type is "Container".

Creates a copy of the **ContainerEncodingProperties** object.

A copy of the **ContainerEncodingProperties** object.

Provides properties for getting H.264 profile ids.

Gets the H.264 baseline profile.

The baseline profile.

Gets the H.264 constrained baseline profile.

The constrained baseline profile.

Gets the H.264 extended profile.

The extended profile.

Gets the H.264 high profile.

The high profile.

Gets the H.264 high 10 profile.

The high 10 profile.

Gets the H.264 high 4:2:2 profile.

The high 4:2:2 profile.

Gets the H.264 high 4:4:4 profile.

The high 4:4:4 profile.

Gets the H.264 main profile.

Gets the main profile.

Gets the H.264 multiview profile.

The multiview profile.

Gets the H.264 stereo high profile.

The stereo high profile.

Describes the format of an image stream.

Creates a new instance of the ImageEncodingProperties class.

Gets or sets the image height.

The height of the image, in pixels.

Gets additional format properties for the image stream.

A property set that contains format properties.

Gets or sets the subtype of the format.

The subtype.

Gets the format type.

The format type. For image streams, the format type is "Image".

Gets or sets the image width.

The width of the image, in pixels.

Creates a copy of the **ImageEncodingProperties** object.

A copy of the **ImageEncodingProperties** object.

Creates an instance of ImageEncodingProperties for a BMP image.

The image encoding properties.

Creates an instance of ImageEncodingProperties for HEIF format.

The ImageEncodingProperties for HEIF format.

Creates an instance of ImageEncodingProperties for a JPEG image.

The properties for the image stream.

Creates an instance of ImageEncodingProperties for a JPEG XR image.

The properties for the image stream.

Creates an instance of ImageEncodingProperties for a PNG image.

The properties for the image stream.

Creates an instance of ImageEncodingProperties for an uncompressed image.

The media pixel format. The image encoding properties.

Describes the format of a media stream or media container.

Gets additional format properties.

A property set that contains format properties.

Gets or sets the subtype of the format.

The subtype.

Gets the format type.

The format type. The value can be the string representation of a GUID in canonical form, or one of the predefined values listed in the following table.<table>

Describes the encoding profile for an audio or video file. The encoding profile includes descriptions of the audio and video encoding formats, and a description of the media container.

Creates a new instance of the MediaEncodingProfile class.

Gets or sets the encoding properties for the audio stream.

The encoding properties of the audio stream. If the profile does not contain an audio stream, the value is **null**.

Gets or sets the properties of the media container.

The properties of the media container.

Gets or sets the encoding properties for the video stream.

The encoding properties of the video stream. If the profile does not contain a video stream, the value is **null**.

Creates an instance of MediaEncodingProfile for Apple Lossless Audio Codec (ALAC) audio.

The ecoding quality. The media encoding profile.

Creates an instance of MediaEncodingProfile for AVI.

The video quality. The media encoding profile.

Creates an instance of MediaEncodingProfile for Free Lossless Audio Codec (FLAC) audio.

The ecoding quality. The media encoding profile.

Creates an encoding profile from an existing media file.

The media file from which to create the profile. An object that is used to control the asynchronous operation.

Creates an encoding profile from a stream that contains media data.

The media stream from which to create the profile. An object that is used to control the asynchronous operation.

Creates an instance of MediaEncodingProfile for High Efficiency Video Coding (HEVC) video, also known as H.265 video.

The video quality. The media encoding profile.

Creates an encoding profile for AAC audio.

Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. Returns a media encoding profile.

Creates an encoding profile for MP3 (MPEG-1 layer 3) audio.

Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. Returns a media encoding profile.

Creates an encoding profile for H.264 video.

Specifies the video resolution of the profile. Returns a media encoding profile.

Creates an instance of MediaEncodingProfile for WAV

The audio encoding quality. The media encoding profile.

Creates an encoding profile for Windows Media Audio (WMA).

Specifies whether to create a profile with a low bit rate, medium bit rate, or high bit rate. Returns a media encoding profile.

Creates an encoding profile for Windows Media Video (WMV).

Specifies the video resolution of the profile. Returns a media encoding profile.

Retrieves the list of AudioStreamDescriptor objects describing the audio streams included in the **MediaEncodingProfile**.

A list of AudioStreamDescriptor objects.

Retrieves the list of TimedMetadataStreamDescriptor objects describing the timed metadata streams included in the **MediaEncodingProfile**.

A list of TimedMetadataStreamDescriptor objects.

Retrieves the list of VideoStreamDescriptor objects describing the video streams included in the **MediaEncodingProfile**.

A list of VideoStreamDescriptor objects.

Sets the list of AudioStreamDescriptor objects describing the audio streams included in the **MediaEncodingProfile**.

A list of VideoStreamDescriptor objects.

Sets the list of TimedMetadataStreamDescriptor objects describing the timed metadata streams included in the **MediaEncodingProfile**.

A collection of TimedMetadataStreamDescriptor objects.

Sets the list of VideoStreamDescriptor objects describing the video streams included in the **MediaEncodingProfile**.

A collection of VideoStreamDescriptor objects.

Provides properties for getting the standard names for media subtypes.

Gets the name for Advanced Audio Coding (AAC).

The name for AAC.

Gets the name for Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format.

The name for AAC ADTS.

Gets the name for Dolby Digital audio (AC-3).

The name for AC-3.

Gets the name for Apple Lossless Audio Codec (ALAC) audio encoding.

The name for Dolby Digital audio (AC-3) for Apple Lossless Audio Codec (ALAC) audio.

Gets the name for Adaptive Multi-Rate (AmrNb).

The name of AMR-NB.

Gets the name for Adaptive Multi-Rate Wideband.

The name for AMR-WB

Gets the name for RGB 32 with alpha channel.

The name for AGB32.

Gets the name for Advanced Systems Format (ASF).

The name for ASF.

Gets the name for Audio Video Interleave (AVI).

The name for AVI.

Gets the name for BGRA8.

The name for BGRA8.

Gets the name for BMP file format.

The name from BMP.

Gets the name for 16-bit z-buffer depth image encoding.

The name for 16-bit z-buffer depth image encoding.

Gets the name Dolby Digital Plus (E-AC-3).

Gets the name for E-AC-3.

Gets the name for Free Lossless Audio Codec (FLAC) audio encoding.

The name for Free Lossless Audio Codec (FLAC) audio encoding.

Gets the name for Uncompressed IEEE floating-point audio.

Gets the name for float.

Gets the name for Graphics Interchange Format (GIF).

Gets the name for GIF.

Gets the name for H.263.

The name for H.263.

The name for H.264.

The name for H.264.

Get the name for H.264Es.

The name for H.264Es.

Gets the name for High Efficiency Image File (HEIF).

The name for HEIF.

Gets the name for High Efficiency Video Coding (HEVC).

The name for HEVC.

Gets the name for HEVCES.

The name for HEVCES.

Gets the name for IYUV.

The name for IYUV.

Gets the name for JPEG.

The name for JPEG.

Gets the name for JPEG-XR.

The name for JPEG-XR.

Gets the name for 16-bit luminance-only image encoding.

The name for 16-bit luminance-only image encoding.

Gets the name for 8-bit luminance-only image encoding.

The name for 8-bit luminance-only image encoding.

Gets the name for Motion JPEG (MJPG).

The name for MJPG.

Gets the name for MPEG Audio Layer-3 (MP3).

The name for MP3.

Gets the name for MPEG.

The name for MPEG.

Gets the name for MPEG-1.

The name for MPEG-1.

Gets the name for MPEG-2.

The name for MPEG-2.

Gets the name for MPEG-4.

The name for MPEG-4.

Gets the name for NV12.

The name for NV12.

Gets the P010, the 10-bit equivalent of NV12 format.

The name for the P010.

Gets the name for PCM.

The name for PCM.

Gets the name for the Presentation Graphic Stream (PGS) format.

The name for the Presentation Graphic Stream format.

Gets the name for Portable Network Graphics (PNG).

Gets the name for PNG.

Gets the name RGB 24.

The name for RGB 24.

Gets the name for RGB 32.

The name for RGB 32.

Gets the name for the SubRip Text (SRT) format.

The name for the SubRip Text format.

Gets the name for the SubStation Alpha Text (SSA) format.

The name for the SubStation Alpha Text (SSA) format.

Gets the name for TIFF.

The name for TIFF.

Gets the name for the VobSub format.

The name for the VobSub format.

Gets the name for VP9 video encoding.

The name for VP9 video encoding.

Gets the name for Waveform Audio File (WAVE).

The name for WAVE.

Gets the name for Windows Media Audio 8.

Gets the name for WMA 8.

Gets the name for Windows Media Audio 8.

The name for WMA 9.

Gets the name for Windows Media Video 9.

Gets the name for WMV3.

Gets the name for Windows Media Video 9 Advanced Profile.

Gets the name for WVC1.

Gets the name for YUY2.

The name for YUY2.

Gets the name for YV12.

The name for YV12.

Defines the direction in of a mirror transform.

Mirror horizontally.

No mirroring.

Mirror vertically.

Defines values for media pixel formats.

BGRA8 media pixel format.

NV12 media pixel format.

P010 media pixel format.

Represents a set of media properties.

Creates an instance for MediaPropertySet.

Gets the number of items contained in the property set.

The number of items in the property set.

Removes all items from the property set.

Returns an iterator to enumerate the items in the property set.

The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty.

Returns an immutable view of the property set.

The immutable view.

Indicates whether the property set has an item with the specified key.

The key. True if the property set has an item with the specified key; otherwise, false.

Adds an item to the property set.

The key of the item to insert. The value of the item to insert. True if the method replaced a value that already existed for the key; false if this is a new key.

Retrieves the value for the specified key.

The key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the property set.

The key of the item to remove.

Represents ratios used in media operations.

The denominator of the MediaRatio.

The denominator value.

The numerator of the MediaRatio.

The numerator value.

Defines the direction and angle of a media rotation transform.

Rotate 180 degrees clockwise.

Rotate 270 degrees clockwise.

Rotate 90 degrees clockwise.

No rotation.

Defines values for media formats for thumbnails.

BGRA8 media format.

BMP media format.

Provides properties for getting MPEG-2 profile ids.

Gets the MPEG-2 high profile.

The MPEG-2 high profile.

Gets the MPEG-2 main profile.

The MPEG-2 main profile.

Gets the MPEG-2 signal to noise ratio scalable profile.

The MPEG-2 signal to noise ratio scalable profile.

Gets the MPEG-2 simple profile.

The MPEG-2 simple profile.

Gets the MPEG-2 spatially scalable profile.

The MPEG-2 spatially scalable profile.

Specifies the format of a spherical video frame.

The video frame uses equirectangular format for spherical video.

The video frame does not use a spherical video format.

The video frame uses an unsupported spherical video format.

Specifies the stereoscopic video packing mode of a video stream.

The video stream does not use stereoscopic video packing.

The video stream packs stereoscopic video frames side by side.

The video stream packs stereoscopic video frames using the top and bottom of the frame.

Describes the encoding properties of a timed metadata stream. Timed metadata streams are used to encode data that is neither audio or video. For example, a media file may contain a video stream and a timed metadata stream containing GPS coordinates correlated to the video.

Creates a new instance of the TimedMetadataEncodingProperties class.

Gets additional format properties for the timed metadata stream.

A property set that contains format properties.

Gets a string specifying the format subtype of the typed metadata.

A string specifying the format subtype of the typed metadata.

Gets a string specifying the format type of the typed metadata.

A string specifying the format type of the typed metadata.

Creates a copy of the **TimedMetadataEncodingProperties** object.

A copy of the **TimedMetadataEncodingProperties** object.

Creates an instance of TimedMetadataEncodingProperties for the Presentation Graphic Stream (PGS) format.

The timed text encoding properties.

Creates an instance of TimedMetadataEncodingProperties for the SubRip Text (SRT) format.

The timed text encoding properties.

Creates an instance of TimedMetadataEncodingProperties for the SubStation Alpha Text (SSA) format.

Format-defined user data. For more information, see SubstationAlpha. The timed text encoding properties.

Creates an instance of TimedMetadataEncodingProperties for the VobSub format.

Format-defined user data. For more information, see DirectVobSub. The timed text encoding properties.

Gets information about the metadata encoding that is specific to the format type.

A byte array containing format-specific encoding information.

Sets information about the metadata encoding that is specific to the format type.

A byte array containing format-specific encoding information.

Describes the encoding properties of a video stream.

Creates a new instance of the VideoEncodingProperties class.

Gets or sets the video bit rate.

The average bit rate of the video stream, in bits per second.

Gets or sets the video frame rate.

The frame rate, in frames per second.

Gets or sets the video image height.

The height of the video image, in pixels.

Gets or sets the pixel aspect ratio.

The pixel aspect ratio.

Gets or sets the media format profile.

The media format profile.

Gets additional format properties for the video stream.

A property set that contains format properties.

Gets a value that specifies the spherical video format of a video frame.

The spherical video format of a video frame.

Gets a value indicating the stereoscopic video packing mode of the video stream.

The stereoscopic video packing mode of the video stream.

Gets or sets the subtype of the format.

The subtype.

Gets the format type.

The format type. For video streams, the format type is "Video".

Gets or sets the video image width.

The width of the video image, in pixels.

Creates a copy of the **VideoEncodingProperties** object.

A copy of the **VideoEncodingProperties** object.

Creates an instance of VideoEncodingProperties for a H.263 video.

The video encoding properties.

Creates an instance of VideoEncodingProperties for High Efficiency Video Coding (HEVC).

The video encoding properties.

Creates an instance of VideoEncodingProperties for a MPEG-2 video.

The video encoding properties.

Creates an instance of VideoEncodingProperties for a uncompressed video.

The media subtype of the format. The video image width. The video image height. The video encoding properties.

Gets the media format user data.

Receives the media format data.

Sets the media format user data.

The media data to set.

Determines the video encoding format.

**Auto** fills in the proper settings based on the current camera settings. So when **Auto** is used, settings that are manually modified are ignored. For example, if you create a preset profile using one the static create methods, such as CreateWmv, and specify **Auto** as the encoding quality, any changes you make to the properties will be overwritten with values based on the current camera settings.

HD1080p format.

HD720p format.

Ntsc format.

Pal format.

Qvga format.

2160p UHD format.

4320p UHD format.

Vga format.

Wvga format.

An object that allows an app to implement a Miracast Receiver (Sink) and receive incoming Miracast connections.

Creates a new instance of a MiracastReceiver object.

An event that is raised when the status of the MiracastReceiver has changed.

Empties the collection of known MiracastTransmitter objects.

Creates a new MiracastReceiverSession object, needed to receive Miracast connections.

The CoreApplicationView used by the app when displaying the Miracast video stream. The new **MiracastReceiverSession** object.

Asynchronously creates a new MiracastReceiverSession object, needed to receive Miracast connections.

The CoreApplicationView used by the app when displaying the Miracast video stream. An asynchronous operation that returns the new **MiracastReceiverSession** object upon completion.

Disconnects all currently connected Miracast connections and applies the specified settings on the MiracastReceiver.

The settings that will be applied. A MiracastReceiverApplySettingsResult containing information about the result of the operation.

Asynchronously disconnects all currently connected Miracast connections and applies the specified settings on the MiracastReceiver.

The settings that will be applied. An asynchronous operation that returns a **MiracastReceiverApplySettingsResult** object upon completion.

Returns the settings currently used by the MiracastReceiver.

A MiracastReceiverApplySettingsResult containing information about the current settings used by the **MiracastReceiver**.

Returns the settings currently used by the MiracastReceiver.

An asynchronous operation that returns a MiracastReceiverApplySettingsResult object upon completion.

Returns default settings for the MiracastReceiver.

A MiracastReceiverSettings object containing information about the default settings for the **MiracastReceiver**.

Retrieves the current status of the MiracastReceiver.

A MiracastReceiverStatus object containing information about the the current status of the **MiracastReceiver**.

Asynchronously retrieves the current status of the MiracastReceiver.

An asynchronous operation that returns a MiracastReceiverStatus object upon completion.

Remove a specified MiracastTransmitter from the collection of known MiracastTransmitter objects .

The **MiracastTransmitter** to be removed.

Represents the result of attempting to apply settings on the MiracastReceiver.

Gets the extended error code for the MiracastReceiverApplySettingsResult.

The error code.

Gets the status of a DisconnectAllAndApplySettings or DisconnectAllAndApplySettingsAsync operation.

A MiracastReceiverStatus object containing information about the status of the operation.

Specifies the status of a DisconnectAllAndApplySettings or DisconnectAllAndApplySettingsAsync operation.

The operation failed because the app is not allowed to change the settings.

The operation failed because the number of characters in the *FriendlyName* parameter exceeded the maximum allowed value.

The operation failed because one or more parameters were set to an invalid value.

The operation failed because Miracast is not supported on the current device.

The operation failed because the number of characters in the *ModelName* parameter exceeded the maximum allowed value.

The operation failed because the number of characters in the *ModelNumber* parameter exceeded the maximum allowed value.

The operation succeeded.

The operation failed for an unknown reason.

Specifies the method used to authorize incoming Miracast connections.

The Miracast Receiver will ask the user to accept or reject the incoming connection.

Automatically accept new Miracast connections.

The Miracast Receiver will display a PIN only if the Miracast transmitter requests the use of a PIN.

The Miracast Receiver will display a PIN and the Miracast transmitter must enter it.

Represents a single connection between a Miracast Receiver and a Miracast Transmitter.

Gets the channel for transmitting mouse cursor images from a Miracast Transmitter to a Miracast Receiver.

The cursor image channel.

Gets the devices from which the Miracast Receiver can collect input and transmit to the Miracast Transmitter.

A MiracastReceiverInputDevices representing the input devices.

Gets a MiracastReceiverStreamControl object, which is used for controlling properties of the audio and video streams.

The **MiracastReceiverStreamControl** object.

Gets an MiracastTransmitter object representing the Miracast Transmitter that initiated the connection.

The Miracast Transmitter.

Closes the connection and immediately disconnects the associated MiracastTransmitter from this connection.

Closes the connection and immediately disconnects the connected MiracastTransmitter.

A value from the MiracastReceiverDisconnectReason enumeration specifying the reason for disconnecting the Miracast Transmitter.

Closes the connection and immediately disconnects the connected MiracastTransmitter.

A value from the MiracastReceiverDisconnectReason enumeration specifying the reason for disconnecting the Miracast Transmitter. A human-readable message, stating a reason for disconnecting the Miracast Transmitter.

Requests the Miracast Transmitter to pause streaming audio and video data to the Receiver. The connection remains established.

Asynchronously requests the Miracast Transmitter to pause streaming audio and video data to the Receiver. The connection remains established.

An asynchronous operation.

Requests the Miracast Transmitter to resume streaming audio and video data to the MiracastReceiver.

Requests the Miracast Transmitter to resume streaming audio and video data to the MiracastReceiver.

An asynchronous operation.

Provides data for the MiracastReceiverSession.ConnectionCreated event.

Gets the MiracastReceiverConnection object of the newly created connection.

The **MiracastReceiverConnection** object.

Getes the PIN that must be entered by the Miracast Transmitter device, or an empty string if PIN authentication is not in use.

The PIN, or an empty string if PIN authentication is not used.

Defers completion of the MiracastReceiverSession.ConnectionCreated event until Deferral.Complete is invoked.

The Deferral object.

An object representing the channel for transmitting mouse cursor images from a Miracast Transmitter to a Miracast Receiver.

Gets the cursor image as a PNG image bitmap.

A stream object, containing the cursor image in the form of a PNG image bitmap.

Gets a value that specifies if the cursor image channel has been enabled by the Miracast Receiver.

True if the cursor image channel has enabled by the Miracast Receiver.

Gets the maximum width and height of the cursor image PNG bitmap, in pixels.

The maximum width and height of the cursor image PNG bitmap, in pixels.

Gets the coordinates of the upper-left corner of the cursor image, in pixels.

The coordinates of the upper-left corner of the cursor image, in pixels.

An event which is raised when the image stream bitmap has changed.

An event which is raised when the position of the cursor image has changed.

An object that represents settings that can be configured on the MiracastReceiverCursorImageChannel.

Gets or sets the enabled status of the use of the separate channel for mouse cursor images.

True if the Miracast Cursor Image Channel is enabled.

Controls the maximum width and height of the cursor image PNG bitmap, in pixels.

The maximum width and height of the cursor image PNG bitmap, in pixels.

Provides data for the MiracastReceiverSession.Disconnected event.

Returns the MiracastReceiverConnection object of the connection that has been disconnected.

The MiracastReceiverConnection object of the connection that has been disconnected.

Specifies the reason why the app decided to disconnect the Miracast connection.

An error occurred in the app.

The user refused the Miracast connection.

The user requested to stop streaming.

The app was unable to start streaming, for example, a connection error.

The stream ended without error.

Streaming failed due to an error in decoding the audio or video data.

Streaming failed due to an error related to decrypting of the audio or video data.

The app encountered an error while streaming was in progress. The error was not related to decoding or decrypting of the data.

Represents a Game Controller input device for use with Miracast, such as a gamepad, joystick, or steering wheel.

Indicates if the Miracast Transmitter is willing to receive input from a game controller device.

True if the Miracast Transmitter is willing to receive input from a game controller device.

Indicates if the Miracast Receiver is currently transmitting input from a game controller device to the Miracast Transmitter.

True if the Miracast Receiver is currently transmitting input from a game controller device to the Miracast Transmitter.

Specifies how game controller input is being used when transmitted to a Miracast Transmitter. Game controller input can be transmitted as-is, or it can be mapped to mouse and keyboard input.

The current MiracastReceiverGameControllerDeviceUsageMode value.

Controls if the Miracast Receiver offers to transmit game controller input to the Miracast Transmitter.

True if the Miracast Receiver offers to transmit game controller input to the Miracast Transmitter.

An event which is raised when any of the properties on the MiracastReceiverGameControllerDevice has changed.

Specifies how game controller input is being used when transmitted to a Miracast Transmitter. Game controller input can be transmitted as-is, or it can be mapped to mouse and keyboard input.

Input from the game controller is used as-is.

Input from the game controller is converted to mouse and keyboard input.

The devices from which the Miracast Receiver can collect input and transmit to the Miracast Transmitter.

Returns a Game Controller input device for use with Miracast, such as a gamepad, joystick, or steering wheel.

The Game Controller input device.

Returns a Keyboard input device for use with Miracast.

The Keyboard input device.

A Keyboard input device for use with Miracast.

Indicates if the Miracast Transmitter is willing to receive input from a keyboard device.

True if the Miracast Transmitter is willing to receive input from a keyboard device.

Indicates if the Miracast Receiver is currently transmitting input from a keyboard device to the Miracast Transmitter.

True if the Miracast Receiver is currently transmitting input from a keyboard device to the Miracast Transmitter.

Controls if the Miracast Receiver offers to transmit keyboard input to the Miracast Transmitter.

True if the Miracast Receiver offers to transmit keyboard input to the Miracast Transmitter.

An event which is raised when any of the properties on the MiracastReceiverKeyboardDevice has changed.

Describes the status of the Miracast Receiver as it pertains to its ability to listen for incoming conections.

At least one Miracast Transmitter is currently connected.

The Miracast Receiver has received an incoming connection and is waiting for the app to accept or reject the connection.

The Miracast Receiver has been disabled by administrative policy.

The Miracast Receiver is listening for incoming connections.

The Miracast Receiver is not currently listening for incoming connections.

The Miracast Receiver is temporarily disabled while other network activity is in progress.

Provides data for the MiracastReceiverSession.MediaSourceCreated event.

Returns the MiracastReceiverConnection object of the associated connection.

The MiracastReceiverConnection object.

Returns an object for configuring the settings of the optional cursor image channel.

The MiracastReceiverCursorImageChannelSettings object.

Returns a MediaSource object for playing the audio and video data that is being sent by the Miracast Transmitter.

The MediaSource object.

Defers completion of the MiracastReceiverSession.MediaSourceCreated event until Deferral.Complete is invoked.

The Deferral object.

An object which encapsulates functionality related to receiving incoming Miracast connections.

Specifies if the app allows a new connection to take over an in-progress Miracast Connection.

True if the app allows a new connection is allowed to take over an in-progress connection.

Specifies the maximum number of simultaneous connections that the app is willing to handle on the MiracastReceiverSession.

The maximum number of simultaneous connections that the app is willing to handle on the MiracastReceiverSession.

An event which is raised when a new incoming MiracastReceiverConnection is received.

An event which is raised when a MiracastReceiverConnection has been disconnected by the Miracast Transmitter.

An event which is raised when the MediaSource object for a MiracastReceiverConnection has been created.

Closes the MiracastReceiverSession object and disconnects any associated MiracastReceiverConnection objects.

Start listening for incoming Miracast connections.

The result of the operation.

Start listening for incoming Miracast connections.

The result of the operation.

Represents the result of attempting to start the MiracastReceiverSession.

Gets the extended error code for the MiracastReceiverSessionStartResult.

The error code.

Returns the status of a Start or StartAsync operation.

The status of the operation.

The status of a Start or StartAsync operation.

The app is not allowed to start a Miracast Receiver Session.

The Miracast Receiver Session cannot start because Miracast is not supported on the current device.

The Miracast Receiver started successfully.

The Miracast Receiver Session could not be started due an unknown error.

An object with configuration settings for the MiracastReceiver.

Specifies the desired authorization method for incoming Miracast connections.

The desired authorization method for incoming Miracast connections.

Specifies the friendly name of the MiracastReceiver.

The friendly name of the Miracast Receiver.

A human-readable string that specifies the model name of the Miracast Receiver app.

The model name of the Miracast Receiver app.

A human-readable string that specifies the model number or other version information of the Miracast Receiver app.

The model number or other version information of the Miracast Receiver app.

Specifies if authorization should be required by Miracast Transmitters that are already known to the Miracast Receiver.

True if authorization should be required by Miracast Transmitters that are already known to the Miracast Receiver.

An object which provides information about the current status of the MiracastReceiver.

Specifies if it is possible to let a new Miracast connection take over an in-progress Miracast connection.

True if it is possible to let a new Miracast connection take over an in-progress Miracast connection.

Returns the collection of Miracast Transmitters that are currently known to the MiracastReceiver.

The collection of Miracast Transmitters that are currently known to the Miracast Receiver.

Returns a value that describes the status of the Miracast Receiver as it pertains to its ability to listen for incoming conections.

Describes the status of the Miracast Receiver as it pertains to its ability to listen for incoming conections.

Specifies the maximum number of simultaneous connections that the Miracast Receiver can handle.

The maximum number of simultaneous connections that the Miracast Receiver can handle.

Returns status information about the Miracast Receiver's Wi-Fi functionality.

Status information about the Miracast Receiver's Wi-Fi functionality.

An object which encapsulates functionality for controlling properties of the audio and video streams.

Specifies whether the Miracast Transmitter should mute the audio stream. The default value is false.

True if the Miracast Transmitter should mute the audio stream.

Returns an object representing the current settings for the video stream.

The current settings for the video stream.

Returns an object representing the current settings for the video stream.

The current settings for the video stream.

Suggests an appropriate width, height and bitrate to the Miracast Transmitter.

A MiracastReceiverVideoStreamSettings object representing the suggested settings.

Asynchronously suggests an appropriate width, height and bitrate to the Miracast Transmitter.

A MiracastReceiverVideoStreamSettings object representing the suggested settings. An asynchronous task.

An object which describes settings for the video stream.

Specifies the bit rate, in bits per second, of the video stream.

The bit rate, in bits per second, of the video stream.

Specifies the width and height of the video stream, in pixels.

The width and height of the video stream, in pixels.

Status information about the Miracast Receiver's Wi-Fi functionality.

Miracast is not supported. Possible cause is a missing or incompatible Wi-Fi adapter.

Miracast is supported.

Miracast is supported but the Wi-Fi adapter was not designed for Miracast, which can result in compatibility problems.

It has not been determined if the Wi-Fi adapter supports Miracast.

An object that represent a Miracast Transmitter.

Returns the Miracast Transmitter's current authorization status.

The Miracast Transmitter's current authorization status.

Returns the time at which this Miracast Transmitter most recently connected.

The time at which this Miracast Transmitter most recently connected.

Returns the Miracast Transmitter's Wi-Fi MAC address.

The Miracast Transmitter's Wi-Fi MAC address.

Returns the name of the Miracast Transmitter.

The name of the Miracast Transmitter.

Returns a collection of MiracastReceiverConnection objects that are associated with the current Miracast Transmitter.

A collection of MiracastReceiverConnection objects that are associated with the current Miracast Transmitter.

Specifies the authorization status of a Miracast Transmitter.

Connections from this transmitter are allowed.

Connections from this transmitter are allowed, but always ask the user to confirm a new connection.

All connection attempts from this transmitter are automatically rejected.

A decision has not yet been made about whether to allow or block this transmitter.

Provides optical character recognition (OCR) functionality.

Returns a collection of all available OCR languages on the device.

A collection of all available OCR languages on the device.

Gets the maximum image pixel dimensions supported by the OCR engine.

The maximum image pixel dimensions supported by the OCR engine.

Gets the language being used for text recognition.

The language being used for text recognition.

Returns true if a specified language can be resolved to any of the available OCR languages. See language matching for a further explanation of language resolving.

The language being used for text recognition. TRUE, if the specified language can be resolved to any of the available OCR languages; otherwise, FALSE.

Scans the specified image for text in the language specified by the RecognizerLanguage property.

Represents an uncompressed bitmap. The result of the OCR that was initiated by the OcrEngine object.

Creates a new instance of the OcrEngine class.

The language being used for text recognition. If the specified language can be resolved to any of the OCR languages available on the device, returns new instance of **OcrEngine** class, otherwise returns **null**. See language matching for a further explanation of language resolving.

Creates a new instance of the OcrEngine class.

If any language from **GlobalizationPreferences.Languages** can be resolved to any of the available OCR languages returns new instance of **OcrEngine** class, otherwise returns **null**.

Represents a single line of text recognized by the OCR engine and returned as part of the OcrResult.

Gets the text of the recognized line.

The text of the recognized line.

Gets the collection of OcrWord objects that represents the words detected in the current line of text by the RecognizeAsync method.

The collection of OcrWord objects that represents the words detected in the current line of text by the RecognizeAsync method.

Contains the results of Optical Character Recognition (OCR).

Gets the collection of OcrLine objects that represents the lines of text detected in the image by the RecognizeAsync method.

The collection of OcrLine objects that represents the lines of text detected in the image by the RecognizeAsync method.

Gets the recognized text.

The recognized text.

Gets the clockwise rotation of the recognized text, in degrees, around the center of the image.

The clockwise rotation of the recognized text, in degrees, around the center of the image. If the angle of the text can't be detected, the value of this property is **null**. If the image contains text at different angles, only part of the text will be recognized correctly.

Represents a single word in a line of text recognized by the OCR engine and returned as part of the OcrLine.

Gets the position and size in pixels of the recognized word from the top left corner of image when the value of TextAngle property is 0 (zero).

The position and size in pixels of the recognized word from the top left corner of image when the value of TextAngle property is 0 (zero).

Gets the text of the recognized word.

The text of the recognized word.

Specifies the kinds of metadata that can be automatically displayed for a MediaPlaybackItem. Set the type of data you want to be automatically loaded by assigning one of these values to the AutoLoadedDisplayProperties properties.

Metadata should be automatically displayed for music content.

Metadata should be automatically displayed for music or video content.

No metadata should be automatically displayed.

Metadata should be automatically displayed for video content.

Provides access to the media player while it is running in the background.

Use MediaPlayer instead of BackgroundMediaPlayer. For more info, see MSDN.

Gets the current instance of the background media player.

The current instance of the background media player.

Occurs when a message is received from the background task.

Occurs when a message is received from the foreground task.

Returns a Boolean value indicating if other media is currently playing on the device.

Use MediaPlayer instead of BackgroundMediaPlayer. For more info, see MSDN. Boolean value indicating if other media is currently playing on the device.

Sends a message to the background media player.

Use MediaPlayer instead of BackgroundMediaPlayer. For more info, see MSDN. Set of values representing the message.

Sends a message to the foreground task.

Use MediaPlayer instead of BackgroundMediaPlayer. For more info, see MSDN. Set of values representing the message.

Shuts down the current background media player.

Use MediaPlayer instead of BackgroundMediaPlayer. For more info, see MSDN.

Provides data for the MediaPlaybackList.CurrentItemChanged event.

Gets the new current MediaPlaybackItem.

The new current MediaPlaybackItem.

Gets the previous current MediaPlaybackItem.

The previous current MediaPlaybackItem.

Gets the reason why the current MediaPlaybackItem in a MediaPlaybackList changed, such as if the previous item completed playback successfully or if there was an error playing back the previous item.

The reason why the current MediaPlaybackItem in a MediaPlaybackList changed.

Indicates the type of media stream that failed.

The failed stream contains audio.

The stream type is unknown.

The failed stream contains video.

The interface implemented by classes that are Media Engine playback sources.

Use MediaPlayer instead of MediaEngine. For more info, see MSDN.

Gets the current playing MediaPlaybackItem.

The current playing MediaPlaybackItem.

Sets the media playback source.

Use MediaPlayer instead of MediaEngine. For more info, see MSDN. The media playback source.

A marker interface that identifies the implementing class as a playback source.

Represents a set of one or more MediaPlaybackItem objects that are played before, after, or at specified points during the playback of another MediaPlaybackItem.

Initializes a new instance of the MediaBreak class with the specified insertion method.

A value indicating whether the media break will pause the currently playing media content.

Initializes a new instance of the MediaBreak class with the specified insertion method and presentation position.

A value indicating whether the media break will pause the currently playing media content. The position within the playback of a MediaPlaybackItem at which the MediaBreak will be played.

Gets or sets a value indicating whether the MediaBreak can be played.

True if the MediaBreak can be played; otherwise false.

Gets a map of key/value pairs that allow you to associate custom data with a MediaBreak.

A map of key/value pairs that allow you to associate custom data with a MediaBreak.

Gets a value indicating whether the media break will interrupt the main content, causing the main content to pause while it is played, or if it will replace the main content.

A value indicating whether the media break will interrupt the main contentTBD

Gets the MediaPlaybackList containing the MediaPlaybackItem objects that will be played as part of the MediaBreak.

The MediaPlaybackList containing the MediaPlaybackItem objects that will be played as part of the MediaBreak.

Gets the position within the playback of a MediaPlaybackItem at which the MediaBreak will be played.

The position within the playback of a MediaPlaybackItem that the MediaBreak will be played.

Provides data for the MediaBreakManager.BreakEnded event, which occurs when the playback of a MediaBreak has ended.

Gets the MediaBreak for which playback has ended.

The MediaBreak for which playback has ended.

Specifies the method that is used to insert the MediaBreak playback into the playback of the MediaPlaybackItem to which it belongs.

The main content is paused while the content of the MediaBreak plays.

The main content is not paused, but is replaced by the content of the MediaBreak.

Provides information about and control over the MediaBreak objects associated with a MediaPlayer. This class provides events for when a media break starts playback, ends playback, is skipped, or is seeked over. You can also use this class to determine the currently playing MediaBreak or to start or skip playback of a MediaBreak.

Gets the MediaBreak that is currently being played by the MediaPlayer.

The MediaBreak that is currently being played by the MediaPlayer.

Gets the MediaPlaybackSession associated with the MediaBreakManager.

The MediaPlaybackSession associated with the MediaBreakManager.

Occurs when a MediaBreak ends playback.

Occurs when a MediaBreak is skipped.

Occurs when the user seeks the media playback position past one or more pending media breaks.

Occurs when playback of a MediaBreak starts.

Directs the MediaPlayer to begin playing the specified MediaBreak immediately.

The MediaBreak to be played.

Directs the MediaPlayer to skip over the current MediaBreak.

Represents a set of MediaBreak objects associated with a MediaPlaybackItem and the positions within the playback of the item that the media breaks are played.

Gets the schedule's current list of MediaBreak objects that will be played at a point during the playback of the MediaPlaybackItem with which the MediaBreakSchedule is associated.

The schedule's current list of MediaBreak objects that will be played at a position within the playback of the MediaPlaybackItem with which the schedule is associated.

Gets the MediaPlaybackItem with which the MediaBreakSchedule is associated.

The MediaPlaybackItem with which the MediaBreakSchedule is associated.

Gets or sets the MediaBreak to be played after the MediaPlaybackItem associated with the MediaBreakSchedule plays.

The MediaBreak to be played after the MediaPlaybackItem associated with the MediaBreakSchedule plays.

Gets or sets the MediaBreak to be played before the MediaPlaybackItem associated with the MediaBreakSchedule plays.

The MediaBreak to be played before the MediaPlaybackItem associated with the MediaBreakSchedule plays.

Occurs when the MediaBreakSchedule changes.

Adds a MediaBreak to the schedule that will be played at a point during the playback of the MediaPlaybackItem with which the MediaBreakSchedule is associated.

The MediaBreak to add to the schedule.

Removes a midroll MediaBreak from the MediaBreakSchedule.

The MediaBreak to remove from the schedule.

Provides data for the MediaBreakManager.BreaksSeekedOver event, which occurs when the user seeks the media playback position past one or more pending media breaks.

Gets the new current position within the MediaPlaybackItem after the seek operation has completed.

The new current position within the MediaPlaybackItem after the seek operation has completed.

Gets the previous position within the MediaPlaybackItem before the seek operation started.

The previous position within the MediaPlaybackItem before the seek operation started.

Gets the list of MediaBreak objects that were seeked over, meaning that they were scheduled to play between the OldPosition and NewPosition of the seek operation.

The list of MediaBreak objects that were seeked over.

Provides data for the MediaBreakManager.BreakSkipped event, which occurs when the playback of a MediaBreak is skipped.

Gets the MediaBreak that was skipped.

The MediaBreak that was skipped.

Provides data for the MediaBreakManager.BreakStarted event, which occurs when the playback of a MediaBreak starts.

Gets the MediaBreak that triggered the MediaBreakManager.BreakStarted event.

The MediaBreak that triggered the MediaBreakManager.BreakStarted event.

Specifies a rule for enabling a System Media Transport Controls command.

The command is always enabled.

The system dynamically determines whether the command is enabled.

The command is never enabled.

Defines a set of metadata for a MediaPlaybackItem that is displayed in the System Media Transport Controls while the item is playing.

Gets the metadata for a music item that will be displayed by the System Media Transport Controls when the item is played.

The display metadata for a music item.

Gets or sets the thumbnail image for a MediaPlaybackItem that will be displayed by the System Media Transport Controls when the item is played.

A stream containing the thumbnail image data for a MediaPlaybackItem.

Gets or sets a value indicating the type of media that is represented by the MediaPlaybackItem, such as audio or video.

A value indicating the type of media that is represented by the MediaPlaybackItem.

Gets the metadata for a video item that will be displayed by the System Media Transport Controls when the item is played.

The display metadata for a video item.

Clears the values of all media item display properties.

Represents a read-only list of AudioTrack objects, of which a single track can be selected at one time.

Gets or sets the index of the currently selected audio track in the list.

The index of the currently selected audio track in the list.

Gets the number of audio tracks in the list.

The number of audio tracks in the list.

Occurs when the index of the currently selected audio track changes.

Returns an iterator that iterates over the items in the collection.

The iterator.

Returns the audio track at the specified index.

The zero-based index of the audio track. The audio track at the specified index.

Retrieves the audio tracks that start at the specified index in the list.

The zero-based index of the start of the audio tracks in the list. The audio tracks that start at *startIndex* in the list. The number of audio tracks retrieved.

Retrieves the index of a specified audio track in the list.

The audio track to find in the vector view. If the audio track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. True if the audio track is found; otherwise, false.

Specifies the behavior of and receives events from the System Media Transport Controls. Use this class to customize the interaction between a MediaPlayer and the System Media Transport Controls.

Gets an object that defines the behavior when the **Auto-repeat** control in the System Media Transport Controls is toggled.

An object that defines the behavior when the **Auto-repeat** control is toggled.

Gets an object that defines the behavior when the **Fast-forward** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Fast-forward** button is tapped.

Gets or sets a value indicating whether the MediaPlaybackCommandManager is enabled.

True if the MediaPlaybackCommandManager is enabled; otherwise, false.

Gets the MediaPlayer instance associated with the MediaPlaybackCommandManager.

The MediaPlayer instance associated with the MediaPlaybackCommandManager.

Gets an object that defines the behavior when the **Next** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Next** button is tapped.

Gets an object that defines the behavior when the **Pause** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Pause** button is tapped.

Gets an object that defines the behavior when the **Play** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Pause** button is tapped.

Gets an object that defines the behavior when the playback position control in the System Media Transport Controls is moved.

An object that defines the behavior when the playback position control is moved.

Gets an object that defines the behavior when the **Previous** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Previous** button is tapped.

Gets an object that defines the behavior when the playback rate is changed using the System Media Transport Controls.

An object that defines the behavior when the playback rate is changed.

Gets an object that defines the behavior when the **Rewind** button in the System Media Transport Controls is tapped.

An object that defines the behavior when the **Rewind** button is tapped.

Gets an object that defines the behavior when the **Shuffle** button in the System Media Transport Controls is toggled.

An object that defines the behavior when the **Shuffle** button is toggled.

Occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls.

Occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls.

Occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls.

Occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls.

Occurs when the command manager receives a command from the **Play** control of the System Media Transport Controls.

Occurs when the command manager receives a command changing the current playback position from the System Media Transport Controls.

Occurs when the command manager receives a command from the **Previous** button of the System Media Transport Controls.

Occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls.

Occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls.

Occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls.

Provides data or the MediaPlaybackCommandManager.AutoRepeatModeReceived event, which occurs when the command manager receives a command from the **Auto-repeat** control of the System Media Transport Controls.

Gets a value indicating the current auto-repeat mode.

A value indicating the current auto-repeat mode.

Gets or sets a value indicating whether the AutoRepeatModeReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Auto-repeat** command.

The deferral object.

For use with a MediaPlaybackCommandManager object, this class allows you to enable and disable System Media Transport Controls commands and allows you to respond to changes in the enabled state of a command.

Gets the MediaPlaybackCommandManager associated with the behavior.

The command manager associated with the behavior.

Gets or sets a value indicating whether a System Media Transport Controls command should always be enabled, should never be enabled, or if the system should automatically determine whether the command is enabled.

A value defining the rule for enabling a System Media Transport Controls command.

Gets a value indicating whether a System Media Transport Controls command is currently enabled.

True if the command is currently enabled; otherwise, false.

Occurs when the enabled state of a System Media Transport Controls command changes.

Provides data or the MediaPlaybackCommandManager.FastForwardReceived event, which occurs when the command manager receives a command from the **Fast-forward** button of the System Media Transport Controls.

Gets or sets a value indicating whether the FastForwardReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Fast-forward** command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.NextReceived event, which occurs when the command manager receives a command from the **Next** button of the System Media Transport Controls.

Gets or sets a value indicating whether the NextReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Next** command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.PauseReceived event, which occurs when the command manager receives a command from the **Pause** button of the System Media Transport Controls.

Gets or sets a value indicating whether the PauseReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Pause** command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.PlayReceived event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls.

Gets or sets a value indicating whether the PlayReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Play** command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.PositionReceived event, which occurs when the command manager receives a command changing the current position from the System Media Transport Controls.

Gets or sets a value indicating whether the PositionReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a value indicating the current playback position.

A value indicating the current playback position.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the change position command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.PreviousReceived event, which occurs when the command manager receives a command from the **Play** button of the System Media Transport Controls.

Gets or sets a value indicating whether the PreviousReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Previous** command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.RateReceived event, which occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls.

Gets or sets a value indicating whether the RateReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a value indicating the current playback rate.

A value indicating the current playback rate.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the change rate command.

The deferral object.

Provides data or the MediaPlaybackCommandManager.RewindReceived event, which occurs when the command manager receives a command from the **Rewind** button of the System Media Transport Controls.

Gets or sets a value indicating whether the RewindReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Rewind** command.

The deferral object.

Provides data or the ShuffleReceived event, which occurs when the command manager receives a command from the **Shuffle** control of the System Media Transport Controls.

Gets or sets a value indicating whether the ShuffleReceived event has been handled.

True if the event has been handled; otherwise, false.

Gets a value indicating whether shuffle mode is requested.

True if shuffle mode is requested; otherwise, false.

Gets a Deferral object that causes the system to wait for you to perform asynchronous operations, such as creating a new MediaPlaybackItem from a network source, before it continues processing the **Shuffle** command.

The deferral object.

Represents a media item that can be played back. This class acts as a wrapper around a MediaSource that exposes the audio tracks, video tracks, and timed metadata tracks included in the media source.

Initializes a new instance of the MediaPlaybackItem class.

The media source from which the MediaPlaybackItem is created.

Initializes a new instance of the MediaPlaybackItem class with a StartTime value indicating the position within the item where playback should begin.

The media source from which the MediaPlaybackItem is created. The position within the MediaPlaybackItem where playback should begin.

Initializes a new instance of the MediaPlaybackItem class with a StartTime value indicating the position within the item where playback should begin and a DurationLimit value specifying the maximum playback duration of the item.

The media source from which the MediaPlaybackItem is created. The position within the MediaPlaybackItem where playback should begin. The maximum playback duration of the MediaPlaybackItem.

Gets a read-only list of audio tracks in the MediaSource associated with the MediaPlaybackItem.

The read-only list of audio tracks.

Gets or sets a value that specifies for which types of media content, if any, the system should automatically load metadata to display in the System Media Transport Controls.

A value that specifies for which types of media content the system should automatically load and display metadata.

Gets the MediaBreakSchedule defining the schedule of media breaks for the MediaPlaybackItem.

The MediaBreakSchedule defining the schedule of media breaks for the MediaPlaybackItem.

Gets or sets a value indicating whether the MediaPlaybackItem can be skipped.

True if the MediaPlaybackItem can be skipped; otherwise, false.

Gets the maximum playback duration of the MediaPlaybackItem.

The maximum playback duration of the MediaPlaybackItem.

Gets or sets a value that specifies whether a MediaPlaybackItem is disabled in a MediaPlaybackList.

True if the media playback item is disabled in the playback list; otherwise, false.

Gets the MediaSource object associated with the MediaPlaybackItem.

The MediaSource object associated with the MediaPlaybackItem.

Gets the position within the MediaPlaybackItem where playback should begin.

The position within the MediaPlaybackItem where playback should begin.

Gets a read-only list of timed metadata tracks in the MediaSource associated with the MediaPlaybackItem.

The read-only list of timed metadata tracks.

Gets a value that indicates the proportion of the data for the **MediaPlaybackItem** that is currently downloaded.

A value, between 0 and 1.0, that indicates the total download progress of the **MediaPlaybackItem** where 0 means that none of the data has been downloaded and 1.0 means that all of the data has been downloaded.

Gets a read-only list of video tracks in the MediaSource associated with the MediaPlaybackItem.

The read-only list of video tracks.

Occurs when the list of audio tracks in the MediaSource associated with the MediaPlaybackItem changes.

Occurs when the list of timed metadata tracks in the MediaSource associated with the MediaPlaybackItem changes.

Occurs when the list of video tracks in the MediaSource associated with the MediaPlaybackItem changes.

Updates the display properties for the MediaPlaybackItem. These properties are used by the System Media Transport Controls to display information about the currently playing media item.

The display properties to apply to the MediaPlaybackItem.

Retrieves the MediaPlaybackItem associated with the provided MediaSource.

The MediaSource associated with the MediaPlaybackItem. The MediaPlaybackItem associated with the provided MediaSource.

Gets the display properties for a MediaPlaybackItem.

The display properties for a MediaPlaybackItem.

Specifies the reason why the current MediaPlaybackItem in a MediaPlaybackList changed. Check for the reason by accessing the Reason property of the CurrentMediaPlaybackItemChangedEventArgs object passed into the MediaPlaybackList.CurrentItemChanged event.

The current item changed because the app initiated the change.

The current item changed because the previous item in the list played successfully to the end of its media stream.

The current item changed because there was an error playing back the previous item in the list.

The current item is the first item in the playback list.

Represents an error that occurred trying to resolve a MediaPlaybackItem.

Gets the error code associated with the playback item error.

The error code associated with the playback item error.

Gets the extended error code for the MediaPlaybackItem error.

The error code.

Specifies the type of error that occurred while opening a MediaPlaybackItem.

Opening of the playback item was aborted.

An error occurred while decoding the playback item.

An error occurred related to the playback item's encryption.

A network error occurred while opening the playback item.

No error code.

The media source of the playback item is not supported.

Provides data for the MediaPlaybackList.ItemFailed event.

Gets a wrapper object for the MediaPlaybackItem error that provides high-level information about the cause of the error.

A wrapper object for the MediaPlaybackItem error.

Gets the MediaPlaybackItem associated with the error.

The MediaPlaybackItem associated with the error.

Provides data for the MediaPlaybackList.ItemOpened event.

Gets the MediaPlaybackItem that was successfully opened.

The MediaPlaybackItem that was successfully opened.

Represents a list of MediaPlaybackItem objects that can be played back. Provides methods for switching the currently playing item and enabling looping and shuffling.

Initializes a new instance of the MediaPlaybackList class.

Gets or sets a value indicating whether the playback list will loop when the end of the list is reached.

True if auto-repeat is enabled; otherwise, false.

Gets the currently playing MediaPlaybackItem.

The currently playing MediaPlaybackItem.

Gets the index of the current item in theMediaPlaybackList.

The index of the current item in theMediaPlaybackList.

Gets an IObservableVector representation of the playback list.

An IObservableVector representation of the playback list.

Gets or sets a value that specifies the number of MediaPlaybackItem objects that should be kept open after they have been played.

A value that specifies the number of MediaPlaybackItem objects that should be kept open after they have been played.

Gets or sets the maximum time before a MediaPlaybackItem in the list is expected to play that the media content associated with the item is retrieved.

The maximum time before a MediaPlaybackItem in the list is expected to play that the media content associated with the item is retrieved.

Gets a read-only list of MediaPlaybackItem objects that will be played in shuffle mode, in the order in which they will be played.

A read-only list of MediaPlaybackItem objects that will be played in shuffle mode

Gets or sets a value indicating whether the items in the playback list are played in a random order.

True if shuffle is enabled; otherwise, false.

Gets or sets the MediaPlaybackItem that will be played first.

The MediaPlaybackItem that will be played first.

Occurs when the currently playing MediaPlaybackItem changes.

Occurs when an error is encountered with a MediaPlaybackItem in the playback list.

Occurs when a MediaPlaybackItem in the playback list is successfully opened.

Changes the current item of the MediaPlaybackList to the next item in the list.

The new current MediaPlaybackItem.

Changes the current item of the MediaPlaybackList to the previous item in the list.

The new current MediaPlaybackItem.

Changes the current item of the MediaPlaybackList to the item with the specified index.

The index of the item to make current. The new current MediaPlaybackItem.

Sets the list of MediaPlaybackItem objects that will be played in shuffle mode, in the order in which they will be played.

The list of MediaPlaybackItem objects that will be played in shuffle mode.

Provides information about the state of the current playback session of a MediaPlayer and provides events for responding to changes in playback session state.

Gets a value that indicates the current buffering progress of a MediaPlaybackSession.

The current buffering progress. The value ranges from 0 to 1.0. Multiply by 100 to obtain a percentage.

Gets a value that indicates whether media can be paused if the MediaPlayer.Pause method is called.

True if the media can be paused; otherwise, false.

Gets a value that indicates whether the current playback position of the media can be changed by setting the value of the MediaPlayer.Position property.

True if the current playback position of the media can be changed; otherwise, false.

Gets a value indicating the position after the current playback Position to which downloading has completed and content is buffered.

A value indicating the position after the current playback Position to which downloading has completed and content is buffered. The value ranges from 0 to 1. Multiply by 100 to obtain a percentage.

Gets or sets a value indicating whether the content of the media playback session is currently being mirrored horizontally.

True if the content of the media playback session is currently being mirrored horizontally; otherwise, false.

Gets a value that indicates whether the media that is currently playing in the MediaPlaybackSession is protected by digital rights management (DRM).

True if the currently playing media is protected by DRM; otherwise, false.

Gets the MediaPlayer associated with the MediaPlaybackSession.

The MediaPlayer associated with the MediaPlaybackSession.

Gets a value indicating the duration of the currently playing media, when being played back at normal speed.

The duration of the currently playing media.

Gets the height of the video in the currently playing media item.

The height of the video in the currently playing media item, in pixels.

Gets the width of the video in the currently playing media item.

The width of the video in the currently playing media item, in pixels.

Gets or sets a normalized rectangle within the video source which is rendered by the MediaPlayer. This enables pan and zoom within video.

A normalized rectangle specifying the rectangle within the source video that is rendered by the MediaPlayer.

Gets or sets a value representing the current playback rate for the MediaPlaybackSession.

The current playback rate for the MediaPlaybackSession.

Gets or sets a value from the MediaRotation enumeration that specifies the rotation applied to video content during playback.

The rotation applied to video content during playback.

Gets a value indicating the current playback state of the MediaPlaybackSession, such as buffering or playing.

The current playback state of the MediaPlaybackSession

Gets or sets the current playback position within the currently playing media.

The current playback position within the currently playing media.

Gets an object that manages the spherical video projection settings used by the media playback session.

An object that manages the spherical video projection settings used by the media playback session.

Gets or sets a value specifying the stereoscopic video packing mode for the MediaPlaybackSession.

The stereoscopic video packing mode

Occurs when the set of time ranges for which data is buffered changes.

Occurs when buffering ends for the MediaPlaybackSession.

Occurs when the buffering progress for the MediaPlaybackSession changes.

Occurs when buffering starts for the MediaPlaybackSession.

Occurs when the download progress for a MediaPlaybackSession changes.

Occurs when the duration of the currently playing media item changes.

Occurs when the size of the video in the currently playing media item changes.

Occurs when the current playback rate for the MediaPlaybackSession changes.

Occurs when the current playback state changes.

Occurs when the set of time ranges that have been played changes.

Occurs when the current playback position within the currently playing media changes.

Occurs when the set of time ranges that can be seeked to changes.

Occurs when a seek operation for the MediaPlaybackSession completes.

Occurs when the set of playback rates supported by the media playback session changes.

Retrieves a read-only list of time ranges for which data is buffered and playback can begin immediately.

A read-only list of time ranges.

Gets an object that expresses the current output degradation policy state of the MediaPlaybackSession.

A MediaPlaybackSessionOutputDegradationPolicyState object that expresses the current output degradation policy state.

Retrieves a read-only list of time ranges for which content has been played back.

A read-only list of time ranges.

Retrieves a read-only list of time ranges in which the playack position can be seeked to. For live streaming, these ranges represent the times ranges for which data is still available.

A read-only list of time ranges.

Gets a value indicating whether the specified range of playback rates is supported.

The lower bound of the playback rate range for which support is queried. The upper bound of the playback rate range for which support is queried. True if the playback range is supported; otherwise, false.

Provides data for the BufferingStarted event of a MediaPlaybackSession.

Gets a value indicating whether the buffering that triggered the event was expected by the system, such as when a new item begins playing or after the user seeks to a new position in the media item, or if it was an unexpected interruption, such as when buffering is caused by degradation of the network connection.

True if the buffering represents an unexpected playback interruption. False if the buffering was an expected result of normal playback operations.

Expresses the current output degradation policy state of a MediaPlaybackSession.

Gets a value from the MediaPlaybackSessionVideoConstrictionReason enumeration specifying the reason why video is being constricted, if known.

The reason why video is being constricted.

Specifies the policy-based reason that video output of a media item is constricted.

The content is being rendered in a MediaPlayer with IsVideoFrameServerEnabled, providing direct access to video frames to the app.

The content is not currently being constricted.

Output protection for the content failed.

The reason is unknown.

The content is being displayed by a device with an unsigned driver.

The content is being displayed on an unsupported display adapter.

The content is being played back on a virtual machine.

Manages the spherical video projection settings for a MediaPlaybackSession.

Gets or sets a value that specifies the frame format used for spherical video projection.

A value that specifies the frame format used for spherical video projection.

Gets or sets the horizontal field of view, expressed in degrees, used for spherical video projection.

The horizontal field of view, expressed in degrees

Gets or sets a value indicating whether spherical video projection is enabled.

True if spherical video projection is enabled. Otherwise, false.

Gets or sets a value that specifies the projection mode used for spherical video.

A value that specifies the projection mode used for spherical video.

Gets or sets a quaternion that specifies the current view orientation used to project spherical video.

The current view orientation.

Specifies the playback state of a MediaPlaybackSession.

A media item is buffering.

No current state.

A media item is opening.

Playback of a media item is paused.

A media item is playing.

Represents a read-only list of TimedMetadataTrack objects.

Gets the number of timed metadata tracks in the list.

the number of timed metadata tracks in the list.

Occurs when the presentation mode of the MediaPlaybackTimedMetadataTrackList changes.

Returns an iterator that iterates over the items in the collection.

The iterator.

Returns the timed metadata track at the specified index.

The zero-based index of the timed metadata track. The timed metadata track at the specified index.

Retrieves the timed metadata tracks that start at the specified index in the list.

The zero-based index of the start of the timed metadata tracks in the list. The timed metadata tracks that start at *startIndex* in the list. The number of timed metadata tracks retrieved.

Gets the presentation mode of the timed metadata track with the specified index.

The index of the timed metadata track for which the presentation mode is queried. The presentation mode.

Retrieves the index of a specified timed metadata track in the list.

The timed metadata track to find in the vector view. If the timed metadata track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. True if the timed metadata track is found; otherwise, false.

Sets the presentation mode of the timed metadata track with the specified index.

The index of the timed metadata track for which the presentation mode is set. The presentation mode to set.

Represents a read-only list of VideoTrack objects, of which a single track can be selected at one time.

Gets or sets the index of the currently selected video track in the list.

The index of the currently selected video track in the list.

Gets the number of video tracks in the list.

The number of video tracks in the list.

Occurs when the index of the currently selected video track changes.

Returns an iterator that iterates over the items in the collection.

The iterator.

Returns the video track at the specified index.

The zero-based index of the video track. The video track at the specified index.

Retrieves the video tracks that start at the specified index in the list.

The zero-based index of the start of the video tracks in the list. The video tracks that start at *startIndex* in the list. The number of video tracks retrieved.

Retrieves the index of a specified video track in the list.

The video track to find in the vector view. If the video track is found, this is the zero-based index of the audio track; otherwise, this parameter is 0. True if the video track is found; otherwise, false.

Provides access to media playback functionality such as play, pause, fast-forward, rewind, and volume.

Initializes a new instance of the MediaPlayer object.

Gets or sets a ratio of volume across stereo speakers.

The ratio of volume across speakers in the range between -1 and 1. The default value is 0.

Gets or sets the type of audio that is currently being played.

The type of audio that is currently being played.

Gets or sets the DeviceInformation object representing audio device used by the MediaPlayer to render audio.

The DeviceInformation object representing audio device used by the MediaPlayer to render audio.

Gets or sets a value that describes the primary usage of the device that is being used to play back audio.

The audio device type.

Gets an AudioStateMonitor object that allows a UWP app to determine if any of the app's audio streams are currently being muted or having their volume reduced by the system.

An AudioStateMonitor object.

Gets or sets a Boolean value indicating if playback automatically starts after the media is loaded.

True is playback start automatically, otherwise false.

Gets the MediaBreakManager associated with the MediaPlayer, which provides information about and control over media breaks for the player.

The MediaBreakManager associated with the MediaPlayer.

Gets the amount of buffering that is completed for the media content, expressed as a percentage.

The amount of buffering that is completed for the media content.

Gets a Boolean value indicating if the media can be paused.

True if the media can be paused, otherwise false.

Gets a Boolean value indicating if the media supports seeking to a specific position.

True if the media supports seeking, otherwise false.

Gets the MediaPlaybackCommandManager associated with the MediaPlayer, which specifies the behavior of and receives events from the System Media Transport Controls.

The MediaPlaybackCommandManager associated with the MediaPlayer.

Gets the current state of media playback.

The current state of media playback.

Gets or sets a Boolean value indicating if the media will playback in a repeating loop.

True is looping is enabled, otherwise false.

Gets or sets a Boolean value indicating if the audio is muted.

True if the audio is muted, otherwise false.

Gets a Boolean value indicating if the content is protected by a digital rights management system.

True if the content is protected, otherwise false.

Gets a value indicating whether video frame server mode is enabled for the **MediaPlayer** instance.

True if video frame server mode is enabled; otherwise, false.

Get the actual duration of the media without applying the PlaybackRate.

The actual duration of the media without applying the PlaybackRate.

Gets the collection of timeline markers for the media.

The collection of timeline markers for the media.

Gets or sets the playback rate, expressed as a ratio.

The playback rate, expressed as a percentage.

Gets the MediaPlaybackSession associated with the MediaPlayer, which provides information about the state of the current playback session and provides events for responding to changes in playback session state.

The MediaPlaybackSession associated with the MediaPlayer.

Gets or sets the playback position within the media.

The playback position within the media.

Gets or sets the content protection manager for the media.

The content protection manager for the media.

Gets or sets a value that configures the MediaPlayer for real-time scenarios such as live streaming video.

True if the MediaPlayer is being used for real-time media; otherwise, false.

Sets the playback source of the media player.

The playback source of the media player.

Gets or sets a value indicating the current stereoscopic render mode.

The current stereoscopic render mode.

Gets an instance of the SystemMediaTransportControls class to enable user control of playback of the MediaPlayer and to allow the app to show information about the currently playing content in the system UI.

An instance of the SystemMediaTransportControls class.

Gets or sets the MediaTimelineController associated with the MediaPlayer. Use this property to manipulate multiple **MediaPlayer** instances with a single timeline control.

The MediaTimelineController associated with the MediaPlayer.

Gets or sets the offset applied to the position of the MediaTimelineController associated with the MediaPlayer.

The offset applied to the position of the MediaTimelineController associated with the MediaPlayer.

Get or sets the audio volume for media playback.

The audio volume for media playback. The allowed range of values is 0 to 1. Values outside of this range will be clamped.

Occurs when buffering has finished.

Occurs when buffering has started.

Occurs when the state of the media player has changed.

Occurs when the current muted status of the MediaPlayer changes.

Occurs when the media has finished playback.

Occurs when an error is encountered.

Occurs when the media is opened.

Occurs when the media playback rate has changed.

Occurs when a media marker has been reached during playback.

Occurs when a seek operation has finished.

Occurs when the media source for the MediaPlayer changes.

Occurs when the current subtitle content has changed while the MediaPlayer is in frame server mode.

Occurs when IsVideoFrameServerEnabled is set to true and a new video frame is available for processing.

Occurs when the volume of the audio has changed.

Adds an audio effect to the playback stream of the MediaPlayer.

The activatable class ID of the audio effect to add to the playback stream. A value indicating whether the effect is optional. A property set containing configuration settings for the specified audio effect.

Applies a video effect to media playback.

The identifier of the effect. Tue if the effect shouldn't block playback when the effect can't be used at run time. False if the effect should block playback when the effect can't be used at run time. A property set that transmits property values to the effect specified by *effectID*.

Closes the MediaPlayer and disposes of associated resources.

Copies the video frame currently displayed by the **MediaPlayer** to the two provided **IDirect3DSurface** objects which represent the left eye and right eye content of a stereoscopic video frame.

The surface to which the left eye content is copied. The surface to which the right eye content is copied.

Copies the current video frame from the **MediaPlayer** to the provided **IDirect3DSurface**.

The **IDirect3DSurface** to which the video frame is copied.

Copies the current video frame from the **MediaPlayer** to the specified target rectangle within the provided **IDirect3DSurface**.

The **IDirect3DSurface** to which the video frame is copied. The target rectangle within the **IDirect3DSurface** to which the video frame is copied.

Gets a CastingSource representing the MediaPlayer, which allows it's media to be cast to other devices.

The casting source.

Gets a MediaPlayerSurface object for the MediaPlayer, which allows you to render the player's contents using a Compositor without relying on the XAML framework.

The Compositor with which the returned surface will be used. The media player surface.

Pauses media playback.

Starts media playback.

Removes all effects from the playback stream of the MediaPlayer.

Requests for the system to render the current subtitle text to the provided IDirect3DSurface.

The object that implements **IDirect3DSurface** to which the subtitle text is rendered. True if the system rendered subtitles to the surface; otherwise false.

Requests for the system to render the current subtitle text to the specified target rectangle within the provided IDirect3DSurface.

The object that implements **IDirect3DSurface** to which the subtitle text is rendered. The rectangle within the provided surface within which the subtitles are rendered. True if the system rendered subtitles to the surface; otherwise false.

Set the media source to a file.

Use Source instead of SetFileSource. For more info, see MSDN. The media source file.

Sets the media source for playback.

Use Source instead of SetMediaSource. For more info, see MSDN. The media source for playback.

Sets the media source to a stream.

Use Source instead of SetStreamSource. For more info, see MSDN. The media source stream.

Sets the size of the composition surface returned by GetSurface.

An object representing the size of the composition surface.

Sets the path to the media.

Use Source instead of SetUriSource. For more info, see MSDN. The path to the media.

Causes the playback position of the MediaPlayer to move backward by .042 seconds, which corresponds to one frame at 24 fps, regardless of the actual frame rate of the content being played.

Causes the MediaPlayer to move forward in the current media by one frame.

Specifies the types of audio that can be played by a media player.

The audio is used for alerts.

The audio is used for communications.

The audio is used for game chat.

The audio is a game effect.

The audio is game media, such as background music.

The audio is for media playback.

The audio is for movie playback.

The audio type is not one of the provided enumeration values.

The audio is a sound effect.

The audio is used for speech.

Describes the primary usage of the device that is being used to play back audio. This value is used by MediaPlayer.AudioDeviceType.

The device is primarily for voice communications.

The device is a console and the audio session might support games, notifications, voice commands, and so on.

The device is intended for multimedia playback and/or recording.

Provides data for the MessageReceivedFromBackground and MessageReceivedFromForeground events.

Gets the data from the MessageReceivedFromBackground or MessageReceivedFromForeground event.

The data from the MessageReceivedFromBackground or MessageReceivedFromForeground event.

Indicates possible media player errors.

The last operation was aborted.

A media decoding error occurred.

A network error occurred.

The media type is not supported.

The error is unknown.

Provides the data for MediaFailed events.

Gets the MediaPlayerError value for the error that triggered the event.

The MediaPlayerError value for the error that triggered the event.

Gets a string describing the error that occurred.

String describing the error that occurred.

Gets an HResult that indicates any extra data about the error that occurred.

An HResult that indicates any extra data about the error that occurred.

Provides the data for MediaPlayerRateChanged events.

Gets the new playback rate for the media.

The new playback rate for the media.

Indicates the possible states that the player can be in.

Use MediaPlaybackState instead of MediaPlayerState. For more info, see MSDN.

The media player is buffering content.

The media player is closed.

The media player is opening.

The media player is paused.

The media player is playing.

Not implemented.

Provides access to a ICompositionSurface that is shared between a MediaPlayer and a Compositor to enable the rendering of **MediaPlayer** content using the Windows.UI.Composition APIs without requiring the use of the XAML framework.

Gets the ICompositionSurface for rendering MediaPlayer content.

The ICompositionSurface for rendering MediaPlayer content.

Gets the Compositor with which the surface will be used.

The Compositor with which the surface will be used.

Gets the MediaPlayer associated with the MediaPlayerSurface.

The MediaPlayer associated with the MediaPlayerSurface.

Closes the MediaPlayerSurface and disposes of associated resources.

Represents a marker at specific location in a media stream time-line.

Initializes a new instance of the PlaybackMediaMarker class with the specified offset into the media timeline.

The media marker's offset into the media timeline.

Initializes a new instance of the PlaybackMediaMarker class with the specified offset into the media timeline, type string, and text.

The media marker's offset into the media timeline. The type of the media marker. The text of the media marker.

Gets the type of the media marker.

The type of the media marker.

Gets the text associated with the marker.

The text associated with the marker.

Gets the offset in the media timeline where the marker occurs.

The offset in the media timeline where the marker occurs.

Provides data for PlaybackMediaMarkerReached events.

Gets the PlaybackMediaMarker that was reached.

The PlaybackMediaMarker that was reached.

An ordered collection of PlaybackMediaMarker objects.

Returns the number of items in the sequence.

The number of items in the sequence.

Removes all elements from the sequence.

Gets an IIterator pointing at the first PlaybackMediaMarker in the sequence.

Iterator pointing at the first media marker in the sequence.

Adds a PlaybackMediaMarker to the sequence in it's ordered position.

The media marker to insert into the sequence.

Specifies the spherical projection mode used for rendering video.

The video is rendered flat with no spherical projection.

The video is rendered using spherical projection.

Specifies the current stereoscopic render mode for a MediaPlayer.

The MediaPlayer is rendering in mono.

The MediaPlayer is rendering in stereo.

Provides data for the MediaPlaybackTimedMetadataTrackList.PresentationModeChanged event.

Gets the new presentation mode.

The new presentation mode.

Gets the old presentation mode.

The old presentation mode.

Gets the TimedMetadataTrack associated with the presentation mode change.

The TimedMetadataTrack associated with the presentation mode change.

Specifies whether a set of timed metadata tracks are listed in the XAML **MediaTransportControls, whether events are raised for data cues in the tracks, and whether any subtitles and closed captions contained in the tracks are displayed by the system, by the app, or not at all.

The timed metadata track is listed in the **MediaTransportControls**. If the metadata track contains subtitles or closed captions, they are not displayed by the platform. Cue events are raised.

The timed metadata track is not listed in the **MediaTransportControls**. If the metadata track contains subtitles or closed captions, they are not displayed by the platform. Cue events are not raised.

The timed metadata track is not listed in the **MediaTransportControls**. If the metadata track contains subtitles or closed captions, they are not displayed by the platform. Cue events are raised.

The timed metadata track is listed in the **MediaTransportControls**. If the metadata track contains subtitles or closed captions, they are displayed by the platform. Cue events are raised.

Provides information about the CurrentTimeChangeRequested event.

Gets the new time that the Play To source audio or video stream has been changed to.

The new time that the Play To source audio or video has been changed to.

Provides information about the MuteChangeRequested event.

Gets a value that indicates whether mute or unmute was requested.

True if mute was requested; otherwise false.

Provides information about the PlaybackRateChangeRequested event.

Gets the new playback rate.

The new playback rate.

Provides information about a Play To connection.

PlayToConnection may be altered or unavailable for releases after Windows 10. Instead, use CastingConnection.

Gets the state of the Play To connection.

The state of the Play To connection.

Occurs when an error is encountered for the Play To connection.

Occurs when the state of the Play To connection has changed.

Occurs when the Play To connection is transferred to the next Play To source.

Describes an error on a Play To connection.

PlayToConnectionError may be altered or unavailable for releases after Windows 10. Instead, use CastingConnectionErrorStatus.

The Play To target device has encountered an error.

The Play To target device is locked.

The Play To target device has not responded for at least 5 seconds.

No error occurred.

The Play To target device failed to play the protected content.

Provides information about the Error event.

PlayToConnectionErrorEventArgs may be altered or unavailable for releases after Windows 10. Instead, use CastingConnectionErrorOccurredEventArgs.

Gets the error code for a Play To connection error.

The error code for a Play To connection error.

Gets the error message for a Play To connection error.

The error message for a Play To connection error.

Describes the status of a Play To connection.

PlayToConnectionState may be altered or unavailable for releases after Windows 10. Instead, use CastingConnectionState.

The connection is connected.

The connection is disconnected.

The connection is rendering media on the Play To target device.

Provides information about the StateChanged event.

PlayToConnectionStateChangedEventArgs may be altered or unavailable for releases after Windows 10.

Gets the current state after the Play To connection state has changed.

The current state after the Play To connection state has changed.

Gets the previous state before the Play To connection state was changed.

The previous state before the Play To connection state was changed.

Provides information about the Transferred event.

PlayToConnectionTransferredEventArgs may be altered or unavailable for releases after Windows 10.

Gets the current Play To source that a connection was transferred to.

The current Play To source that a connection was transferred to.

Gets the previous Play To source that a connection was transferred from.

The previous Play To source that a connection was transferred from.

Provides access to Play To capabilities.

PlayToManager may be altered or unavailable for releases after Windows 10.

Enables or disables the default source selection for Play To.

True to enable default source selection; otherwise false. The default is true.

Occurs when a user requests media to stream to a Play To target device.

Occurs when a Play To source element has been selected.

Gets the Play To manager for the current view.

PlayToManager may be altered or unavailable for releases after Windows 10. The Play To manager for the current view.

Displays the Play To UI.

PlayToManager may be altered or unavailable for releases after Windows 10.

Represents a Play To target.

Creates a new instance of a Play To receiver.

Gets or sets the display name of the Play To target.

The display name of the Play To target.

Gets a set of custom properties for the Play To receiver.

A set of custom properties for the Play To receiver.

Gets or sets a value that indicates whether the Play To target supports audio.

True if the Play To target supports audio; otherwise false.

Gets or sets a value that indicates whether the Play To target supports images.

True if the Play To target supports images; otherwise false.

Gets or sets a value that indicates whether the Play To target supports video.

True if the Play To target supports video; otherwise false.

Occurs when the time location of the playback has changed.

Occurs when the audio has been muted or unmuted.

Occurs when audio or video playback has been paused.

Occurs when the rate of audio or video playback has changed.

Occurs when audio or video playback starts.

Occurs when the source media for the Play To receiver have changed.

Occurs when a request has been made for the Play To receiver to stop playing the streamed media.

Occurs when the current playback position has changed.

Occurs when the volume for the source audio or video has changed.

Notifies the Play To receiver that the duration of the audio or video playback has changed.

The new duration of the audio or video media.

Notifies the Play To receiver that the audio or video playback has ended.

Notifies the Play To receiver that an error has occurred in displaying or playing the media.

Notifies the Play To receiver that metadata for the media has finished loading.

Notifies the Play To receiver that the audio or video playback has been paused.

Notifies the Play To receiver that the audio or video playback has started.

Notifies the Play To receiver that the rate of the audio or video playback has changed.

The new value of the playback rate.

Notifies the Play To receiver that the audio or video playback element has started at a new playback location.

Notifies the Play To receiver that the audio or video playback element is seeking a new playback location.

Notifies the Play To receiver that the audio or video playback has stopped.

Notifies the Play To receiver that the time location of the audio or video playback has changed.

The new time location of the playback.

Notifies the Play To receiver that the volume of the audio or video playback has changed.

The new value for the volume. True if the volume was muted; otherwise false.

Start receiving Play To commands.

An asynchronous handler that's called when the start operation is complete.

Stop receiving Play To commands.

An asynchronous handler that's called when the stop operation is complete.

Represents a media element to connect to a Play To target.

PlayToSource may be altered or unavailable for releases after Windows 10. Instead, use CastingSource.

Gets the connection to the Play To target.

The connection to the Play To target.

Gets or sets the next Play To source element.

The next Play To source element.

Specifies a preferred Uniform Resource Identifier (URI) for the media stream, such as a cloud based media server, used is used for Play To by reference.

The preferred URI to stream the media from.

Connects the next Play To source element to the Play To target.

PlayToSource may be altered or unavailable for releases after Windows 10. Instead, use CastingSource.

Represents a deferred operation when you're supplying a source media element for Play To.

PlayToSourceDeferral may be altered or unavailable for releases after Windows 10.

Ends the deferral.

PlayToSourceDeferral may be altered or unavailable for releases after Windows 10.

Represents a request to connect a media element with a Play To target.

PlayToSourceRequest may be altered or unavailable for releases after Windows 10.

Gets the time limit to supply the Play To source element.

The time limit to supply the Play To source element.

Displays an error message in the Play To UI.

PlayToSourceRequest may be altered or unavailable for releases after Windows 10. The error message to display in the Play To UI.

Defers connecting a media source to a Play To target.

PlayToSourceRequest may be altered or unavailable for releases after Windows 10. A deferral object that you can use to identify when the deferral is complete.

Sets the source element to connect to the Play To target.

PlayToSourceRequest may be altered or unavailable for releases after Windows 10. The source element to connect to the Play To target.

Provides information about the SourceRequested event.

PlayToSourceRequestedEventArgs may be altered or unavailable for releases after Windows 10.

Gets the media object to connect to a Play To target.

The media object to connect to a Play To target.

Provides information about the SourceSelected event.

PlayToSourceSelectedEventArgs may be altered or unavailable for releases after Windows 10.

Gets the display name of the selected Play To source.

The display name of the selected Play To source.

Gets the display icon for the selected Play To source.

The display icon for the selected Play To source.

Gets a value that indicates whether the selected Play To source supports audio.

True if the selected Play To source supports audio; otherwise false.

Gets a value that indicates whether the selected Play To source supports displaying images.

True if the selected Play To source supports displaying images; otherwise false.

Gets a value that indicates whether the selected Play To source supports video.

True if the selected Play To source supports video; otherwise false.

Provides information about the SourceChangeRequested event.

Gets the name of the album that contains the song in the audio stream.

The name of the album that contains the song in the audio stream.

Gets the author of the content in the media stream.

The author of the content in the media stream.

Gets the date that the content in the media stream was published.

The date that the content in the media stream was published.

Gets the description of the content in the media stream.

The description of the content in the media stream.

Gets the names of the genres that the content in the media stream belongs to.

Gets the names of the genres that the content in the media stream belongs to.

Gets custom property names and values for the content in the media stream.

Custom property names and values for the content in the media stream.

Gets the rating for the content in the media stream.

The rating for the content in the media stream.

Gets the media stream for the Play To receiver.

The media stream for the Play To receiver.

Gets the thumbnail image for the content in the media stream.

The thumbnail image for the content in the media stream.

Gets the title of the content in the media stream.

The title of the content in the media stream.

Provides information about the VolumeChangeRequested event.

Gets the new volume level.

The new volume level.

Contains event data for a MediaProtectionManager object when the load of binary data fails.

Returns an indication of the completion of the event.

An object that contains an indication of the completion of the event.

Returns a list of components in the RevocationAndRenewalInformation object that need to be revoked and renewed with updated components.

An object that contains a list of components to be revoked and renewed with updated components.

Represents the method that handles the data passed by the MediaProtectionManager when a load of binary data fails.

Contains the MediaProtectionManager object that was loading the binary data when the load failed. Contains event data for a MediaProtectionManager object when the load of binary data fails.

Describes the status of graphics trusted output.

Driver not supported for trusted output.

Driver signing failed for trusted output.

The environment is not supported for trusted output.

Trust output has been established.

Trusted output is not required.

Unspecified error occurred.

Describes the level of protection of an HdcpSession instance.

HDCP is off.

HDCP is on.

HDCP is on with type enforcement (other connected devices/monitors, besides the one that the content is running on, have HDCP required).

Allows apps to set and query the current state of High-bandwidth Digital Content Protection (HDCP) between the graphics hardware and the display.

Initializes a new instance of the **HdcpSession** class.

Fires when the protection level of the HdcpSession instance changes.

Closes the HdcpSession instance.

Returns the effective protection of the HdcpSession instance.

The level of protection that the HdcpSession instance currently has.

Checks whether the effective protection of the HdcpSession instance is at least equal to the given HdcpProtection value.

The level of protection to check against the HdcpSession instance's protection level. True if the protection level of the HdcpSession is at least equal to the value of *protection*.

Asynchronously attempts to set the protection of the HdcpSession instance with the given protection level.

The level of protection at which to set the HdcpSession instance. The result of the operation.

Describes whether setting HDCP was successful.

The device doesn't support the HDCP level that was attempted.

HDCP was successfully set.

The HDCP operation timed out and protection was not set.

The HDCP operation failed for an unknown reason.

Allows a content enabler object to be exposed directly to an application rather than through a wrapper supplied by the ContentEnabler object.

Allows the application to identify the content protection system being used and therefore how to interpret the protection task.

The vendor content protection system ID.

Retrieves the GUID for the type of operation that the IMediaProtectionServiceRequest performs.

The GUID to retrieve.

Contains a content protection manager object for an application that handles protected media content.

Initializes a new instance of the MediaProtectionManager class.

Gets a PropertySet object containing any properties attached to the protection manager.

The PropertySet object that contains the properties for this protection manager.

Fires when the load of binary data fails.

Fires when a reboot is needed after the component is renewed.

Fires when a service is requested.

Represents a Protected Media Path (PMP) server to enable playback of protected content using digital rights management (DRM).

Initializes a new instance of the MediaProtectionPMPServer class with the specified properties.

The set of properties used to initialize the server.

Gets the property set for the MediaProtectionPMPServer.

The property set for the MediaProtectionPMPServer.

Contains a method that indicates whether a protection service has completed successfully.

Indicates whether a protection service has completed successfully.

Indicates the successful completion of a protection service.

Exposes Microsoft PlayReady digital rights management (DRM) capabilities for video decoding, video display, and video output protection subsystems used by the Windows Media Foundation pipeline under a XAML MediaElement or C++ Media Engine to a WinRT caller. The caller may use this information to select the most appropriate encoding of DRM’ed content for playback.

Initializes a new instance of the **ProtectionCapabilities** class.

Queries features of video decoding, display, and output protection subsystems for DRM capabilities.

String identifying the features for which support is queried queried. This parameter accepts RFC 2045 Content-Type strings to specify media type and subtype identifiers, and RFC 6381 Codecs identifiers for the codecs required. These base strings are consistent with those used in the HTML5 **HTMLMediaElement** **canPlayType** method. RFC 2045 allows for additional, custom parameters as modifiers in the form of `";<parameter>=<name>[=<value>] [,<name>[=<value>]"`. A string identifying the PlayReady namespace to check query against, specifying hardware or software protection. Use "com.microsoft.playready.hardware" for hardware queries (PlayReady must have support for hardware offload), "com.microsoft.playready.software" for explicitly querying for software protection support, and "com.microsoft.playready" for general queries (must answer for software protection support to guarantee backward compatibility). A value indicating if the queried capabilities are likely supported, are possibly supported, or are unsupported.

Specifies the result of a query for hardware DRM capability support using IsTypeSupported.

Only relevant to output protection (HDCP) subsystem queries. ProtectionCapabilities.IsTypeSupported is a synchronous, blocking call which is constrained to only block for very short periods (goal is < 100 milliseconds). As underlying HDCP establishment may take significantly longer than the blocking period, this **Maybe** result is returned while establishment is in progress.

The queried features are not supported.

The queried features are supported as of the time of the query. Display configurations can change dynamically, so Display subsystem and HDCP subsystem query results may become invalid after the query.

Represents the method that handles the data passed by the MediaProtectionManager that requires a reboot.

Contains the MediaProtectionManager object that requires a reboot to occur.

Contains information about components that need to be revoked and renewed.

Returns a list of components that need to be revoked and renewed with updated components.

List of components that need to be revoked and renewed.

Represents a component that is being revoked and renewed with a trusted component.

Returns the header hash for the component being revoked.

The string for the header hash.

Returns the name for the component being revoked.

The name of the component.

Returns the public key hash for the component.

The public key hash.

Returns the reason for revocation of component.

Defines reasons for the revocation and renewal of a certificate for a media component.

Returns the GUID for the renewal object.

The renewal object GUID.

Defines reasons for the revocation and renewal of a certificate for a media component.

App component.

A boot driver could not be verified.

A certificate in a trusted component's certificate chain was revoked.

The high-security certificate for authenticating the protected environment (PE) was revoked.

The low-security certificate for authenticating the PE was revoked.

A trusted component was revoked.

A component was signed by a test certificate.

A certificate chain was not well-formed, or a boot driver is unsigned or is signed with an untrusted certificate.

The GRL was not found.

Could not load the global revocation list (GRL).

A certificate's extended key usage (EKU) object is invalid.

The root certificate is not valid.

The GRL signature is invalid.

Kernel-mode component.

User-mode component.

Contains event data for a MediaProtectionManager object when a service is requested.

Returns an indication of the completion of the service request.

An object that contains an indication of the completion of the service request.

Gets the MediaPlaybackItem associated with the service request.

The MediaPlaybackItem associated with the service request.

Contains the service request.

Contains the service request.

Represents the method that handles the data passed by the MediaProtectionManager when the resume operation is completed.

Contains the MediaProtectionManager object that is requesting the service. Contains event data for a MediaProtectionManager object when a service is requested.

Specifies arguments for a PlayReady-ND ClosedCaptionDataReceived event.

INDClosedCaptionDataReceivedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the closed caption data.

The closed caption data.

Gets the format of the closed caption data.

The closed caption data format. This value can be **ATSC**, **SCTE20**, or **Unknown**.

Gets the timestamp of the closed caption data.

The timestamp of the closed caption data, in milliseconds.

Contains the custom data for one of the following PlayReady-ND messages: Registration Challenge, Registration Response, License Fetch Challenge, or License Fetch Response.

INDCustomData is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the custom data.

The byte array that contains the custom data.

Gets the 16-byte type identifier for the custom data.

The byte array that contains the custom data type identifier.

Provides the PlayReady-ND download engine used to stream protected media content from a transmitter.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the maximum threshold of the sample buffer.

The maximum number of samples that the download engine uses to determine whether the sample buffer is full.

Gets the minimum number of samples a sample buffer can hold before a download engine resumes downloading.

The minimum number of samples that the download engine uses to determine whether to resume downloading.

Gets whether the download engine supports seeking.

**true** if the download engine supports seeking or **false** if it does not.

Gets the download engine notifier that will provide notification of download stream events from the transmitter.

A download engine notifier created from the INDDownloadEngineNotifier interface.

Notifies the download engine to stop downloading and disconnect from the remote server.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN.

Notifies the download engine to open the content specified by a URL.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN. The URI from which the download engine gets content. The session identifier used to identify the session. The session identifier must be 16 bytes.

Notifies the download engine to pause downloading.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN.

Notifies the download engine to resume a paused download.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN.

Notifies the download engine to go to a specified time position in the media stream.

INDDownloadEngine is deprecated and might not work on all platforms. For more info, see MSDN. The position within the media stream to which to seek.

Contains methods that a download engine plug-in uses to send notifications to a PlayReady-ND client.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the download engine when a content identifier is received.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The license from which the download engine receives the content identifier.

Called by the download engine when it receives data.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The byte array that holds the data. The number of bytes received from the data stream.

Called by the download engine when it reaches the end of a PlayReady-ND media stream.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the download engine if an error occurs during downloading.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the download engine once a PlayReady object is received.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The byte array that holds the PlayReady object.

Called by the download engine when a stream is opened.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Gets custom data from a PlayReady-ND license fetch operation. This custom data is an argument from a PlayReady-ND LicenseFetchCompleted event.

INDLicenseFetchCompletedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets custom data from a license fetch response.

The custom data from the license fetch response.

Retrieves and sets properties used for fetching a PlayReady-ND license.

INDLicenseFetchDescriptor is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the content identifier used for fetching a license.

The content identifier.

Gets the type of the content identifier used for fetching a license.

The content identifier type. The value can be either **KeyID**, **PlayReadyObject**, or **Custom**.

Gets or sets custom data for a license fetch challenge.

The custom data from or for the license challenge.

Provides the result of the PlayReady-ND license fetch.

INDLicenseFetchResult is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the custom data from a license fetch response.

The custom data from a license fetch response.

Sends registration, proximity detection, and license fetch messages between PlayReady-ND receivers and transmitters.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN.

Sends the specified data in an asynchronous license fetch request message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the license fetch request.

Sends the specified data in an asynchronous proximity detection response message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The type of proximity detection operation. This value can be **UDP**, **TCP**, or **Transport-Agnostic**. The transmitter channel data. The session identifier. The session identifier must be 16 bytes. The data for the response message. The result of the proximity detection response operation.

Sends the specified data in an asynchronous proximity detection start message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The type of proximity detection operation. This value can be **UDP**, **TCP**, or **Transport-Agnostic**. The transmitter channel data. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the proximity detection start operation.

Sends the specified data in an asynchronous registration request message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the license fetch request.

Provides arguments for the PlayReady-ND ProximityDetectionCompleted event. Apps fire this event after they complete the proximity detection process.

INDProximityDetectionCompletedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the number of retries that occurred during a proximity detection operation.

The number of retries that occurred during a proximity detection operation.

Provides arguments for the PlayReady-ND RegistrationCompleted event.

INDRegistrationCompletedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets custom data from a registration response.

The custom data from the registration response.

Gets or sets whether to accept or reject a transmitter's certificate.

The result from verifying the transmitter's certificate. This value is **true** if the receiver accepts the transmitter certificate or **false** if it rejects the certificate.

Gets transmitter properties from the transmitter's certificate to verify the transmitter.

The properties of the transmitter's certificate.

Provides the result, in the form of a response message, from the PlayReady-ND messenger.

INDSendResult is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the response message from a messenger.

The response message.

Provides the StartAsync result that contains the created PlayReady-ND instance.

INDStartResult is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the object for the data that the transmitter streams.

The newly-created object.

Manages PlayReady-ND storage files.

INDStorageFileHelper is deprecated and might not work on all platforms. For more info, see MSDN.

Gets transmitter settings from the URLs associated with a object if the URLs contain PlayReady-ND metadata.

INDStorageFileHelper is deprecated and might not work on all platforms. For more info, see MSDN. A storage file object that a media server has discovered. The transmitter settings found in the storage file.

Parses data from a PlayReady-ND media stream.

INDStreamParser is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the stream parser notifier that will provide notification of stream parser events from the transmitter.

An instance of an NDStreamParserNotifier object.

Notifies a PlayReady-ND stream parser to be ready for the beginning of a new media stream.

INDStreamParser is deprecated and might not work on all platforms. For more info, see MSDN.

Notifies a PlayReady-ND stream parser that the end of a media stream has been reached.

INDStreamParser is deprecated and might not work on all platforms. For more info, see MSDN.

Retrieves the stream type (audio or video) and stream identifier of the media stream descriptor.

INDStreamParser is deprecated and might not work on all platforms. For more info, see MSDN. The media stream from which this method gets information. The type of the media stream. This type can be either **Audio** or **Video**. The stream identifier for the media stream.

Parses samples from a PlayReady-ND media stream.

INDStreamParser is deprecated and might not work on all platforms. For more info, see MSDN. The data to be parsed.

Contains methods that a stream parser plug-in uses to send notifications to a PlayReady-ND client.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the stream parser when it requests a setup decryptor.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The descriptor of the media stream being decrypted. The key identifier used for decryption. The byte array of a PlayReadyObject for creating the decryptor. For MPEG2 TS, the PlayReadyObject is in the entitlement control messages (ECM) packet.

Called by a stream parser when it receives the content identifier.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The license fetch descriptor containing the content identifier.

Called by the stream parser when the media stream descriptor is created.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. An array of audio stream descriptors that are part of the media stream descriptor. An array of video stream descriptors that are part of the media stream descriptor.

Called when the stream parser parses a sample from the media stream.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The identifier for the media stream that is being parsed. The type of the media stream. This value can be either **Audio** or **Video**. The array of stream samples. The presentation timestamp that indicates when to play the sample. The closed caption format. This value can be **ATSC**, **SCTE20**, or **Unknown**. An array that contains the closed caption data.

Provides the property values for a PlayReady-ND transmitter certificate.

INDTransmitterProperties is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the certificate type for the transmitter.

The certificate type. This value can be either **DRM_BCERT_CERTTYPE_PC** (0x1) or **DRM_BCERT_CERTTYPE_DEVICE** (0x2).

Gets the client identifier from the transmitter certificate.

The client identifier.

Gets the expiration date and time from the transmitter certificate.

The date and time the certificate expires.

Gets the model digest from a transmitter certificate.

The model digest.

Gets the model manufacturer name from a transmitter certificate.

The model manufacturer name.

Gets the model name from a transmitter certificate.

The model name.

Gets the model number from a transmitter certificate.

The model number as a text string.

Gets the platform identifier from a transmitter certificate.

The platform identifier.

Gets the security level from a transmitter certificate.

The security level.

Gets the security version from a transmitter certificate.

The security version.

Gets the list of supported features from the transmitter certificate.

An array identifying the feature sets that the certificate supports.

Provides access to metadata about a domain to which the current system is a member.

Gets the current domain account identifier property.

The current domain account identifier property. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the URL used to join the domain.

The URL used to join the domain.

Gets the current domain friendly name.

The current domain friendly name.

Gets the current domain revision number.

The current domain revision number.

Gets the current domain service identifier property.

The current domain service identifier property. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Contains information about a PlayReady license.

Gets the chain depth of the license chain represented by the current IPlayReadyLicense interface.

The chain depth of the license chain.

Gets the domain account identifier to which this license is bound.

The domain account identifier. If the license is not domain bound, **GUID_NULL** is returned. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the expiration date of the current license.

The expiration date of the current license.

Gets the amount of time, in seconds, before the current license expires after the media is first played.

The time, in seconds, before the current license expires after the media is first played.

Gets the state of the license.

Indicates whether this license chain is evaluated or whether this license chain may be unusable due to enumeration for all licenses (including those that are unusable) being performed. If **true**, the license chain is evaluated. If **false**, the license chain may be unusable.

Gets whether this license is usable for playback.

**true** if this license is usable for playback, otherwise **false**.

Gets the key identifier (KID) of the license at the specified chain depth.

The depth of the license in the chain for which to retrieve the KID. This value is a 0-based index. The KID of the license. This return value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Performs a license acquisition process.

Gets the current content header property.

The current content header property.

Gets the current domain service identifier property that overrides a service identifier in the content header.

The current service identifier property.

Creates a media session and binds license acquisition to that media session.

Updates the media protection manger with the appropriate settings so the media foundation can be used for playback.

The media protection manager to be updated.

Creates a license acquisition service request whose license will be tied to the media session.

The license acquisition service request.

Provides the ability to enumerate in-memory-only PlayReady licenses in addition to persisted licenses.

Creates a PlayReadyLicense object iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses.

The content header used to locate associated licenses. Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated.

Manages secure stop messages.

Gets the current publisher certificate property.

The current publisher certificate.

Gets the secure stop session identifier property.

The secure stop session identifier.

Gets the secure stop session's start time property.

The secure stop session's start time.

Gets the secure stop session's stopped flag property which indicates whether the secure stop session for this request was cleanly shut down.

The secure stop session's stopped flag.

Gets the secure stop session's update/stop time property.

The secure stop session's update/stop time.

Base interface for all service request interfaces.

Gets or sets the custom data of the request challenge.

The custom data.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling.

Begins the process of manually enabling.

Returns a new service request interface.

The new service request interface.

Processes the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Indicates the PlayReady-ND feature to which the certificate controls access.

NDCertificateFeature is deprecated and might not work on all platforms. For more info, see MSDN.

Device implements anti-rollback clock.

Entity supports certificate revocation lists.

Entity supports PlayReady version 3.x features such as per-stream keys.

Entity implements receiver functionality.

Device implements SecureClock.

Entity shares receiver key across multiple devices.

Entity implements transmitter functionality.

Indicates the client platforms with which a PlayReady-ND certificate can be associated.

NDCertificatePlatformID is deprecated and might not work on all platforms. For more info, see MSDN.

Client platform is the Google Android operating system running on an ARM processor.

Client platform is the Apple iOS operating system running on an ARM processor.

Client platform is the Apple OSX operating system.

Client platform is Microsoft Windows.

Client platform is the Microsoft Windows Phone 7 operating system.

Client platform is the Microsoft Windows Phone 7 operating system running on an ARM processor.

Client platform is the Microsoft Windows Phone 8.1 operating system running on an ARM processor.

Client platform is the Microsoft Windows Phone 8.1 operating system running on an x86 processor.

Client platform is the Microsoft Windows Phone 8 operating system running on an ARM processor.

Client platform is the Microsoft Windows Phone 8 operating system running on an x86 processor.

Client platform is the Xbox operating system.

Client platform is the Xbox operating system running on a Power PC processor.

Indicates the type and purpose of a PlayReady-ND transmitter license.

NDCertificateType is deprecated and might not work on all platforms. For more info, see MSDN.

A leaf level certificate for a PlayReady client.

A leaf level certificate used to sign CRLs issued by Microsoft.

A leaf level certificate used by a device.

A leaf level certificate used by a PC or a device when a member of a domain.

Can be an issuer of certificates for either an issuer or a leaf certificate.

A leaf level certificate used by the cryptography server to sign the key file.

A certificate used by a license signer.

A leaf level certificate used by digital rights management clients to encrypt metering data sent to a PlayReady SDK server.

A leaf level certificate used by the PC client.

A leaf level certificate used by the PlayReady server.

A leaf level certificate used by services such as Secure Clock. Reserved for future use.

A leaf level certificate for a Silverlight client.

An unknown certificate type. Apps should never use this value.

Creates PlayReady-ND sessions, coordinates with the download engine and the stream parser (for example, an MPEG-2 demuxer), manages the sample buffer, and listens to media stream source events.

NDClient is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDClient class.

INDClientFactory is deprecated and might not work on all platforms. For more info, see MSDN. The download engine used to stream protected media content from a transmitter. The stream parser used to parse data from a media stream. The messenger used to send messages between the PlayReady-ND receiver and transmitter.

Notifies listeners that a closed caption acquisition operation has completed.

Notifies listeners that a license fetch operation has completed.

Notifies listeners that a proximity detection operation has completed.

Notifies listeners that a registration operation has completed.

Notifies listeners that the app should start re-registration by calling the ReRegistrationAsync method.

Closes the current playback session regardless of whether it is in the registration, proximity detection, license fetch, or play state.

INDClient is deprecated and might not work on all platforms. For more info, see MSDN.

Performs a license fetch between a client receiver and a transmitter.

INDClient is deprecated and might not work on all platforms. For more info, see MSDN. Descriptor for the license being fetched. The result of the asynchronous license fetch call.

Performs a proximity detection and reregistration between a client receiver and a transmitter.

INDClient is deprecated and might not work on all platforms. For more info, see MSDN. Custom data for the registration request. The result of the asynchronous reregistration call.

Starts the registration, proximity detection, and license fetch procedures between a client receiver and a transmitter.

INDClient is deprecated and might not work on all platforms. For more info, see MSDN. The URL of the streamed content. The asynchronous start options. See the NDStartAsyncOptions enumeration for a detailed description of these options. The custom data type identifier that is used for registration with the transmitter. The descriptor used for license fetching. The result of the asynchronous start call.

Indicates the type of format used for closed captions.

NDClosedCaptionFormat is deprecated and might not work on all platforms. For more info, see MSDN.

ATSC digital television closed captions.

SCTE 20 MPEG2 closed captions.

Invalid format.

Indicates the types of content that PlayReady can use in different scenarios.

NDContentIDType is deprecated and might not work on all platforms. For more info, see MSDN.

Custom object specific to the transmitter. It is expected that the transmitter will understand the data contained therein. PlayReady does not define a standard format for custom content identifiers.

License key identifier.

**PlayReadyObject** can be one of the following two objects.

Contains the custom data for one of the following PlayReady-ND messages: Registration Challenge, Registration Response, License Fetch Challenge, or License Fetch Response.

NDCustomData is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDCustomData class.

INDCustomDataFactory is deprecated and might not work on all platforms. For more info, see MSDN. The type identifier for the custom data. Only a type identifier that is exactly 16 bytes in size is supported. The custom data.

Gets the custom data.

The byte array that contains the custom data.

Gets the 16-byte type identifier for the custom data.

The custom data type identifier.

Contains methods that a download engine plug-in uses to send notifications to a PlayReady-ND client.

NDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDDownloadEngineNotifier class.

Called by the download engine when a content identifier is received.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The license from which the download engine receives the content identifier.

Called by the download engine when it receives data.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The byte array that holds the data. The number of bytes received from the data stream.

Called by the download engine when it reaches the end of a PlayReady-ND media stream.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the download engine if an error occurs during downloading.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Called by the download engine once a PlayReady object is received.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The byte array that holds the PlayReady object.

Called by the download engine when a stream is opened.

INDDownloadEngineNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Retrieves and sets properties used for fetching a PlayReady-ND license.

NDLicenseFetchDescriptor is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDLicenseFetchDescriptor class.

INDLicenseFetchDescriptorFactory is deprecated and might not work on all platforms. For more info, see MSDN. The type of the content identifier. The content identifier. The license fetch challenge custom data.

Gets the content identifer.

The content identifier.

Gets the type of the content identifier.

The content identifier type. This value can be **KeyID**, **PlayReadyObject**, or **Custom**.

Gets or sets custom data for a license fetch challenge.

The custom data from or for the license challenge.

Indicates the type of a protected media stream.

NDMediaStreamType is deprecated and might not work on all platforms. For more info, see MSDN.

The stream is an audio stream.

The stream is a video stream.

Indicates the transport protocol that the proximity detection process uses.

NDProximityDetectionType is deprecated and might not work on all platforms. For more info, see MSDN.

Proximity detection uses the TCP transport protocol.

Proximity detection can use either UDP or TCP as the transport protocol.

Proximity detection uses the UDP transport protocol.

Indicates the asynchronous start options. This enumeration is a bitwise OR and is used by the StartAsync method.

NDStartAsyncOptions is deprecated and might not work on all platforms. For more info, see MSDN.

If set, the transmitter's certificate will be presented to the caller through a RegistrationCompleted event for verification. The caller should set a flag to accept or reject it. If not set, **RegistrationCompleted** will not contain the certificate.

If set and the *LicenseFetchDescriptor* parameter is **null** for StartAsync, then **StartAsync** will wait for **OnContentIDReceived** from either NDDownloadEngineNotifier or NDStreamParserNotifier. After **OnContententIDReceived**, the received *LicenseFetchDescriptor* is used to perform the license fetch. If not set and the *LicenseFetchDescriptor* parameter is **null** for **StartAsync**, then **StartAsync** assumes you already acquired the license beforehand and will not do a license fetch.

Manages PlayReady-ND storage files.

NDStorageFileHelper is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDStorageFileHelper class.

Gets transmitter settings from the URLs associated with a **StorageFile** object if the URLs contain PlayReady-ND metadata.

INDStorageFileHelper is deprecated and might not work on all platforms. For more info, see MSDN. A storage file object that a media server has discovered. The transmitter settings found in the storage file.

Contains methods that a stream parser plug-in uses to send notifications to a PlayReady-ND client.

NDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDStreamParserNotifier class.

Called by the stream parser when it requests a setup decryptor.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The descriptor of the media stream being decrypted. The key identifier used for decryption. The data for the setup decryptor.

Called by a stream parser when it receives the content identifier.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The license fetch descriptor containing the content identifier.

Called by the stream parser when the media stream descriptor is created.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. An array of audio stream descriptors that are part of the media stream descriptor. An array of video stream descriptors that are part of the media stream descriptor.

Called when the stream parser parses a sample from the media stream.

INDStreamParserNotifier is deprecated and might not work on all platforms. For more info, see MSDN. The identifier for the media stream that is being parsed. The type of the media stream. This value can be **Audio** or **Video**. The array of stream samples. The presentation timestamp that indicates when to play the sample, in milliseconds. This value is relative to previous samples in the presentation. For example, if a given sample has a presentation time stamp of 1000 and some later sample has a presentation time stamp of 2000, the later sample occurs one second (1000ms) after the given sample. The closed caption format. This value can be **ATSC**, **SCTE20**, or **Unknown**. An array that contains the closed caption data.

Sends PlayReady-ND messages and challenges using the TCP network protocol.

NDTCPMessenger is deprecated and might not work on all platforms. For more info, see MSDN.

Creates a new instance of the NDTCPMessenger class.

INDTCPMessengerFactory is deprecated and might not work on all platforms. For more info, see MSDN. The IP address of the remote host that will receive messages. The format is either an IPv4 address in dotted-decimal notation or an IPv6 address in colon-hex notation. The TCP port of the remote host that will receive messages.

Sends the specified data in an asynchronous license fetch request message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the license fetch request.

Sends the specified data in an asynchronous proximity detection response message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The type of proximity detection operation. This value can be **UDP**, **TCP**, or **Transport-Agnostic**. The transmitter channel data. The session identifier. The session identifier must be 16 bytes. The data for the response message. The result of the proximity detection response operation.

Sends the specified data in an asynchronous proximity detection start message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The type of proximity detection operation. This value can be **UDP**, **TCP**, or **Transport-Agnostic**. The transmitter channel data. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the proximity detection start operation.

Sends the specified data in an asynchronous registration request message.

INDMessenger is deprecated and might not work on all platforms. For more info, see MSDN. The session identifier. The session identifier must be 16 bytes. The data for the challenge message. The result of the registration request.

Represents the information in a PlayReady content header.

Initializes a new instance of the PlayReadyContentHeader class.

Raw data bytes representing a PlayReady content header.

Initializes a new instance of the PlayReadyContentHeader class.

Raw data bytes representing a legacy WMDRM header. The URL for the silent (no user interaction) license acquisition Web service. The URL for a non-silent license acquisition Web page. Contains custom data used by the content provider. The content author can add arbitrary XML inside this element. Microsoft code does not act on any data contained inside this element. Service identifier for the domain service.

Initializes a new instance of the PlayReadyContentHeader class.

Identifier of the content encryption key. String representation of the content key. If the *contentKeyId* parameter is specified, then this parameter is ignored. Encryption algorithm type used to encrypt the content. The URL for the silent (no user interaction) license acquisition Web service. The URL for a non-silent license acquisition Web page. Contains custom data used by the content provider. The content author can add arbitrary XML inside this element. Microsoft code does not act on any data contained inside this element. Service identifier for the domain service.

Initializes a new instance of the PlayReadyContentHeader class.

Reserved. Set to 0. Identifiers of the content encryption keys. String representations of the content keys. Each string must be a Base-64 encoded 16 byte value. Encryption algorithm type used to encrypt the content. The URL for the silent (no user interaction) license acquisition Web service. The URL for a non-silent license acquisition Web page. Contains custom data used by the content provider. The content author can add arbitrary XML inside this element. Microsoft code does not act on any data contained inside this element. Service identifier for the domain service.

Gets the custom data used by the content provider.

The custom data used by the content provider.

Gets the decryptor setup value in the header if it is set.

The header's decryptor setup value.

Gets the domain service identifier in the header if it is set.

The header's domain service identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the content encryption type in the header if it is set.

The header's content encryption type.

Gets a new content header that contains any embedded license updates that were available.

The new content header. If updates were not available, then this property returns **NULL**.

Gets the content key identifier value if it is set.

The content key identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the content key identifier values if they are set.

The content key identifier values. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the content key identifier string value if it is set.

The content key identifier string.

Gets the content key identifier string values if they are set.

The content key identifier string values.

Gets the license acquisition URL in the header if it is set.

The license acquisition URL.

Gets the license acquisition user interface URL in the header if it is set.

The license acquisition user interface URL.

Retrieves the full PlayReady object as a byte array.

The header containing the full PlayReady object.

Receives multiple service request objects that are necessary to enable the playback ability for a given content header.

Proactively initiates the service request chain for a given content header.

Content header for the content the app wants to resolve all necessary service request operations. The first service request operation required to resolve the content.

Defines decryptor setup requirements indicating when to acquire licenses for the content.

Indicates that a player app cannot guarantee that the license (chain) for the content is available prior to setting up the media graph.

Indicates the DECRYPTORSETUP is not present in the rights management header. This indicates that a player app can guarantee that the license (chain) for the content is available prior to setting up the media graph.

Provides access to metadata about a domain to which the current system is a member.

Gets the current domain account identifier property.

The current domain account identifier property. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the URL used to join the domain.

The URL used to join the domain.

Gets the current domain friendly name.

The current domain friendly name.

Gets the current domain revision number.

The current domain revision number.

Gets the current domain service identifier property.

The current domain service identifier property. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Exposes the PlayReady PlayReadyDomain class iterator.

Initializes a new instance of the PlayReadyDomainIterable class using the domain account identifier.

The domain account identifier.

Returns an iterator that iterates over the items in the PlayReady domain collection.

The PlayReady domain iterator.

Provides for iteration of the PlayReadyDomain class.

Gets the current item in the PlayReady domain collection.

The current item in the PlayReady domain collection.

Gets a value that indicates whether there is a current item or the iterator is at the end of the PlayReady domain collection.

**true** if the iterator refers to a valid item that is in the collection or **false** if the iterator is at the end of the collection.

Retrieves all items in the PlayReady domain collection.

The items in the collection. The number of items in the collection.

Advances the enumerator to the next item in the collection.

**true** if the iterator refers to a valid item that is in the collection or **false** if the iterator is at the end of the collection.

Provides the service methods for joining a PlayReady domain.

Initializes a new instance of the PlayReadyDomainJoinServiceRequest class.

Gets or sets the custom data of the request challenge.

The custom data.

Gets or sets the current domain account identifier property.

The current domain account identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the current domain friendly name property.

The current domain friendly name.

Gets or sets the current domain service identifier property.

The current domain service identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets the GUID for the type of operation that the PlayReady domain join service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling.

The SOAP message to be used in a manual license acquisition challenge request.

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Provides the service methods for leaving a PlayReady domain.

Initializes a new instance of the PlayReadyDomainLeaveServiceRequest class.

Gets or sets the custom data of the request challenge.

The custom data.

Gets or sets the current domain account identifier property.

The current domain account identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the current domain account identifier.

The current domain service identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets the GUID for the type of operation that the PlayReady domain leave service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling.

The SOAP message to be used in a manual license acquisition challenge request.

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Indicates the type of encryption algorithm specified in a PlayReady content header.

AES128CBC encryption.

AES-128 Counter-mode encryption.

Cocktail encryption.

The encryption method has not been set.

Content is not encrypted.

The encryption method is unspecified.

Indicates the valid list of hardware digital rights management (DRM) feature values that can be queried.

Indicates the hardware supports AES128CBC encryption.

Hardware DRM is supported on the machine.

Indicates the hardware supports High Efficiency Video Coding (HEVC)/H.265 codec.

Provides the service methods for requesting platform individualization.

Initializes a new instance of the PlayReadyIndividualizationServiceRequest class.

Gets or sets the custom data of the request challenge. This property is not supported in this class.

Get always returns **NULL** data. Set always returns 0x80070032 (the request is not supported).

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service. This property is not supported in this class.

Always returns **NULL** data.

Gets the GUID for the type of operation that the PlayReady individualization service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action. This property is not supported in this class.

Get always returns **NULL** data. Set always returns 0x80070032 (the request is not supported).

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling. This method is not supported in this class.

This method always returns 0x80070032 (the request is not supported).

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge. This method is not supported in this class.

The response result to be processed. This method always returns 0x80070032 (the request is not supported).

Specifies the format for the ITA serialized data.

Returns the serialized IPropertySet as detailed in the remarks for the PlayReadyITADataGenerator.GenerateData method.

Returns the entire serialized blob including the content protection system **GUID**, the stream count, and the next stream ID block.

Creates the PlayReady ITA-specific serialized initialization data.

Initializes a new instance of the PlayReadyITADataGenerator class.

Returns a serialized blob of the specified IPropertySet data that the PlayReady ITA can consume if wrapped in a content protection instantiation format.

The content protection system **GUID**. The stream count. The data to be returned as a serialized blob. The format for the ITA serialized data. The serialized blob. See Remarks.

Represents the properties of a PlayReady license.

Gets the chain depth of the license chain represented by the current PlayReadyLicense class.

The chain depth of the license chain.

Gets the domain account identifier to which this license is bound.

The domain account identifier. If the license is not domain bound, **GUID_NULL** is returned. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the expiration date of the current license.

The expiration date of the current license.

Gets the amount of time, in seconds, before the current license expires after the media is first played.

The time, in seconds, before the current license expires after the media is first played.

Gets a value that indicates if the license can expire in the middle of playback or if only expires when attempting a fresh playback.

True if the license can expire in the middle of playback; otherwise, false.

Gets the state of the license.

Indicates whether this license chain is evaluated or whether this license chain may be unusable due to enumeration for all licenses (including those that are unusable) being performed. If **true**, the license chain is evaluated. If **false**, the license chain may be unusable.

Gets a value that indicates if the license is in-memory-only.

True if the license is in-memory-only; otherwise, false.

Gets the unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol.

The unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol.

Gets a value that indicates the security level of the license.

A value that indicates the security level of the license.

Gets whether this license is usable for playback.

**true** if this license is usable for playback, otherwise **false**.

Gets the key identifier (KID) of the license at the specified chain depth.

The depth of the license in the chain for which to retrieve the KID. This value is a 0-based index. The KID of the license. This return value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Provides the service methods for obtaining PlayReady licenses.

Initializes a new instance of the PlayReadyLicenseAcquisitionServiceRequest class.

Gets or sets the custom data of the request challenge.

The custom data.

Gets or sets the current content header property.

The current content header property.

Gets or sets the current domain service identifier property that overrides a service identifier in the content header.

The current domain service identifier property. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets a unique identifier for the PlayReady license acquisition operation.

A unique identifier for the PlayReady license acquisition operation.

Gets the GUID for the type of operation that the PlayReady license acquisition service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Creates a PlayReadyLicense class iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses.

The content header used to locate associated licenses. Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated.

Begins the process of manually enabling.

The SOAP message to be used in a manual license acquisition challenge request.

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Exposes the PlayReadyLicense class iterator.

Initializes a new instance of the PlayReadyLicenseIterable class.

Initializes a new instance of the PlayReadyLicenseIterable class.

The content header used to locate associated licenses. Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. This parameter is **true** if evaluated license chains should be enumerated, or **false** if all licenses should be enumerated.

Returns an iterator that iterates over the items in the PlayReady license collection.

The PlayReady license iterator.

Provides for iteration of the PlayReadyLicense class.

Gets the current item in the PlayReady license collection.

The current item in the PlayReady license collection.

Gets a value that indicates whether there is a current item or the iterator is at the end of the PlayReady license collection.

**true** if the iterator refers to a valid item that is in the collection, or **false** if the iterator is at the end of the collection.

Retrieves all items in the PlayReady license collection.

The items in the collection. The number of items in the collection.

Advances the enumerator to the next item in the collection.

**true** if the iterator refers to a valid item that is in the collection or **false** if the iterator is at the end of the collection.

Performs license management operations.

Deletes licenses that match the specified content header.

Content header with a key identifier with which to match licenses. The asynchronous operation performing the deletion.

Creates a media session and binds license acquisition to that media session.

Initializes a new instance of the PlayReadyLicenseSession class.

The configuration data for the license session.

Updates the media protection manger with the appropriate settings so the media foundation can be used for playback.

The media protection manager to be updated.

Creates a license acquisition service request whose license will be tied to the media session.

The license acquisition service request.

Creates a PlayReadyLicense class iterator that supports in-memory-only PlayReady licenses in addition to persisted licenses.

The content header used to locate associated licenses. Indicates whether evaluated license chains should be enumerated or if all licenses (including those that are unusable) should be enumerated. Set this parameter to true if evaluated license chains should be enumerated. Set this parameter to false if all licenses should be enumerated.

Provides the service methods for content metering operations.

Initializes a new instance of the PlayReadyMeteringReportServiceRequest class.

Gets or sets the custom data of the request challenge.

The custom data.

Gets or sets the current metering certificate property.

The current metering certificate property.

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets the GUID for the type of operation that the PlayReady metering report service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling.

The SOAP message to be used in a manual license acquisition challenge request.

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Updates the revocation data required by PlayReady.

Initializes a new instance of the PlayReadyRevocationServiceRequest class.

Gets or sets the custom data of the request challenge. This property is not supported in this class.

Get always returns **NULL** data. Set always returns 0x80070032 (the request is not supported).

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the custom data that was returned in the response from the service. This property is not supported in this class.

Always returns **NULL** data.

Gets the GUID for the type of operation that the PlayReady revocation service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets or sets the URI used to perform a service request action. This property is not supported in this class.

Get always returns **NULL** data. Set always returns 0x80070032 (the request is not supported).

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling. This method is not supported in this class.

This method always returns 0x80070032 (the request is not supported).

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge. This method is not supported in this class.

The response result to be processed. This method always returns 0x80070032 (the request is not supported).

Enumerates PlayReady secure stop service requests.

Initializes a new instance of the PlayReadySecureStopIterable class.

The raw binary body of the publisher certificate.

Returns an iterator that iterates over the items in the PlayReady secure stop collection.

The PlayReady secure stop iterator.

Provides for iteration of the IPlayReadySecureStopServiceRequest interface.

Gets the current item in the PlayReady secure stop collection.

The current item in the PlayReady secure stop collection.

Gets a value that indicates whether there is a current item or the iterator is at the end of the PlayReady secure stop collection.

**true** if the iterator refers to a valid item that is in the collection or **false** if the iterator is at the end of the collection.

Retrieves all items in the PlayReady secure stop collection.

The items in the collection. The number of items in the collection.

Advances the enumerator to the next item in the collection.

**true** if the iterator refers to a valid item that is in the collection or **false** if the iterator is at the end of the collection.

Manages secure stop messages.

Initializes a new instance of the PlayReadySecureStopServiceRequest class to include all secure stop sessions.

The raw binary body of the publisher certificate.

Initializes a new instance of the PlayReadySecureStopServiceRequest class for the specified secure stop session.

The secure stop session identifier. The raw binary body of the publisher certificate.

Gets or sets the custom data of the request challenge.

The custom data.

Gets the vendor content protection system identifier.

The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the current publisher certificate property.

The raw binary body of the publisher certificate.

Gets the custom data that was returned in the response from the service.

The custom data.

Gets the session identifier property.

Gets the session identifier property.

Gets the secure stop session's start time property.

The secure stop session's start time.

Gets the secure stop session's stopped flag property which indicates whether the secure stop session for this request was cleanly shut down.

The secure stop session's stopped flag.

Gets the GUID for the type of operation that the PlayReady secure stop service request performs.

The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the secure stop session's update/stop time property.

The secure stop session's update/stop time.

Gets or sets the URI used to perform a service request action.

The URI to be used.

Begins an asynchronous service request operation.

The asynchronous service action.

Begins the process of manually enabling.

The SOAP message to be used in a manual license acquisition challenge request.

Returns a new service request interface.

The new service request interface.

Process the raw binary result of a manual enabling challenge.

The response result to be processed. If the methods succeeds, it returns S_OK. If it fails, it returns an error code.

Contains a SOAP message used in manual challenge requests.

Gets a collection of the SOAP headers applied to the current SOAP request or SOAP response.

The SOAP message headers.

Gets the base URL of the XML Web service.

The base URL of the XML Web service.

Retrieves the contents of the SOAP message.

The contents of the SOAP message.

Provides support for returning static or constant data.

Gets the type of a PlayReady domain join service request.

The type of a PlayReady domain join service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the type of a PlayReady domain leave service request.

The type of a PlayReady domain leave service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Queries the date and time at which hardware digital rights management (DRM) was temporarily disabled on the system.

The date and time at which hardware digital rights management (DRM) was temporarily disabled. If it is not currently temporarily disabled, returns null.

Queries the date and time at which hardware digital rights management (DRM) will be re-enabled after it was temporarily disabled on the system.

The date and time at which hardware digital rights management (DRM) will be re-enabled. If it is not currently temporarily disabled, returns null.

Gets the type of a PlayReady individualization service request.

The type of a PlayReady individualization service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the PlayReady Trusted Input activation string.

The PlayReady Trusted Input activation string. This string is used by the Media Protection Manager to tell the media source which Input Trust Authority (ITA) to create.

Gets the type of a PlayReady license acquisition service request.

The type of a PlayReady license acquisition service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the PlayReady media protection system identifier.

The PlayReady media protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the type of a PlayReady metering service request.

The type of a PlayReady metering service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the current certificate security level.

The current certificate security level. If not individualized or provisioned, this property returns zero (0).

Gets the PlayReady runtime security version.

The PlayReady runtime security version.

Gets the PlayReady content protection system ID inside a PSSH box.

Specifies the PlayReady content protection system ID inside a PSSH box. This parameter is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the type of a PlayReady revocation service request.

The type of a PlayReady revocation service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Gets the type of a PlayReady secure stop service request.

The type of a PlayReady secure stop service request. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.

Queries whether the specified hardware digital rights management (DRM) feature is supported on the system.

The hardware DRM feature to query. **true** if the hardware DRM feature is supported, otherwise **false**.

Explicitly resets any temporary disablement of hardware digital rights management (DRM), if any.

Describes the purpose of the audio information in an audio stream.

Audio is for system or application notifications, for example ring tones.

Audio is for general media, for example audio for video, or streaming audio, and can be played as background. This enumeration value is deprecated. For more information, see Remarks.

BackgroundCapableMedia is deprecated and might not work on all platforms. For more info, see MSDN.

Audio is for peer-to-peer communications, for example chat or VoIP.

Audio is for general media, for example audio for video, or streaming audio, but should not be played as background. This enumeration value is deprecated. For more information, see Remarks.

ForegroundOnlyMedia is deprecated and might not work on all platforms. For more info, see MSDN.

Audio is voice chat for games.

Audio is for game-specific sound effects.

Audio is background (non-event or ambient) audio for games.

Audio is media playback.

Audio is movie audio.

All other streams.

Audio is for sound effects.

Audio is speech.

Represents a constraint for a SpeechRecognizer object.

Gets or sets whether the constraint can be used by the SpeechRecognizer object to perform recognition.

True if a speech recognizer can perform recognition using the constraint; otherwise false.

Gets or sets the weighted value of the constraint.

An enumeration that indicates the weighted value of the constraint.

Gets or sets a tag that can be useful for identifying the constraint.

A string representing the tag.

Gets the type of the constraint.

An enumeration that indicates the type of the constraint.

Contains continuous recognition event data for the SpeechContinuousRecognitionSession.Completed event.

Gets the status of a continuous speech recognition session (or the result of a grammar constraint compilation).

The status of a continuous speech recognition session (or the result of a grammar constraint compilation).

Specifies the behavior of the speech recognizer during a continuous recognition session.

Speech recognizer continues listening for and processing speech input after a recognition result is generated.

Speech recognizer pauses and suspends further processing of speech input when a recognition result is generated.

Contains event data for the SpeechContinuousRecognitionSession.ResultGenerated event.

Gets the complete recognition result returned by the speech recognizer at the end of a continuous recognition session where SpeechRecognitionResultStatus is set to Success.

The complete recognition result returned by the speech recognizer at the end of a dictation session.

Manages speech input for free-form dictation, or an arbitrary sequence of words or phrases that are defined in a local grammar file constraint.

Gets or sets the time threshold at which the continuous recognition session ends due to lack of audio input.

The time threshold.

Occurs when a continuous recognition session ends.

Occurs when the speech recognizer returns the result from a continuous recognition session.

Asynchronously cancel the continuous speech recognition session and discard all pending recognition results.

An asynchronous handler called when the operation is complete.

Asynchronously pause a continuous speech recognition session to update a local grammar file or list constraint.

An asynchronous handler called when the operation is complete.

Resumes a continuous speech recognition session, if paused.

*Overload*

An asynchronous handler called when the operation is complete.

*Overload*

The speech recognition behavior. An asynchronous handler called when the operation is complete.

Asynchronously end a continuous speech recognition session and pass all pending recognition results to the ResultGenerated event.

An asynchronous handler called when the operation is complete.

Specifies the type of audio problem detected.

No audio problem.

No audio. For example, the microphone may have been muted.

User spoke too fast.

Input volume too high.

Too much background noise interfering with the speech recognition.

Input volume too quiet.

User spoke too slowly.

The result of compiling the constraints set for a SpeechRecognizer object.

Gets the result state (SpeechRecognitionResultStatus ) from the compiling of grammar constraints.

The status of the result.

Specifies confidence levels that indicate how accurately a spoken phrase was matched to a phrase in an active constraint.

The confidence level is high.

The confidence level is low.

The confidence level is medium.

The spoken phrase was not matched to any phrase in any active grammar.

Specifies the weighted value of a constraint for speech recognition.

The constraint has a low weighted value.

The constraint has a high weighted value.

The constraint has a medium weighted value.

Specifies the grammar definition constraint used for speech recognition.

A constraint based on a Speech Recognition Grammar Specification (SRGS) grammar file. See SpeechRecognitionGrammarFileConstraint.

A constraint based on a list of words or phrases. See SpeechRecognitionListConstraint.

A pre-defined, web-service grammar constraint based on a dictation topic. See SpeechRecognitionTopicConstraint.

A constraint based on a Voice Command Definition (VCD) file. See SpeechRecognitionVoiceCommandDefinitionConstraint.

A custom grammar constraint based on a list of words or phrases (defined in a Speech Recognition Grammar Specification (SRGS) file) that can be recognized by the SpeechRecognizer object.

Creates an instance of the SpeechRecognitionGrammarFileConstraint class from a file object.

An object representing a Speech Recognition Grammar Specification (SRGS) grammar file.

Creates an instance of the SpeechRecognitionGrammarFileConstraint class from a file object and a tag.

An object representing a Speech Recognition Grammar Specification (SRGS) grammar file. The tag to assign to the constraint.

Gets the StorageFile object representing the Speech Recognition Grammar Specification (SRGS) grammar file.

The object representing the Speech Recognition Grammar Specification (SRGS) grammar file.

Gets or sets whether the constraint can be used by the speech recognizer to perform recognition.

True if a speech recognizer can perform recognition using the constraint; otherwise false.

Gets or sets the weighted value of the constraint.

An enumeration that indicates the weighted value of the constraint.

Gets or sets a tag that can be useful for identifying the constraint.

A string representing the tag.

Gets the type of the constraint.

An enumeration that indicates the type of the constraint. Always returns Grammar for SpeechRecognitionGrammarFileConstraint.

A recognition result fragment returned by the speech recognizer during an ongoing dictation session.

Gets the text of the hypothesis, or recognition result fragment, returned by the speech recognizer during an ongoing dictation session.

The text of the recognition result fragment.

Contains event data for the SpeechRecognizer.HypothesisGenerated event.

Gets a recognition result fragment returned by the speech recognizer during an ongoing dictation session.

The recognition result fragment.

A custom grammar constraint based on a list of words or phrases that can be recognized by the SpeechRecognizer object. When initialized, this object is added to the Constraints collection.

Creates an instance of the SpeechRecognitionListConstraint class from an array of words or phrases.

A string array of words or phrases that make up the constraint.

Creates an instance of the SpeechRecognitionListConstraint class from an array of words or phrases and a tag.

A string array of words or phrases that make up the constraint. The tag to assign to the constraint.

Gets the array of words or phrases that make up the constraint.

A string array of words or phrases that make up the constraint.

Gets or sets whether the constraint can be used by the speech recognizer to perform recognition.

if a speech recognizer can perform recognition using the constraint; otherwise .

Gets or sets the weighted value of the constraint.

An enumeration that indicates the weighted value of the constraint.

Gets or sets a tag that can be useful for identifying the constraint.

A string representing the tag.

Gets the type of the constraint.

An enumeration that indicates the type of the constraint. Always returns List for SpeechRecognitionListConstraint.

Provides data for the SpeechRecognitionQualityDegradingEvent event.

Gets the audio problem that occurred.

The audio problem that occurred.

The result of a speech recognition session.

Gets a value that indicates the confidence of the speech recognizer in the recognition result.

The confidence level of the recognition result.

Gets the constraint used for the recognition result.

The constraint used for the recognition result. Null for remote recognition using predefined grammars (SpeechRecognitionTopicConstraint ).

Gets the amount of time required for the utterance.

The duration of the utterance.

Gets the start time of the utterance.

The start time of the utterance.

Gets a value that indicates the relative confidence of the SpeechRecognitionResult when compared with a collection of alternatives returned with the recognition result.

The confidence level of the result.

Gets the hierarchy of rule elements that were triggered to return the recognized phrase.

An array that represents the hierarchy of rule elements that were triggered to return the recognized phrase. Each value in the array contains the value of the id attribute for a rule element. The order of values in the array corresponds to the order that the rules were triggered.

Gets an interpretation object containing the semantic properties of a recognized phrase in a Speech Recognition Grammar Specification (SRGS) grammar.

An interpretation object containing the semantic properties of a recognized phrase in a Speech Recognition Grammar Specification (SRGS) grammar.

Gets the result state (SpeechRecognitionResultStatus ) of a speech recognition session.

The status of the result.

Gets the recognized phrase of the speech recognition session.

The recognized phrase of the speech recognition session.

Gets a collection of recognition result alternatives, ordered by RawConfidence from most likely to least likely. The first item in the collection is the recognition result indicated by the parent object.

The maximum number of speech recognition results to return in the collection. A collection of speech recognition results, ordered by confidence from most likely to least likely.

Specifies the possible result states of a speech recognition session or from the compiling of grammar constraints.

Audio problems caused recognition to fail.

A grammar failed to compile.

The language of the speech recognizer does not match the language of a grammar.

Lack of a microphone caused recognition to fail.

Network problems caused recognition to fail.

An extended pause, or excessive processing time, caused recognition to fail.

The recognition session or compilation succeeded.

A timeout due to extended silence or poor audio caused recognition to fail.

A topic constraint was set for an unsupported language.

An unknown problem caused recognition or compilation to fail.

User canceled recognition session.

Specifies the scenario used to optimize speech recognition for a web-service constraint (created through a SpeechRecognitionTopicConstraint object).

A gramar constraint optimized for continuous recognition scenarios.

A grammar constraint optimized for form input recognition scenarios.

A grammar constraint optimized for web search recognition scenarios.

Represents the semantic properties of a recognized phrase in a Speech Recognition Grammar Specification (SRGS) grammar.

Gets a dictionary of the semantic properties.

A dictionary of the semantic properties.

A pre-defined grammar constraint (specifed by SpeechRecognitionScenario ) provided through a web service.

Creates an instance of the SpeechRecognitionTopicConstraint class by using a pre-defined scenario type and context.

A predefined scenario type. A subject, or context hint, used to optimize recognition.

Creates an instance of the SpeechRecognitionTopicConstraint class by using a pre-defined scenario type, context, and an identifier.

A predefined scenario type. A subject, or context hint, used to optimize recognition. Identifier for the constraint.

Gets or sets whether the constraint can be used by the SpeechRecognizer object to perform recognition.

if a speech recognizer can perform recognition using the constraint; otherwise .

Gets or sets the weighted value of the constraint.

An enumeration that indicates the weighted value of the constraint.

Gets the predefined scenario type for the constraint.

The predefined scenario type for the constraint.

Gets or sets a tag that can be useful for identifying the constraint.

A string representing the tag.

Gets the topic hint for the constraint.

The topic hint for the constraint.

Gets the type of the constraint.

An enumeration that indicates the type of the constraint. Always returns Topic for SpeechRecognitionTopicConstraint.

A constraint for a SpeechRecognizer object based on a file.

Gets or sets whether the constraint can be used by the SpeechRecognizer object to perform recognition.

if a speech recognizer can perform recognition using the constraint; otherwise .

Gets or sets the weighted value of the constraint.

An enumeration that indicates the weighted value of the constraint.

Gets or sets a tag that can be useful for identifying the constraint.

A string representing the tag.

Gets the type of the constraint.

An enumeration that indicates the type of the constraint.

Enables speech recognition with either a default or a custom graphical user interface (GUI).

Creates a new instance of the SpeechRecognizer class.

Creates a new instance of the SpeechRecognizer class with a language specifier.

The spoken language to use for recognition.

Gets the collection of constraint objects currently added to the SpeechRecognizer object.

A collection of ISpeechRecognitionConstraint objects.

Gets the continuous recognition session object (SpeechContinuousRecognitionSession ) associated with this SpeechRecognizer.

The continuous recognition session object associated with this SpeechRecognizer.

Gets the language used for speech recognition.

The language used for speech recognition.

Gets the state of the speech recognizer.

The speech recognizer state.

Gets the collection of languages supported by the custom grammars of the SpeechRecognitionGrammarFileConstraint and SpeechRecognitionListConstraint objects specified in the Constraints property.

The collection of grammar languages.

Gets the collection of languages supported by the pre-defined, web-service grammars of the SpeechRecognitionTopicConstraint objects specified in the Constraints property.

The collection of languages supported by the pre-defined, web-service grammars.

Gets the speech language of the device specified in **Settings > Time & Language > Speech**.

The speech language of the device, or null if a speech language is not installed.

Gets how long a speech recognizer ignores silence or unrecognizable sounds (babble) and continues listening for speech input.

The timeout settings.

Gets the UI settings for the RecognizeWithUIAsync method.

The UI settings.

Occurs during an ongoing dictation session when a recognition result fragment is returned by the speech recognizer.

This event is raised when an audio problem is detected that might affect recognition accuracy.

This event is raised when a change occurs to the State property during audio capture.

Disposes the speech recognizer by freeing, releasing, or resetting allocated resources.

Asynchronously compile all constraints specified by the Constraints property.

The result of the constraints compilation as a SpeechRecognitionCompilationResult object.

Begins a speech recognition session for a SpeechRecognizer object.

The result of the speech recognition session that was initiated by the SpeechRecognizer object.

Asynchronously starts a speech recognition session that includes additional UI mechanisms, including prompts, examples, text-to-speech (TTS), and confirmations.

The result of the speech recognition session as a SpeechRecognitionResult object.

Asynchronously ends the speech recognition session.

No object or value is returned when this method completes.

Asynchronously attempts to set the system language used for speech recognition on an IoT device.

The BCP-47 -based system language used for speech recognition. An asynchronous operation that returns true if the set operation was a success. Otherwise, returns false.

Specifies the state of the speech recognizer.

Indicates that the speech recognizer is capturing (listening for) audio input from the user.

Indicates that speech recognition is not active and the speech recognizer is not capturing (listening for) audio input.

Only valid for continuous recognition.

Indicates that the speech recognizer is processing (attempting to recognize) audio input from the user. The recognizer is no longer capturing (listening for) audio input from the user.

Indicates that the speech recognizer no longer detects sound on the audio stream.

Indicates that the speech recognizer has detected sound on the audio stream.

Indicates that the speech recognizer has detected speech input on the audio stream.

Provides data for the SpeechRecognizer.StateChangedEvent event.

Gets the audio capture state.

The audio capture state.

The timespan that a speech recognizer ignores silence or unrecognizable sounds (babble) and continues listening for speech input.

Gets and sets the length of time that a SpeechRecognizer continues to listen while receiving unrecognizable sounds (babble) before it assumes speech input has ended and finalizes the recognition operation.

The length of time that the speech recognizer continues to listen while detecting only non-speech input such as background noise. The default is 0 seconds (not activated).

Gets and sets the length of time, after recognition results have been generated, that a SpeechRecognizer detects silence and assumes speech input has ended.

The length of time that the speech recognizer continues to listen while detecting only silence. The default is 150 milliseconds.

Gets and sets the length of time, before any recognition results have been generated, that a SpeechRecognizer detects silence and assumes speech input has ended.

The length of time that the speech recognizer continues to listen while detecting only silence. The default is 5 seconds.

Specifies the UI settings for the SpeechRecognizer.RecognizeWithUIAsync method.

Gets or sets the heading text that is displayed on the **Listening** screen. The default is "Listening...".

The heading text. A custom string should clearly describe the kind of info expected by the app and is limited to two lines in length.

Gets or sets the example text shown on the **Listening** screen.

The example text that is shown on the **Listening** screen.

Gets or sets whether the recognized text is spoken back to the user on the **Heard you say** screen.

True if the recognized text is spoken back to the user. Otherwise, false. The default is true.

Gets or sets whether a **Heard you say** screen is shown to the user after speech recognition is completed.

True if a **Heard you say** screen is shown. Otherwise, false. The default is true.

Specifies the amount of silence added to the end of the speech synthesis utterance (before another utterance begins).

The default amount of silence defined by the speech synthesis voice.

The minimum amount of silence defined by the speech synthesis voice.

Specifies the amount of silence added after punctuation in the speech synthesis utterance (before another utterance begins).

The default amount of silence defined by the speech synthesis voice.

The minimum amount of silence defined by the speech synthesis voice.

Supports reading and writing audio data generated by the speech synthesis engine (voice) to/from a random access stream.

Gets whether SpeechSynthesisStream can be read from.

True if the stream can be read from; otherwise false.

Gets a value that indicates whether SpeechSynthesisStream can be written to.

True if the stream can be written to; otherwise false.

Gets the MIME type of the content of SpeechSynthesisStream.

The MIME type (audio/wav) of the stream.

Gets the collection of timeline markers associated with the SpeechSynthesisStream.

When this method completes successfully, it returns a collection of IMediaMarker objects that represent the timeline markers in the stream.

Gets the current position within the SpeechSynthesisStream.

The current position within the stream.

Gets or sets the size of the SpeechSynthesisStream.

The size of the stream.

Gets the collection of optional word and sentence boundaries in the speech synthesis stream as specified by the SpeechSynthesizer.Options property.

A collection of TimedMetadataTrack objects.

Creates a copy of SpeechSynthesisStream that references the same bytes as the original stream.

The new stream.

Releases system resources that are exposed by SpeechSynthesisStream.

Flushes data asynchronously in a sequential stream.

An asynchronous operation. For more information, see FlushAsync method.

Retrieves an input stream at a specified location in SpeechSynthesisStream.

The location in the stream at which to begin. The input stream.

Retrieves an output stream at a specified location in SpeechSynthesisStream.

The location in the stream at which to begin. The output stream.

Reads data asynchronously in a sequential stream.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. An asynchronous operation that includes progress updates. For more information, see ReadAsync method.

Goes to the specified position within SpeechSynthesisStream.

The desired position within the stream.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation places the bytes to write. An asynchronous operation that includes progress updates. For more information, see WriteAsync method.

Provides access to the functionality of an installed speech synthesis engine (voice) for Text-to-speech (TTS) services.

Initializes a new instance of a SpeechSynthesizer object.

Gets a collection of all installed speech synthesis engines (voices).

A collection of VoiceInformation objects.

Gets the default speech synthesis engine (voice).

The default voice.

Gets a reference to the collection of options that can be set on the SpeechSynthesizer object.

The speech synthesizer options.

Gets or sets the speech synthesis engine (voice).

A speech synthesis engine (or voice). The default value is the current system voice.

Closes the SpeechSynthesizer and releases system resources.

Asynchronously generate and control speech output from a Speech Synthesis Markup Language (SSML) Version 1.1 string.

The SSML-modified text to speak. A SpeechSynthesisStream that represents the speech generated from the Speech Synthesis Markup Language (SSML) Version 1.1.

Asynchronously generate speech output from a string.

The text to speak. A SpeechSynthesisStream that represents the speech generated from the text.

Asynchronously attempts to set the voice used for speech synthesis on an IoT device.

One of the installed speech synthesis engines (voices). An asynchronous operation that returns true if the set operation was a success. Otherwise, returns false.

Provides access to various speech synthesizer options.

Gets or sets the amount of silence added to the end of the speech synthesis utterance (before another utterance begins).

The SpeechAppendedSilence duration.

Gets or sets the tone (relative highness or lowness) of the speech synthesis utterance.

The tone of the selected speech synthesis engine (voice).

Gets or sets the loudness of the speech synthesis utterance.

The loudness of the selected speech synthesis engine (voice).

Gets or sets whether sentence boundary metadata is added to a SpeechSynthesisStream object.

**true** if sentence boundaries are marked. Otherwise, **false**.

Gets or sets whether word boundary metadata is added to a SpeechSynthesisStream object.

**true** if word boundaries are marked. Otherwise, **false**.

Gets or sets the amount of silence added after punctuation in the speech synthesis utterance (before another utterance begins).

The SpeechPunctuationSilence duration.

Gets or sets the tempo (including pauses and hesitations) of the speech synthesis utterance.

The tempo, relative to the default rate of the selected speech synthesis engine (voice).

Specifies the gender preferences available for speech synthesis (if supported by the specified speech synthesis engine).

Female

Male

Provides info about an installed speech synthesis engine (voice).

Gets the description of the speech synthesis engine (voice).

The description, based on a combination of DisplayName and Language. For example, Microsoft David - English (United States).

Gets the display name associated with the speech synthesis engine (voice).

The display name of the voice.

Gets the gender setting of the speech synthesis engine (voice).

The gender of the voice.

Gets the unique ID of the speech synthesis engine (voice).

The unique ID.

Gets the normalized BCP-47 language tag of the speech synthesis engine (voice).

The normalized BCP-47 language tag.

Represents the source of adaptive streaming content.

Gets the advanced settings for the adaptive media source.

The advanced settings for the adaptive media source.

Gets a value indicating if the content streamed by the media source contains only audio.

True if the content only contains audio; otherwise, false.

Gets the available adaptive bit rates of the adaptive streaming manifest that is the source of the adaptive streaming object.

The list of available adaptive bit rates of the adaptive streaming manifest.

Gets a value indicating the current download bitrate for the media source.

The current download bitrate for the media source.

Gets a value indicating the current playback bitrate for the media source.

The current playback bitrate for the media source.

Gets or sets the desired offset of live playback from the end of the known media content that has been downloaded.

The desired offset for the live playback of the streaming media. This value must be greater than MinLiveOffset. If the specified value is less than the minimum value, it is automatically clamped to the allowed range.

Gets or sets the desired maximum bitrate for the media source.

The desired maximum bitrate for the streaming media.

Gets or sets the desired minimum bitrate for the media source.

The desired minimum bitrate for the streaming media.

Gets or sets the requested maximum size of the time window within which the user can seek within the streaming media.

The requested maximum size of the time window in which the user can seek within the streaming media. This value must be between zero and the value of MaxSeekableWindowSize. If the specified value is greater than the maximum value, the system automatically clamps to the allowed range, but when you retrieve the property it will return the unclamped value.

Gets an object that provides an event that is raised when diagnostic information about the adaptive media source is available.

An object that provides an event that is raised when diagnostic information about the adaptive media source is available.

Gets a value indicating the inbound bits per second statistic over the time window specified by the InboundBitsPerSecondWindow property.

The inbound bits per second over the InboundBitsPerSecondWindow time span.

Gets or sets the time span over which the InboundBitsPerSecond property is calculated.

The time span over which the InboundBitsPerSecond property is calculated.

Gets and sets the initial bit rate to use for playback of the media source.

The initial bit rate to use for playback.

Gets a value that indicates whether the media source is live.

A value that indicates whether playback of the adaptive streaming object is live. **true** if live; otherwise, **false**.

Gets the maximum time window within which the user can seek within the streaming media.

The maximum time window within which the user can seek within the streaming media.

Gets the minimum offset of live playback from the end of the known media content that has been downloaded.

The minimum offset of live playback from the end of the known media content that has been downloaded.

Occurs when the CurrentDownloadBitrate changes.

Occurs when a resource download operation completes

Occurs when a resource download operation fails.

Occurs when a resource download operation is requested.

Occurs when the CurrentPlaybackBitrate changes.

Closes the adaptive media source and frees up associated resources.

Asynchronously creates a AdaptiveMediaSource object from the provided input stream.

The input stream from which the AdaptiveMediaSource is created. The Uniform Resource Identifier (URI) of the source. This is used by the AdaptiveMediaSource to resolve relative URIs. A string that identifies the MIME content type of the source. This can be an Http Live Streaming (HLS) or a Dynamic Adaptive Streaming over HTTP (DASH) content type. Returns an AdaptiveMediaSourceCreationResult upon successful completion.

Asynchronously creates a AdaptiveMediaSource object from the provided input stream.

The input stream from which the AdaptiveMediaSource is created. The Uniform Resource Identifier (URI) of the source. This is used by the AdaptiveMediaSource to resolve relative URIs. A string that identifies the MIME content type of the source. This can be an Http Live Streaming (HLS) or a Dynamic Adaptive Streaming over HTTP (DASH) content type. The HttpClient instance that the AdaptiveMediaSource should use for downloading resources. This allows you to specify custom HTTP headers for the requests. Returns an AdaptiveMediaSourceCreationResult upon successful completion.

Asynchronously creates a AdaptiveMediaSource object from the Uniform Resource Identifier (URI) of the source.

T he Uniform Resource Identifier (URI) of the source. Returns an AdaptiveMediaSourceCreationResult upon successful completion.

Asynchronously creates a AdaptiveMediaSource object from the Uniform Resource Identifier (URI) of the source.

The Uniform Resource Identifier (URI) of the source. The HttpClient instance that the AdaptiveMediaSource should use for downloading resources. This allows you to specify custom HTTP headers for the requests. Returns an AdaptiveMediaSourceCreationResult upon successful completion.

Gets an object that provides timing information that is correlated between timestamps in the media or date/time information from the manifest with the presentation clock timeline.

An object that provides correlated timing information for the adaptive media source.

Determines whether the content type of the source is supported.

A string that identifies the content type of the source. Can be a Http Live Streaming (HLS) or Dynamic Adaptive Streaming over HTTP (DASH) content type. Returns a value that indicates whether the content type of the source is supported. **true** if supported; otherwise, **false**.

Provides advanced settings for an AdaptiveMediaSource.

Gets or sets a value indicating whether media segments are known in advance to be fully independent such that each segment can be decoded and rendered without requiring any information from any other media segment.

True if the media segments for the AdaptiveMediaSource are independent; otherwise, false.

Gets or sets a value that specifies how low the inbound bits per second may drop before the adaptive media source will switch down to a different encoding bitrate to download.

A floating point value that is the ratio of actual inbound bitrate to the target bitrate.

Gets or sets a value that specifies the minimum inbound bits per second required before the adaptive media source will switch up to one of the available encoded bitrates to download.

The minimum inbound bits per second before switching to another available encoded bitrate.

Represents time stamps that are correlated between the playback position of the media player with time stamps embedded in the media stream or included in the manifest file.

Gets a timespan representing the current playback position of the media player that is playing the content.

A timespan representing the current playback position of the media player that is playing the content.

Gets a timespan representing the presentation timestamp embedded in the streaming media.

A timespan representing the presentation timestamp embedded in the streaming media.

Gets a DateTime structure representing a time specified in the manifest file for the streaming media.

A structure representing a time specified in the manifest file for the streaming media.

Represents the result of the creation of a AdaptiveMediaSource object.

Gets the extended error code associated with the creation of a AdaptiveMediaSource object.

The extended error code associated with the creation of a AdaptiveMediaSource object.

Gets the HTTP response message, if any, returned from an attempt to create a AdaptiveMediaSource object.

The HTTP response message returned from an attempt to create a AdaptiveMediaSource object.

Gets the AdaptiveMediaSource object that represents the source of adaptive streaming content.

The AdaptiveMediaSource object that represents the source of adaptive streaming content.

Gets the status of an attempt to create a AdaptiveMediaSource object.

A AdaptiveMediaSourceCreationStatus -typed value that specifies the result of an attempt to create a AdaptiveMediaSource object.

Specifies the result of an attempt to create a AdaptiveMediaSource object.

The creation of the AdaptiveMediaSource object failed as the result of a failure in downloading the adaptive streaming manifest.

The creation of the AdaptiveMediaSource object failed as the result of a failure in parsing the adaptive streaming manifest.

The AdaptiveMediaSource object was successfully created.

The creation of the AdaptiveMediaSource object failed because of an unknown failure.

The creation of the AdaptiveMediaSource object failed because the content of the adaptive streaming manifest is unsupported.

The creation of the AdaptiveMediaSource object failed because the profile of the adaptive streaming manifest is unsupported.

The creation of the AdaptiveMediaSource object failed because the version of the adaptive streaming manifest is unsupported.

Provides data for the DiagnosticAvailable event which is raised when diagnostic information for the adaptive media source becomes available.

Gets the bitrate of the web request to which the diagnostic information applies.

The bitrate of the web request to which the diagnostic information applies.

Gets a value indicating the type of diagnostic that is associated with the event.

A value indicating the type of diagnostic that is associated with the event.

Gets the extended error code associated with the event.

The extended error code associated with the event.

Gets the presentation playback position associated with the event.

The presentation playback position associated with the event.

Gets a locally-unique identifier for the web request associated with the event.

A locally-unique identifier for the web request associated with the event.

Gets the resource byte range length of the web request to which the diagnostic information applies.

The resource byte range length of the web request to which the diagnostic information applies.

Gets the resource byte range offset of the web request to which the diagnostic information applies.

The resource byte range offset of the web request to which the diagnostic information applies.

Gets a string representing the content type associated with the event.

The content type associated with the event.

Gets a TimeSpan representing the duration of the resource associated with the event.

The duration of the resource associated with the event.

Gets the resource type of the web request to which the diagnostic information applies.

The resource type of the web request to which the diagnostic information applies.

Gets the resource URI of the web request to which the diagnostic information applies.

The resource URI of the web request to which the diagnostic information applies.

Gets the segment ID of the media segment to which the diagnostic information applies.

The segment ID of the media segment to which the diagnostic information applies.

Provides an event that is raised when diagnostic information about the adaptive media source is available.

Occurs when diagnostic information about the adaptive media source is available.

Specifies the type of diagnostic event that is associated with a AdaptiveMediaSourceDiagnostics.DiagnosticAvailable.

The AdaptiveMediaSource will not attempt to download any more segments for a particular bitrate.  

Introduced in Windows.Foundation.UniversalApiContract v5. The **AdaptiveMediaSource ** passed an error to the media pipeline that caused playback to stop. This diagnostic is not intended to replace media failure events provided by the MediaPlayer, such as the **MediaFailed ** event. Instead, this diagnostic can be useful for correlating errors originating from the media source with potential corruption of error conditions with the content delivery network.

During playback of live content, the new manifest represents a different presentation than the previously downloaded manifest.

During the playback of live content, the previous manifest did not specify a duration or contain an end of list indicator, and the new updated manifest does specify a duration or end of list indicator.  This means that a live presentation will end after the remaining media segments are downloaded and played.

During playback of live content, the new manifest is identical to the last one downloaded.  For HLS where the manifest is updated continuously to add new segments to the end of the playlist, this may indicate a stall in the server or encoding process.

The AdaptiveMediaSource skipped an entire media segment across all bitrates.  This could happen due to corruption on the CDN or missing resources. This will typically result in a gap in playback and video/audio artifacts.

The AdaptiveMediaSource got a resource not found error when downloading a particular resource. This may indicate a problem with the content manifest or an issue with the CDN.

The AdaptiveMediaSource encountered an error while parsing a segment or key.  This can indicate corruption on the CDN or an invalid decryption key.

The AdaptiveMediaSource was unable to fully download a particular resource in the allotted amount of time.  The download may be attempted again, or the **AdaptiveMediaSource** may switch to another bitrate to continue filling the buffer at the current download position.

Provides data for the DownloadBitrateChanged event.

Gets a value indicating the new download bitrate for the media source.

A value indicating the new download bitrate for the media source.

Gets a value indicating the previous download bitrate for the media source.

A value indicating the previous download bitrate for the media source.

Gets a value specifying the reason that the download bitrate changed.

A value specifying the reason that the download bitrate changed.

Specifies the reason that the download bitrate changed. This value is used for the AdaptiveMediaSource.DownloadBitrateChanged event.

The bitrate changed as a result of the app changing one of the properties on the AdaptiveMediaSource such as the DesiredMinBitrate, DesiredMaxBitrate, or InitialBitrate.

The bitrate changed as a result of an error occurring with the previously selected bitrate. If there is a missing resource, or corruption is detected, or a download times out, the system may switch to a different bitrate in order to fill the buffer at the current download position to avoid gaps in playback.

The estimated InboundBitsPerSecond dropped, which required switching to a lower bitrate to avoid stalls in playback.

The amount of data buffered ahead of the playback position dropped enough that a change in download bitrate was required in order to avoid stalling playback while rebuffering.

The bitrate changed as a result of seeking to a new position.  The system may switch to a lower bitrate temporarily in order to refill the buffer and resume playback faster.

The estimated InboundBitsPerSecond was large enough to allow switching to a higher bitrate.

The bitrate changed as a result of a track selection change.  The system may switch to a lower bitrate temporarily in order to refill the buffer for the new track and resume playback faster.

Provides data for the DownloadCompleted event.

Gets the http response message, if any, returned from the completed media download request.

The http response message returned from the completed media download request.

Gets a time span representing the position within the timeline of the media segment to which the event applies.

A time span representing the position within the timeline of the media segment to which the event applies.

Gets a locally-unique identifier for the web request associated with the event.

A locally-unique identifier for the web request associated with the event.

Gets the byte range length of the completed media download request.

The byte range length of the completed media download request.

Gets the byte range offset of the completed media download request.

The byte range offset of the completed media download request.

Gets a string representing the content type associated with the event.

The content type associated with the event.

Gets a TimeSpan representing the duration of the resource associated with the event.

The duration of the resource associated with the event.

Gets the resource type of the completed media download request.

The resource type of the completed media download request.

Gets the resource URI of the completed media download request.

The resource URI of the completed media download request.

Gets an object that provides download statistics associated with the event.

An object that provides download statistics associated with the event.

Provides data for the DownloadFailed event.

Gets the extended error code associate with the event.

The extended error code associate with the event.

Gets the http response message, if any, returned from the failed media download request.

The http response message returned from the failed media download request.

Gets a time span representing the position within the timeline of the media segment to which the event applies.

A time span representing the position within the timeline of the media segment to which the event applies.

Gets a locally-unique identifier for the web request associated with the event.

A locally-unique identifier for the web request associated with the event.

Gets the byte range length of the failed media download request.

The byte range length of the failed media download request.

Gets the byte range offset of the failed media download request.

The byte range offset of the failed media download request.

Gets a string representing the content type associated with the event.

The content type associated with the event.

Gets a TimeSpan representing the duration of the resource associated with the event.

The duration of the resource associated with the event.

Gets the resource type of the failed media download request.

The resource type of the failed media download request.

Gets the resource URI of the failed media download request.

The resource URI of the failed media download request.

Gets an object that provides download statistics associated with the event.

An object that provides download statistics associated with the event.

Represents a deferral that can be used to defer the completion of the DownloadRequested event so that the app can asynchronously download media content.

Informs the system that an asynchronous operation associated with a DownloadRequested event has finished.

Provides data for the DownloadRequested event.

Gets a time span representing the position within the timeline of the media segment to which the event applies.

A time span representing the position within the timeline of the media segment to which the event applies.

Gets a locally-unique identifier for the web request associated with the event.

A locally-unique identifier for the web request associated with the event.

Gets the byte range length of the media download request.

The byte range length of the media download request.

Gets the byte range offset of the media download request.

The byte range offset of the media download request.

Gets a string representing the content type associated with the event.

The content type associated with the event.

Gets a TimeSpan representing the duration of the resource associated with the event.

The duration of the resource associated with the event.

Gets the resource type of the media download request.

The resource type of the media download request.

Gets the resource URI of the media download request.

The resource URI of the media download request.

Gets an AdaptiveMediaSourceDownloadResult object representing the result of the media download request.

The result of the media download request.

Gets a deferral that can be used to defer the completion of the DownloadRequested event so that the app can asynchronously download media content.

A deferral that can be used to defer the completion of the DownloadRequested event.

Represents the results of a resource download operation.

Gets or sets a buffer containing the downloaded resource.

A buffer containing the downloaded resource.

Gets or sets a string that identifies the MIME content type of the downloaded resource.

A string that identifies the MIME content type of the downloaded resource.

Gets or sets an integer value that represents extended status information about the resource download operation.

An integer value that represents extended status information about the resource download operation.

Gets or sets an input stream containing the downloaded resource.

An input stream containing the downloaded resource.

Gets or sets the requested byte range of the resource to be downloaded.

The requested byte range of the resource to be downloaded.

Gets or sets the requested byte range offset of the resource to be downloaded.

The requested byte range offset of the resource to be downloaded.

Gets or sets the Uniform Resource Identifier (URI) of the downloaded resource.

The Uniform Resource Identifier (URI) of the downloaded resource.

Represents a set of download statistics associated with the AdaptiveMediaSource.DownloadFailed and AdaptiveMediaSource.DownloadCompleted events.

Gets the count of bytes that have been received at the time of the event.

The count of bytes that have been received at the time of the event.

Gets the time window between when the system makes the asyncronous http request for the content and when the first block of data has been read from the http stream.

The time window between when the system makes the asyncronous http request for the content and when the first block of data has been read from the http stream.

Gets the time window between when the system makes the asyncronous http request for the content and when the operation completes, when the http headers have been received.

The time window between when the system makes the asyncronous http request for the content and when the operation completes, when the http headers have been received.

Gets the time window between when the system makes the asyncronous http request for the content and when the last block of data has been read from the http stream.

The time window between when the system makes the asyncronous http request for the content and when the last block of data has been read from the http stream.

Provides data for the PlaybackBitrateChanged event.

Gets a value indicating whether the media source contains only audio data.

A value indicating whether the media source contains only audio data.

Gets the new playback bitrate.

The new playback bitrate.

Gets the old playback bitrate.

The old playback bitrate.

Specifies the type of an adaptive media resource.

The resource is an initialization segment.

The resource is a cryptographic initialization vector.

The resource is an encryption key.

The resource is an adaptive streaming manifest.

The resource is a media segment.

The resource is a media segment index.

Transcodes audio and video files.

Creates a new instance of the MediaTranscoder class.

Specifies whether the media transcoder always re-encodes the source.

**true** if the media transcoder always re-encodes the source; otherwise **false**. The default value is **false**.

Specifies whether hardware acceleration is enabled.

Set to **true** if enabled, otherwise **false**.

Gets or sets the time interval to trim from the start of the output.

A TimeSpan structure that contains the time interval.

Gets or sets the time interval to trim from the end of the output.

A TimeSpan structure that contains the time interval.

Gets or sets the video processing algorithm which will be used for transcoding.

The video processing algorithm.

Adds the specified audio effect.

The identifier of the audio effect.

Adds the specified audio effect with configuration properties, and indicates whether the effect is required.

The identifier of the audio effect. Indicates whether the audio effect is required. Configuration properties for the audio effect.

Adds the specified video effect.

The identifier of the video effect.

Adds the specified video effect with configuration properties and indicates whether the effect is required.

The identifier of the video effect. Indicates whether the video effect is required. Configuration properties for the video effect.

Removes all audio and video effects from the transcode session.

Asynchronously initializes the trancode operation on the specified file and returns a PrepareTranscodeResult object which can be used to start the transcode operation.

The source file. The destination file. The profile to use for the operation. When this method completes, a PrepareTranscodeResult object is returned which can be used to start the transcode.

Asynchronously initializes the trancode operation on the specified media source and returns a PrepareTranscodeResult object which can be used to start the transcode operation.

The media source to perform the transcode operation on. The destination stream for the transcoded media data. The profile to use for the operation. When this method completes, a PrepareTranscodeResult object is returned which can be used to start the transcode.

Asynchronously initializes the trancode operation on the specified stream and returns a PrepareTranscodeResult object which can be used to start the transcode operation.

The source stream. The destination stream. The profile to use for the operation. When this method completes, a PrepareTranscodeResult object is returned which can be used to start the transcode.

Defines the available algorithms used by the Transcode Video Processor (XVP).

Default video processing algorithm. This algorithm prefers performance, speed, and space over quality. This algorithm will makes use of hardware.

Prefers quality over performance. This mode always runs in software and insures that hardware implementations, which may differ from the XVP are not used.

Represents an asynchronous media transcode deferral operation which can be used to start the transcode operation.

Indicates whether the trancode operation can be performed successfully.

True if the trancode operation can be performed successfully; false otherwise.

Specifies the reason for the transcode failure.

The reason for the transcode failure.

Creates an object to perform an asynchronous media transcode operation on media data.

An object that is used to control the asynchronous operation.

Specifies the reason the transcode operation failed.

The codec was not found.

Profile is invalid.

None.

Reason unknown.

The domain type of the HostName object when the HostNameType is a domain name.

A fully-qualified domain name.

The suffix of a domain name.

Provides data for the local endpoint and remote endpoint for a network connection used by network apps.

Creates a new EndpointPair object.

The local hostname or IP address for the EndpointPair object. The local service name or the local TCP or UDP port number for the EndpointPair object. The remote hostname or IP address for the EndpointPair object. The remote service name or the remote TCP or UDP port number for the EndpointPair object.

Get or set the local hostname for the EndpointPair object.

The local hostname for the EndpointPair object.

Get or set the local service name for the EndpointPair object.

The local service name for the EndpointPair object.

Get or set the remote hostname for the EndpointPair object.

The remote hostname for the EndpointPair object.

Get or set the remote service name for the EndpointPair object.

The remote service name for the EndpointPair object.

Provides data for a hostname or an IP address.

Creates a new HostName object from a string that contains a hostname or an IP address.

A string that contains a hostname or an IP address.

Gets the canonical name for the HostName object.

The canonical name for the HostName object.

Gets the display name for the HostName object.

The display name for the HostName object.

Gets the IPInformation object for a local IP address assigned to a HostName object.

The IPInformation object for the IP address.

Gets the original string used to construct the HostName object.

The original string used to construct the HostName object.

Gets the HostNameType of the HostName object.

The HostNameType of the HostName object.

Compares two strings to determine if they represent the same hostname.

A hostname or IP address. A hostname or IP address. The return value indicates the lexicographic relation of *value1* to *value2*. If the two parameters represent the same canonical hostname, then zero is returned. If *value1* is less than *value2*, the return value is less than zero. If *value1* is greater than *value2*, the return vale is greater than zero.

Determines whether the specified HostName object has an equivalent value to the current HostName object.

A HostName object that is compared with the current HostName. A Boolean value that indicates whether the specified HostName object is equal to the current HostName object.

Returns a string that represents the HostName object.

A string that represents the HostName object.

Options for how a list of EndpointPair objects is sorted.

Sort a list of EndpointPair objects by the default criteria used the system which is to minimize connection delays.

Sort a list of EndpointPair objects to optimize for long connections.

The type of a HostName object.

A Bluetooth address. This represents the hardware or media access control (MAC) address for a Bluetooth device.

A domain name.

An IPv4 address.

An IPv6 address.

Used to configure downloads prior to the actual creation of the download operation using CreateDownload. For an overview of Background Transfer capabilities, see [Transferring data in the background](https://docs.microsoft.com/previous-versions/windows/apps/hh452979(v=win.10)). Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Creates a new BackgroundDownloader object.

Creates a new BackgroundDownloader object with a BackgroundTransferCompletionGroup.

The completion group to associate with this BackgroundDownloader object.

Gets the BackgroundTransferCompletionGroup associated with the BackgroundDownloader.

The BackgroundTransferCompletionGroup associated with the BackgroundDownloader . This property can be null.

Gets or sets the cost policy for the background download operation.

Indicates whether transfers can occur on costed networks.

Gets or sets the TileNotification used to define the visuals, identification tag, and expiration time of a tile notification used to update the app tile when indicating failure of a download to the user.

The TileNotification used to indicate download failure.

Gets or sets the ToastNotification that defines the content, associated metadata, and events used in a toast notification to indicate failure of a download to the user.

The ToastNotification used to indicate download failure.

Gets or sets a string value (for example, a GUID ) indicating the group the transfer will belong to. A download operation with a group ID will only appear in operation enumerations using GetCurrentDownloadsAsync(String) with the specific group string value.

The group name.

Gets or sets the HTTP method used for the background download. The default method used for download operations is GET.

The method to use for the background download. Setting this property will override the default method used for the operation.

Gets or sets the proxy credentials for the background transfer.

The credentials used to authenticate with an HTTP proxy.

Gets or sets the credentials to use to authenticate with the origin server.

The credential to use for authentication.

Gets or sets the TileNotification used to define the visuals, identification tag, and expiration time of a tile notification used to update the app tile when indicating success of a download to the user.

The TileNotification used to indicate download success.

Gets or sets the ToastNotification that defines the content, associated metadata, and events used in a toast notification to indicate success of a download to the user.

The ToastNotification used to indicate download success.

Gets or sets the group that a download operation will belong to.

The group to associate with the download.

Initializes a DownloadOperation object that contains the specified Uri and the file that the response is written to.

The location of the resource. The file that the response will be written to. The resultant download operation.

Initializes a DownloadOperation object with the resource Uri, the file that the response is written to, and the request entity body.

The location of the resource. The file that the response will be written to. A file that represents the request entity body, which contains additional data the server requires before the download can begin. The file this object points to must be valid for the duration of the download. The resultant download operation.

Creates an asynchronous download operation that includes a URI, the file that the response will be written to, and the IInputStream object from which the file contents are read.

The location of the resource. Represents the file that the response will be written to. A stream that represents the request entity body. The resultant asynchronous download operation.

Returns a collection of pending downloads that are not associated with a BackgroundTransferGroup.

A collection of pending downloads for the current application instance.

Returns a collection of pending downloads for a specific Group.

GetCurrentDownloadsAsync(group) may be altered or unavailable for releases after Windows 8.1. Instead, use GetCurrentDownloadsForTransferGroupAsync. A string indicating a specific group of transfers. A collection of pending downloads for the specific group.

Gets all downloads associated with the provided BackgroundTransferGroup.

Contains information used to identify a group of downloads. A list of downloads currently associated with the specified group.

Used to request an unconstrained download operation. When this method is called the user is provided with a UI prompt that they can use to indicate their consent for an unconstrained operation.An unconstrained transfer operation will run without the resource restrictions normally associated with background network operations while a device is running on battery.

RequestUnconstrainedDownloadsAsync is deprecated and may not work on all platforms. For more info, see MSDN. The download operation to run unconstrained. Indicates if the operations will run unconstrained.

Used to set an HTTP request header.

The header name. The header value.

Contains status information about the download operation.

The total number of bytes received. This value does not include bytes received as response headers. If the download operation has restarted, this value may be smaller than in the previous progress report.

**true** if the download request response has changed; otherwise, **false**.

**true** if a data transfer operation has restarted; otherwise **false**.

A BackgroundTransferStatus containing the current status of the download operation.

The total number of bytes of data to download. If this number is unknown, this value is set to 0.

Defines values used to indicate if downloads and uploads within a BackgroundTransferGroup run in simultaneously or in serial.

Background Transfer operations run simultaneously.

Background Transfer operations run in serial.

Represents a set of background transfer operations (DownloadOperation or UploadOperation objects) that trigger a background task once all the operations are done (if the operations completed successfully) or fail with an error.

Creates a new BackgroundTransferCompletionGroup object.

Gets a value that indicates if Enable method on a BackgroundTransferCompletionGroup has already been called.

A value that indicates if the Enable method on the BackgroundTransferCompletionGroup has already been called.

Gets the IBackgroundTrigger used to set up the background task associated with the BackgroundTransferCompletionGroup.

The trigger used to set up the background task associated with the BackgroundTransferCompletionGroup.

Indicates that the BackgroundTransferCompletionGroup is complete and no more background transfer operations (DownloadOperation or UploadOperation objects) will be added t the completion group.

Contains information about a BackgroundTransferCompletionGroup that can be only accessed from the Run method on the IBackgroundTask.

Gets the list of DownloadOperation objects associated with the BackgroundTransferCompletionGroup.

The list of DownloadOperation objects associated with the BackgroundTransferCompletionGroup

Gets the list of UploadOperation objects associated with the BackgroundTransferCompletionGroup.

The list of UploadOperation objects associated with the BackgroundTransferCompletionGroup.

Represents a content part of a multi-part transfer request. Each BackgroundTransferContentPart object can represent either a single string of text content or a single file payload, but not both.

Creates a BackgroundTransferContentPart object.

Creates a BackgroundTransferContentPart object that identifies the content it represents.

Identifies the content.

Creates a BackgroundTransferContentPart object that identifies the file content and the name of the file that it represents.

Identifies the content. The fully qualified file name, including the local path.

Sets the source file for a BackgroundTransferContentPart containing the file for upload.

The source file.

Sets content disposition header values that indicate the nature of the information that this BackgroundTransferContentPart represents.

The header name. The header value.

Use this method to set text information that the BackgroundTransferContentPart represents.

A string value used to represent text information. (for example, api_sig, api_key, auth_token, etc...)

Defines values used to specify whether transfers can occur on metered networks.

Always download regardless of network cost. (for example, even while a user is roaming)

Allow transfers on metered networks.

Do not allow transfers on metered networks.

Used to provide errors encountered during a transfer operation.

Gets the specific error using the returned **HRESULT** value. Possible values are defined by WebErrorStatus.

An **HRESULT** returned during the operation. The error encountered.

Contains status information about the file transfer operation.

The length.

The offset.

A named group used to associate multiple download or upload operations. This class makes it easy for your app to create these groups and to complete downloads and uploads simultaneously, in serial, or based on priority.

Gets the name of the group.

The group name.

Gets or sets the property used to specify if transfers within this group run simultaneously or in serial. Possible values are defined by BackgroundTransferBehavior.

The group transfer behavior.

Creates a transfer group using the provided group name.

The name of the group. If a group with the this name already exists, this method will return a reference to the existing group object. The new BackgroundTransferGroup.

Indicates the priority that a BackgroundTransfer operation(download or upload) has in terms of scheduling within an app.

Default priority setting for an operation. By default when a new operation is created, it is placed at the end of the current transfer queue.

High priority setting for an operation. Ensures that the operation doesn't get placed at the very end of the queue, and is instead placed near the front.

Low priority setting for an operation. Ensures that the operation doesn't get placed at the very front of the queue, and is instead placed near the end.

Provides access to information about the incremental download progress event.

List of ranges that were downloaded since the previous RangesDownloaded event.

List of ranges that were downloaded since the previous RangesDownloaded event.

TRUE if the download was restarted from scratch since the previous RangesDownloaded event.

TRUE if the download was restarted from scratch since the previous RangesDownloaded event, otherwise FALSE.

Deferral allows apps to carry out asynchronous work within their RangesDownloaded handler without receiving a new RangesDownloaded event in the meantime.

**HRESULT**

Defines transfer operation status values.

The transfer operation has been cancelled.

The transfer operation has completed.

An error was encountered during the transfer operation.

The application is idle.

The application has paused the transfer operation.

The transfer operation is paused due to cost policy (for example, transitioned to a costed network).

The transfer operation is paused due to a lack of network connectivity.

One of the app-configured recoverable web error statuses (RecoverableWebErrorStatuses ).

The transfer is paused by the system due to resource constraints. Examples of constraints include the system being on Battery Saver when the application is not in the foreground. In Windows Phone, transfers will have this status if Battery Saver is activated, if the background task can't get enough memory, CPU, power resources to run, or if the network condition is 2G and the app is not in the foreground

The transfer is currently in progress.

Used to configure upload prior to the actual creation of the upload operation using CreateUpload. For an overview of Background Transfer capabilities, see [Transferring data in the background](https://docs.microsoft.com/previous-versions/windows/apps/hh452979(v=win.10)). Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Instantiates a new BackgroundUploader object.

Instantiates a new BackgroundUploader object as a member of a completion group.

The completion group that the created BackgroundUploader instance is to be a member of.

Gets the BackgroundTransferCompletionGroup associated with the BackgroundUploader.

The BackgroundTransferCompletionGroup associated with the BackgroundUploader. This property can be null.

Gets or sets the cost policy for the background upload operation.

Indicates whether transfers can occur on costed networks.

Gets and sets the TileNotification used to define the visuals, identification tag, and expiration time of a tile notification used to update the app tile when indicating failure of an upload to the user.

The TileNotification used to indicate upload failure.

Gets or sets the ToastNotification that defines the content, associated metadata, and events used in a toast notification to indicate failure of an upload to the user.

The ToastNotification used to indicate upload failure.

Gets or sets a string value (for example, a GUID ) indicating the group the upload will belong to. An upload operation with a group ID will only appear in operation enumerations using GetCurrentDownloadsAsync(String) with the specific group string value.

The group name.

Gets or sets the HTTP method used for the upload. The default method used for upload operations is POST.

The method to use for the background upload. Setting this property will override the default method used for the operation.

Gets or sets the proxy credentials for the upload.

The credentials used to authenticate with an HTTP proxy.

Gets or sets the credentials to use to authenticate with the origin server.

The credential to use for authentication.

Gets and sets the TileNotification used to define the visuals, identification tag, and expiration time of a tile notification used to update the app tile when indicating success of an upload to the user.

The TileNotification used to indicate upload success.

Gets or sets the ToastNotification that defines the content, associated metadata, and events used in a toast notification to indicate success of an upload to the user.

The ToastNotification used to indicate upload success.

Gets or sets the group that an upload operation will belong to.

The group to associate with the upload.

Initializes an UploadOperation that indicates the location for and file for upload.

The location for the upload. The file for upload. The resultant upload operation.

Returns an asynchronous operation that, on completion, returns an UploadOperation with the specified URI and one or more BackgroundTransferContentPart objects.

The location for the upload. One or more BackgroundTransferContentPart objects. The resultant asynchronous UploadOperation

Returns an asynchronous operation that, on completion, returns an UploadOperation with the specified URI, one or more BackgroundTransferContentPart objects, and the multipart subtype.

The location for the upload. One or more BackgroundTransferContentPart objects. The multipart subtype. For example, "related" for content of type "multipart/**related** ". The resultant asynchronous UploadOperation.

Returns an asynchronous operation that, on completion, returns an UploadOperation with the specified URI, multipart subtype, one or more BackgroundTransferContentPart objects, and the delimiter boundary value used to separate each part.

The location for the upload. One or more BackgroundTransferContentPart objects. The multipart subtype. For example, "related" for content of type "multipart/**related** ". A string that is used to identify the delimiter used to indicate separation between provided content parts. The resultant asynchronous UploadOperation

Returns an asynchronous operation that, on completion, returns an UploadOperation with the specified URI and the source stream.

The URI associated with the resource. Represents the source stream. The resultant asynchronous upload operation.

Returns a collection of pending uploads that are not associated with a group.

A collection of pending uploads for the current application instance.

Returns a collection of pending uploads for a specific Group.

GetCurrentUploadsAsync(group) may be altered or unavailable for releases after Windows 8.1. Instead, use GetCurrentUploadsForTransferGroupAsync. A string indicating a specific group of uploads. A collection of pending uploads for the specific group.

Gets all uploads associated with the provided BackgroundTransferGroup.

Contains information used to identify a group of uploads. A list of uploads currently associated with the specified group.

Used to request an unconstrained upload operation. When this method is called the user is provided with a UI prompt that they can use to indicate their consent for an unconstrained operation.An unconstrained transfer operation will run without the resource restrictions normally associated with background network operations while a device is running on battery.

RequestUnconstrainedUploadsAsync is deprecated and may not work on all platforms. For more info, see MSDN. The upload operation to run unconstrained. Indicates if the operations will run unconstrained.

Used to set an HTTP request header.

The header name. The header value.

Contains status information about the upload operation.

The total number of bytes received. This value does not include bytes received as part of response headers. If the upload operation has restarted, this value may be smaller than in the previous progress report.

The total number of bytes sent. If the upload operation has restarted, this value may be smaller than in the previous progress report.

TRUE if the upload request response has changed; otherwise, FALSE.

**true** if a upload transfer operation has restarted; otherwise **false**.

The current status of the upload operation.

The total number of bytes of data to upload. If this number is unknown, this value is set to 0.

The total number of bytes to upload.

Provides properties for specifying web resources to be prefetched. Windows will use heuristics to attempt to download the specified resources in advance of your app being launched by the user.

Array of URIs to download when prefetch is performed for the app.

A list of Uri objects.

Specifies the location of a well-formed XML file that contains a list of resources to be prefetched.

A Uri for a web resource.

Gets the date and time of the last successful content prefetch operation.

A 64-bit signed integer that represents a date and time.

Performs an asynchronous download operation. The Background Transfer sample demonstrates this functionality. For an overview of Background Transfer capabilities, see [Transferring data in the background](https://docs.microsoft.com/previous-versions/windows/apps/hh452979(v=win.10)). Download the Background Transfer sample for examples in JavaScript, C#, and C++/CX.

Gets and sets the cost policy for the download.

Specifies whether the transfer can happen over costed networks.

A transfer's WebErrorStatus, which can be monitored during the lifetime of the DownloadOperation.

A WebErrorStatus error.

Gets a string value indicating the group the transfer belongs to.

The group name.

This is a unique identifier for a specific download operation. A GUID associated to a download operation will not change for the duration of the download.

The unique ID for this download operation.

A boolean property to enable random access. The property must be set to TRUE before calling StartAsync() on a DownloadOperation object to use the random access feature. After calling StartAsync(), call GetResultRandomAccessStreamReference to get a reference to the random access stream and read from it.

TRUE to use the random access feature. The default value is FALSE.

Gets the method to use for the download.

The method to use for the download. This value can be **GET**, **PUT**, **RETR**, or **STOR**.

Gets or sets the transfer priority of this download operation when within a BackgroundTransferGroup. Possible values are defined by BackgroundTransferPriority.

The operation priority.

Gets the current progress of the operation.

An instance of a BackgroundDownloadProgress struct describing the current download operation's progress.

A set of WebErrorStatus values that applications anticipate the download will hit, and that the applications know how to handle.

A set of WebErrorStatus values.

Gets the URI from which to download the file.

The URI to download from.

Returns the IStorageFile object provided by the caller when creating the DownloadOperation object using CreateDownload.

The returned file object.

Gets the group that this download operation belongs to.

The transfer group.

Provides access to incremental download progress.

Returns an asynchronous operation that can be used to monitor progress and completion of the attached download. Calling this method allows an app to attach download operations that were started in a previous app instance.

Download operation with callback.

Returns the full list of file ranges that have been downloaded so far.

Returns an IVector<BackgroundTransferFileRange>.

Gets the response information.

Contains the data returned by a server response.

Gets a reference to the random access stream and reads from it. It's necessary to set IsRandomAccessRequired to TRUE before calling GetResultRandomAccessStreamReference.

A reference to the random access stream.

Gets the partially downloaded response at the specified position.

The position at which to start reading. The result stream.

Prioritizes the download transfer operation (and any transfers that follow it in the same transfer group). Calling this method on a transfer that doesn't belong to a transfer group has no effect.

Pauses a download operation.

Used to remove an HTTP request header.

The header name.

Resumes a paused download operation.

Used to set an HTTP request header.

The header name. The header value.

Starts an asynchronous download operation.

An asynchronous download operation that includes progress updates.

Represents a background transfer operation.

Gets or sets the cost policy for the background transfer operation.

Specifies whether transfers can occur over costed networks.

Gets are sets a string value indicating the group the transfer will belong to.

The group name.

Gets or sets the method to use for the background transfer.

The method to use for the download. This value can be **GET**, **PUT**, **RETR**, or **STOR**.

Gets or sets the proxy credentials for the background transfer.

The proxy credentials for the transfer.

Gets or sets the credentials used to authenticate with the origin server.

The credential to use for authentication.

Sets the request headers.

The header name. The header value.

Creates a BackgroundTransferContentPart object.

Creates a BackgroundTransferContentPart object that indicates the specified content type.

Identifies the content type. The resultant BackgroundTransferContentPart.

Creates a BackgroundTransferContentPart object that identifies the content type and name of the file.

Identifies the content type. The fully qualified file name; this includes the local path. The resultant BackgroundTransferContentPart object.

Represents a background transfer operation.

Gets and sets the cost policy for the background transfer.

Specifies whether the transfer can happen over costed networks.

Gets a string value indicating the group the transfer belongs to.

The group name.

Gets the Guid for the background transfer operation.

The unique ID for the background transfer operation.

Specifies the method to use for the background transfer operation.

The method to use. This value can be **GET**, **PUT**, **RETR**, or **STOR**.

Gets the URI for the background transfer.

The URI.

Gets the response infomation.

Contains the data returned by a server response.

Gets the partial response at the specified position.

The position at which to start reading. The result stream.

Use this interface to determine the priority of a downloads or uploads within a BackgroundTransferGroup. Possible values are defined by the BackgroundTransferPriority enumeration.

Gets or sets the priority of a download or upload operation. Possible values are defined by the BackgroundTransferPriority enumeration.

The priority of the operation.

Represents data that is returned by a server response.

Gets the URI that contains the requested data.

The URI that contains the requested data.

Gets all response headers sent by the server.

Contains all response headers sent by the server.

Gets a value that specifies whether the download is resumable.

This property returns true if a download is resumable; otherwise false is returned.

Gets the status code returned by the server.

The status code returned by the server.

Represents the result a request for unconstrained transfers from a BackgroundDownloader or BackgroundUploader object.

UnconstrainedTransferRequestResult is deprecated and may not work on all platforms. For more info, see MSDN.

Gets a value that indicates if the download or upload operations will run without the resource restrictions normally associated with background network operations while a device running on battery.

**true** if the operation runs unconstrained; otherwise, **false**.

Performs an asynchronous upload operation. For an overview of Background Transfer capabilities, see [Transferring data in the background](https://docs.microsoft.com/previous-versions/windows/apps/hh452979(v=win.10)). Download the Background Transfer sample for examples in JavaScript, C#, and C++.

Gets and sets the cost policy for the upload.

Specifies whether the transfer can happen over costed networks.

Gets a string value indicating the group the upload belongs to.

The group name.

This is a unique identifier for a specific upload operation. A GUID associated to a upload operation will not change for the duration of the upload.

The unique ID for this upload operation.

Gets the method to use for the upload.

The method to use for the upload. This value can be **GET**, **PUT**, **POST**, **RETR**, **STOR**, or any custom value supported by the server.

Gets or sets the transfer priority of this upload operation when within a BackgroundTransferGroup. Possible values are defined by BackgroundTransferPriority.

The operation priority.

Gets the current progress of the upload operation.

The delegate to invoke when progress is available for a transfer operation.

Gets the URI to upload from.

The URI to upload from.

Specifies the IStorageFile to upload.

The file item to upload.

Gets the group that this upload operation belongs to.

The transfer group.

Returns an asynchronous operation that can be used to monitor progress and completion of the attached upload. Calling this method allows an app to attach upload operations that were started in a previous app instance.

Upload operation with callback.

Gets the response information.

Contains the data returned by a server response.

Gets the partially uploaded response at the specified location.

The position at which to start reading. The result stream.

Prioritizes the upload transfer operation (and any transfers that follow it in the same transfer group). Calling this method on a transfer that doesn't belong to a transfer group has no effect.

Used to remove an HTTP request header.

The header name.

Used to set an HTTP request header.

The header name. The header value.

Starts an asynchronous upload operation.

An asynchronous upload operation that includes progress updates.

Provides access to property values containing information on current usage of the attributed network connection.

Gets the Id of the of the app.

The Id of the app.

Gets the name of the app.

The name of the app.

Gets the thumbnail of the app.

The thumbnail of the app.

Gets the number of bytes received by the app over the network.

The number of bytes received by the app.

Gets the number of bytes sent by the app over the network.

The number of bytes sent by the app.

Defines values that indicate the authentication type used for a APN. These values are referenced when providing APN details using a CellularApnContext object.

Challenge-Handshake authentication.

Microsoft Challenge-Handshake authentication (v2)

No authentication.

Password authentication.

This class contains properties used to specify an Access Point Name (APN) for a 3GPP based cellular Data Connection (PDP context).

Creates an instance of CellularApnContext.

Indicates the name of the access point to establish a connection with.

The access point name.

Indicates the authentication method, as defined by CellularApnAuthenticationType, that is used by the access point.

The authentication type.

Indicates if data compression will be used at the data link for header and data transfer.

A Boolean value. TRUE if enabled; otherwise FALSE.

Indicates the password used to authenticate when connecting to the access point.

The password associated with the user name.

Gets the name of a cellular profile.

The name of a cellular profile.

Indicates the provider ID associated with the access point.

The provider ID.

Indicates the user name used to authenticate when connecting to the access point.

The user name.

Provides access to property values that indicate the current cost of a network connection.

Gets a value that indicates if a connection is approaching the data usage allowance specified by the data plan.

TRUE if the connection profile is close to the data limit threshold; otherwise, FALSE.

Gets a value that indicates whether background data usage has been restricted.

True if background data usage is restricted.

Gets a value that indicates the current network cost for a connection.

The network cost of the connection.

Gets a value that indicates if the connection has exceeded the data usage allowance specified by the data plan.

TRUE if the current total data usage is over the specified data limit; otherwise, FALSE.

Gets a value that indicates whether the connection is connected to a network outside of the home provider.

TRUE if the connection on a roaming network; otherwise, FALSE.

Represents a network connection, which includes either the currently connected network or prior network connections. Provides information about the connection status and connectivity statistics.

Gets a value that indicates whether or not it is possible to delete this connection profile. This can help determine whether TryDeleteAsync is likely to succeed.

`true` if it is possible to delete this connection profile, otherwise `false`.

Gets a value that indicates if connection profile is a WLAN (WiFi) connection. This determines whether or not WlanConnectionProfileDetails is null.

Indicates if the connection profile represents a WLAN (WiFi) connection.

Gets a value that indicates if connection profile is a WWAN (mobile) connection. This determines whether or not WwanConnectionProfileDetails is null.

Indicates if the connection profile represents a WWAN (mobile) connection.

Gets the object representing the network adapter providing connectivity for the connection.

The network adapter object.

Retrieves the security settings for the network.

The current network security settings.

Gets the name of the connection profile.

The name of the connection profile.

Gets the ID of the network operator who provisioned the connection profile.

The network operator ID.

Gets a WlanConnectionProfileDetails object that provides a method for retrieving information specific to a WLAN (WiFi) connection.

Defines a method to access information specific to a WLAN connection.

Gets a WwanConnectionProfileDetails object containing the properties and methods used to retrieve information specific to mobile broadband connections.

Defines methods and properties used to retrieve information specific to a mobile broadband connection.

Gets network usage data for each individual application. This method is only supported in a Windows Phone 8.x app.

The start time of the usage window. The end time of the usage window. The state of the connection profile for which usage data should be returned. When the method completes, it returns a list of AttributedNetworkUsage objects, which indicate the sent and received values, in bytes, and the total amount of time the app was connected during the corresponding time interval.

Gets the cost information for the connection.

The cost information for the connection.

Gets a list of ConnectivityInterval objects, which indicate the timestamp for when the network connection began, and a time-span for the duration of that connection.

The start time over which to retrieve data. Can be no more than 60 days prior to the current time. The end time over which to retrieve data. The state of the connection profile for which usage data should be returned. When the method completes, it returns a list of ConnectivityInterval objects, which indicate the start time and duration for the current or prior connections.

Gets the current status of the data plan associated with the connection.

Current data plan status information.

Gets the current domain authentication status for a network connection. Possible values are defined by DomainConnectivityLevel.

A value indicating the authentication status for a connection to a network domain.

Gets the estimated data usage for a connection during over a specific period of time.

GetLocalUsage may be altered or unavailable for releases after Windows 8.1. Instead, use GetNetworkUsageAsync. The start date/time for the usage data request. The end date/time for the usage data request. The requested local data usage information.

Gets the estimated data usage for a connection over a specific period of time and roaming state.

GetLocalUsage may be altered or unavailable for releases after Windows 8.1. Instead, use GetNetworkUsageAsync. The start date/time for the usage data request. The end date/time for the usage data request. The roaming state to scope the request to. The requested local data usage information.

Gets the network connectivity level for this connection. This value indicates what network resources, if any, are currently available.

The level of network connectivity.

Retrieves names associated with the network with which the connection is currently established.

An array of string values representing friendly names used to identify the local endpoint.

Gets a list of the estimated data traffic and connection duration over a specified period of time, for a specific network usage state.

The start time over which to retrieve data. Can be no more than 60 days prior to the current time. If the specified granularity is PerMinute, the start time can be no more than 120 minutes prior to the current time. The end time over which to retrieve data. The desired granularity of the returned usage statistics. Each elements in the list corresponds to the network usage per the specified granularity, for example, usage per hour. The state of the connection profile for which usage data should be returned. When the method completes, it returns a list of NetworkUsage objects, which indicate the sent and received values, in bytes, and the total amount of time the profile was connected during the corresponding time interval.

Returns the bytes sent and bytes received for each MCC and MNC combination (the combination is represented by a ProviderId ).

The start time over which to retrieve data. Can be no more than 60 days prior to the current time. If the specified granularity is PerMinute, the start time can be no more than 120 minutes prior to the current time. The end time over which to retrieve data. The state of the connection profile for which usage data should be returned. Returns a single object containing the bytes send and bytes received for the ProviderId.

Gets a value that indicates the current number of signal bars displayed by the Windows UI for the connection.

An integer value within a range of 0-5 that corresponds to the number of signal bars displayed by the UI.

Asynchronously attempts to delete this connection profile; the operation may or may not succeed. Examine the return value to determine the outcome of the operation.

An asynchronous operation object which, when it completes, returns a ConnectionProfileDeleteStatus indicating whether or not the connection profile was deleted.

Defines values that indicate the result of an attempt to delete a connection profile.

The deletion failed because it was denied by the system.

The deletion failed because it was denied by the user, through the user interface (UI).

The deletion succeeded.

The deletion failed due to an unknown error.

The ConnectionProfileFilter class defines a set of properties that are used to improve the relevance of FindConnectionProfilesAsync results.

Creates an instance of ConnectionProfileFilter, which contains a set of properties that are used to improve the relevance of FindConnectionProfilesAsync results.

Gets or sets whether background data usage is restricted by this connection profile filter.

True when background data usage is restricted. False if background data usage is not restricted.

Indicates if connection profiles that represent currently established connections are included in query results.

A Boolean value that determines if profiles for established connections are included.

Gets or sets whether the data limit has been exceeded under the current connection profile filter.

True when the data limit has been exceeded. False otherwise.v

Gets or sets whether roaming is active in the connection profile filter.

True when roaming, false otherwise.

Indicates if connection profiles that represent WLAN (WiFi) connections are included in query results.

A Boolean value that indicates if WLAN (WiFi) connections are included.

Indicates whether connection profiles that represent WWAN (mobile) connections are included in query results.

A Boolean value that indicates if WWAN (mobile) connections are included.

Defines a specific NetworkCostType value to query for.

The connection network cost type.

Gets or sets the purpose group GUID that a connection profile must match in order to be included in query results.

The purpose group GUID that a connection profile must match.

Gets available data as raw data.

Gets available raw data.

Indicates a specific network operator ID to query for.

The network operator ID.

The ConnectionSession class is used to represent a connection to an access point established with AcquireConnectionAsync.

Retrieves the ConnectionProfile associated with the connection session.

The connection profile used to define the properties of the access point connection.

Closes the connection to the access point.

Provides the start time and duration for an established or prior connection.

Indicates the duration of connectivity.

The period of time that represents the duration of connectivity.

Indicates when the connection was initially established.

The time at which the connection was established.

Methods defined by the ConnectivityManager class enable enforcement of traffic routing on a specific network adapter for the specified destination suffix. Once a policy is set using AddHttpRoutePolicy, traffic that matches the policy will either be routed or dropped.

Establishes a connection to a specific access point on a network. The request is defined using a CellularApnContext object.

Provides specific details about the APN. The established APN connection.

Specifies a RoutePolicy that the Http stack (WinInet) will follow when routing traffic. Routing policies are only available for cellular profiles

Indicates the policy for traffic routing.

Removes a previously specified RoutePolicy from the Http stack (WinInet).

The RoutePolicy to remove.

Represents the current status information for the data plan associated with a connection.

Gets a value indicating the maximum data transfer allowance for a connection within each billing cycle, as defined by the data plan.

The maximum number of megabytes allowed as defined by the network carrier.

Gets a DataPlanUsage object that indicates the amount of data transferred over the connection, in megabytes, and the last time this value was refreshed.

The data usage and the last updated time.

Gets a value indicating the nominal rate of the inbound data transfer occurring on the connection.

The rate of inbound data transfer.

Gets a value indicates the maximum size of a transfer that is allowed without user consent on a metered network.

The maximum size of a transfer that is allowed without user consent on a metered network.

Gets a value indicating the date and time of the next billing cycle.

The date and time of the next billing cycle.

Gets a value indicating the nominal rate of the outbound data transfer.

The outbound data transfer rate.

Represents data plan specific data usage information for a connection.

Gets a DateTime object indicating the date and time when the MegabytesUsed property was last updated.

The date and time when the **MegabytesUsed** property was last updated.

Gets a value indicating the total amount of data transferred, in megabytes, over the connection.

The number of megabytes of data transferred.

Represents data usage information returned by the ConnectionProfile.GetLocalUsage method.

DataUsage may be altered or unavailable for releases after Windows 8.1. Instead, use NetworkUsage.

Gets a value indicating the number of bytes received by a connection over a specific period of time.

The number of bytes received.

Gets a value indicating the number of bytes sent by the connection over a specific period of time.

The number of bytes sent.

Defines levels of granularity used when retrieving data usage statistics with GetNetworkUsageAsync.

Provide data usage per day.

Provide data usage per hour.

Provide data usage per minute.

Provide data usage overall.

Defines the domain authentication status for a network connection.

The machine or user is authenticated on the domain connection.

No domain controller detected on this network.

A domain controller has been detected, but the current user or local machine have not been authenticated on the domain.

Represents the association between an IP address and an adapter on the network.

Retrieves the network adapter associated with the IP address.

The associated network adapter.

Retrieves the length of the prefix, or network part of the IP address.

The length, in bits, of the prefix or network part.

Represents physical identification data for a specific NetworkAdapter object. For a code example showing how to retrieve data represented by a LanIdentifier object, see [How to retrieve network adapter and locality information (XAML)](https://docs.microsoft.com/previous-versions/windows/apps/hh465168(v=win.10)).

Gets a LanIdentifierData object containing locality identification information for the network adapter's connection.

Location information for the network adapter providing connectivity for the connection.

Gets the adapter GUID that identifies the network adapter to associate with the locality information.

The adapter ID for the network adapter associated with the LanIdentifier information.

Gets a LanIdentifierData object containing the port ID from the Link Layer Discovery Protocol (LLDP) locality information for an Ethernet type network adapter.

The port ID information for the network adapter.

Represents the port specific data that enables LAN locality capabilities.

Gets a value indicating the type of data stored in the value field of the LanIdentifierData object according to the Link Layer Discovery Protocol (LLDP) protocol.

A numeric value that maps to a value-type defined by the LLDP protocol used to define the locality information.

Gets the serialized value.

A byte array that contains the serialized value of the data.

Represents a network adapter.

Gets a value indicating the network interface type as defined by the Internet Assigned Names Authority (IANA) for the NetworkAdapter.

The interface type as defined by the Internet Assigned Names Authority (IANA).

Gets a value indicating the maximum inbound data transfer rate in bits per second.

The maximum inbound transfer rate in bits per second.

Gets the network adapter ID.

The network adapter ID.

Gets the NetworkItem object that represents the connected network.

The connected network.

Gets a value indicating the maximum outbound speed in bits per second.

The maximum outbound transfer rate in bits per second.

Gets the connection profile currently associated with the network adapter.

The connection profile associated with this network adapter.

Defines values that indicate the type of authentication used by the network.

Specifies an authentication type defined by an independent hardware vendor (IHV).

No authentication enabled.

Open authentication over 802.11 wireless. Devices are authenticated and can connect to an access point, but communication with the network requires a matching Wired Equivalent Privacy (WEP) key.

Specifies an opportunistic wireless encryption (OWE) algorithm. OWE provides opportunistic encryption over 802.11 wireless, where cipher keys are dynamically derived through a Diffie-Hellman key exchange; enabling data protection without authentication.

Specifies an IEEE 802.11i Robust Security Network Association (RSNA) algorithm. IEEE 802.1X port authorization is performed by the supplicant, authenticator, and authentication server. Cipher keys are dynamically derived through the authentication process.

Specifies an IEEE 802.11i RSNA algorithm that uses PSK. IEEE 802.1X port authorization is performed by the supplicant and authenticator. Cipher keys are dynamically derived through a pre-shared key that is used on both the supplicant and authenticator.

Specifies an IEEE 802.11 Shared Key authentication algorithm that requires the use of a pre-shared Wired Equivalent Privacy (WEP) key for the 802.11 authentication.

Authentication method unknown.

Specifies a Wi-Fi Protected Access (WPA) algorithm. IEEE 802.1X port authorization is performed by the supplicant, authenticator, and authentication server. Cipher keys are dynamically derived through the authentication process.

Specifies a Wi-Fi Protected Access 3 (WPA3) algorithm. WPA3 is an encryption security standard for enterprise users. It offers the equivalent of 192-bit cryptographic strength, providing additional protections for networks transmitting sensitive data.

Specifies a Wi-Fi Protected Access 3 Simultaneous Authentication of Equals (WPA3 SAE) algorithm. WPA3 SAE is the consumer version of WPA3. Simultaneous Authentication of Equals (SAE) is a secure key establishment protocol between devices; it provides synchronous authentication, and stronger protections for users against password-guessing attempts by third parties.

Wi-Fi Protected Access.

Specifies a Wi-Fi Protected Access (WPA) algorithm that uses pre-shared keys (PSK). IEEE 802.1X port authorization is performed by the supplicant and authenticator. Cipher keys are dynamically derived through a pre-shared key that is used on both the supplicant and authenticator.

Defines the level of connectivity currently available.

Limited internet access.

Local and Internet access.

Local network access only.

No connectivity.

Defines the network cost types.

The use of this connection is unrestricted up to a specific limit.

Cost information is not available.

The connection is unlimited and has unrestricted usage charges and capacity constraints.

The connection is costed on a per-byte basis.

Defines values that indicate the type of encryption used for authentication.

Specifies an AES-CCMP algorithm, as specified in the IEEE 802.11i-2004 standard and RFC 3610. Advanced Encryption Standard (AES) is the encryption algorithm defined in FIPS PUB 197.

Specifies an encryption type defined by an independent hardware vendor (IHV).

No encryption enabled.

Specifies a Robust Security Network (RSN) Use Group Key cipher suite. For more information about the Use Group Key cipher suite, refer to Clause 7.3.2.25.1 of the IEEE 802.11i-2004 standard.

Specifies a Temporal Key Integrity Protocol (TKIP) algorithm, which is the RC4-based cipher suite that is based on the algorithms that are defined in the WPA specification and IEEE 802.11i-2004 standard. This cipher also uses the Michael Message Integrity Code (MIC) algorithm for forgery protection.

Encryption method unknown.

Specifies a WEP cipher algorithm with a cipher key of any length.

Specifies a WEP cipher algorithm with a 104-bit cipher key.

Specifies a Wired Equivalent Privacy (WEP) algorithm, which is the RC4-based algorithm that is specified in the IEEE 802.11-1999 standard. This enumerator specifies the WEP cipher algorithm with a 40-bit cipher key.

Specifies a Wifi Protected Access (WPA) Use Group Key cipher suite. For more information about the Use Group Key cipher suite, refer to Clause 7.3.2.25.1 of the IEEE 802.11i-2004 standard.

Provides access to network connection information for the local machine.

Occurs when the network status changes for a connection.

Returns an array of ConnectionProfile objects that match the filtering criteria defined by ConnectionProfileFilter.

Provides the filtering criteria. An array of ConnectionProfile objects.

Gets a list of profiles for connections, active or otherwise, on the local machine.

An array of ConnectionProfile objects.

Gets a list of host names associated with the local machine.

An array of host names for the local machine.

Gets the connection profile associated with the internet connection currently used by the local machine.

The profile for the connection currently used to connect the machine to the Internet, or **null** if there is no connection profile with a suitable connection.

Gets an array of LanIdentifier objects that contain locality information for each NetworkAdapter object that currently connected to a network.

An array of **LanIdentifier** objects.

Gets proxy configuration for a connection using the specified URI.

The proxy configuration URI. Information about the connection proxy.

Gets a sorted list of EndpointPair objects.

A list of EndpointPair objects to be sorted. Indicates sorting options for the returned array. A sorted array of EndpointPair objects.

Represents a connected network.

Gets the network ID.

The network ID.

Gets a NetworkTypes value indicating the network type for a NetworkItem.

The type of a network.

Represents the current network security settings.

Retrieves the type of authentication used by the network.

The network authentication type.

Retrieves the type of encryption used by the network.

The network encryption type.

Indicates which properties of a network have changed after a network state change background trigger.

Indicates if a connected network has a new connection cost.

true if there is a new connection cost; otherwise, false.

Indicates a connected network has a new domain connectivity level.

true if the connectivity level changed; otherwise, false.

Indicates if the list of host names returned by GetHostNames has changed.

true if a new Host Name list was provided; otherwise, false.

Indicates if the local machine has a new connection profile associated with the current internet connection.

true if the connection has changed; otherwise, false.

Indicates if the network connectivity level for any connection profiles has changed.

true if the network connectivity level changed; otherwise, false.

Gets a value indicating whether the network state change event shows a new tethering client count.

When true, the tethering client count has changed.

Gets a value that indicates whether the tethering operational state has changed.

When true, tethering operational state has changed.

Indicates if the network state change event represents a change to the registration state of a WWAN connection. The current registration state can be retrieved from WwanConnectionProfileDetails.GetNetworkRegistrationState.

true if the registration state has changed; otherwise, false.

Represents the method that handles network status change notifications. This method is called when any properties exposed by the NetworkInformation object changes while the app is active.

A Object that raised the event.

Defines the network connection types.

Internet.

No network.

Private network.

Represents network usage statistics returned by the ConnectionProfile.GetNetworkUsageAsync method.

Indicates the number of bytes received by the connection of a specific period of time.

The number of bytes received.

Indicates the number of bytes sent by a connection over a specific period of time.

The number of bytes sent.

Indicates the duration of connectivity.

The period of time that represents the duration of connectivity.

Defines the desired state of the connection profile for which usage data is returned by the method GetNetworkUsageAsync.

Defines the desired roaming state of the network connection.

Defines the desired sharing state of the network connection.

Represents provider network usage statistics returned by the ConnectionProfile.GetProviderNetworkUsageAsync method.

Gets a value indicating the number of bytes received by a connection over a specific period of time.

The number of bytes received.

Gets a value indicating the number of bytes sent by the connection over a specific period of time.

The number of bytes sent.

Gets the ProviderId (a combination of MCC and MNC).

The ProviderId (a combination of MCC and MNC).

Represents the proxy configuration for the current user.

Gets a value that indicates if this configuration can connect directly.

TRUE if this configuration can connect directly; otherwise, FALSE.

Gets a list of URIs for the proxies from the proxy configuration.

A list of URIs for the proxy configuration.

Defines the roaming states.

No roaming information.

The connection is not currently roaming.

The connection is currently roaming.

The RoutePolicy class is used to represent the traffic routing policy for a special PDP Context/APN.

Creates an instance of RoutePolicy using the defined connection profile and host name values.

The connection profile The host name for the route policy to the special PDP context. The domain type of *hostName* when the HostNameType value indicates a domain name.

Retrieves the connection profile for an access point connection.

The associated connection profile.

Provides the host name for the route policy to the special PDP context.

The host name.

Indicates if the HostName is a suffix or a fully qualified domain name reference. Possible values are defined by DomainNameType.

The domain type of the HostName object.

Used with the NetworkUsageStates structure to define the desired roaming state and shared state of a network connection.

Used when the corresponding state should not be used as a filter, for example, both yes and no.

The corresponding state is not set.

The corresponding state is set.

Used to access information specific to a WLAN connection.

Retrieves the Service Set Identifier (SSID) for a WLAN connection.

The service set identifier (SSID).

Describes the cellular data services supported by a mobile broadband network device.

The device supports the 1xEV-DO data service implemented by CDMA providers.

The device supports the 1xEV-DO RevA data service implemented by CDMA providers.

The device supports the 1xEV-DO RevB data service, which is identified for future use.

The device supports the 1xEV-DV data service implemented by CDMA providers.

The device supports the 1xRTT data service implemented by CDMA providers.

The device supports the 3xRTT data service implemented by CDMA providers.

The device supports the UMB data service implemented by CDMA providers.

The device supports a custom data service.

The device supports the EDGE data service implemented by GSM providers.

The device supports the GPRS data service implemented by GSM providers.

The device supports the HSDPA data service implemented by GSM providers.

The device supports the HSUPA (High Speed Uplink Packet Access) data service.

The device supports the HSDPA Lite data service implemented by GSM providers.

No data services supported.

The device supports the UMTS data service implemented by GSM providers.

A class that represents an embedded SIM (eSIM, or eUICC). An eSIM stores one or more identities (eSIM profiles) belonging to one or more mobile network operators (MNOs). An eSIM is not a form factor; it's a way to manage SIM profiles.

Gets the available memory on the SIM card in whole bytes.

The available memory on the SIM card in whole bytes.

Gets the eSIM ID (EID).

The eSIM ID (EID).

Gets the eSIM firmware version.

The eSIM firmware version.

Gets the device identifier, or DeviceInformation Id, of the network MobileBroadbandModem device that carries the eSIM.

The device id of the device that carries the eSIM.

Gets the policy for the eSIM, regarding whether the eSIM should be shown on the Local User Interface (LUI) for eSIM management.

The policy for the eSIM, regarding whether the eSIM should be shown on the LUI for eSIM management.

Gets the state of the eSIM, which indicates the presence and working status of the eSIM.

The state (presence and working status) of the eSIM.

Occurs when the collection of eSIM profiles changes, or when a property of one of the profiles in the collection changes.

Asynchronously deletes the specified eSIM profile.

The identification number (an ICCID) of the eSIM profile to delete. An asynchronous delete operation. On successful completion, contains an ESimOperationResult object representing the result of the delete operation.

Performs an eSIM profile discovery operation using the default SMDS address.

An ESimDiscoverResult object representing the result of the operation.

Performs an eSIM profile discovery operation for the supplied RSP server address and matching ID.

A string containing an RSP server address. If `serverAddress` is empty, the API uses the default SMDS address. A string containing the matching ID. An ESimDiscoverResult object representing the result of the operation.

Asynchronously performs an eSIM profile discovery operation using the default SMDS address.

An ESimDiscoverResult object representing the result of the operation.

Asynchronously performs an eSIM profile discovery operation for the supplied RSP server address and matching ID.

A string containing an RSP server address. If `serverAddress` is empty, the API uses the default SMDS address. A string containing the matching ID. An ESimDiscoverResult object representing the result of the operation.

Asynchronously downloads installation metadata for the eSIM profile that corresponds to the specified activation code.

The activation code for the eSIM profile installation metadata to download. An asynchronous download operation. On successful completion, contains an ESimDownloadProfileMetadataResult object representing the result of the download operation.

Gets the set of profiles stored on the eSIM.

Zero, one, or more profiles stored on the eSIM.

Asynchronously resets the eSIM.

An asynchronous reset operation. On successful completion, contains an ESimOperationResult object representing the result of the reset operation.

Provides data for the ESimWatcher.Added event.

Gets the ESim instance that was added to the device.

The ESim instance that was added to the device.

Defines constants that specify under what conditions the user should be challenged for eSIM authentication credentials.

Indicates that credentials should never be requested.

Indicates that credentials should be requested when the eSIM is involved in an action.

Indicates that credentials should be requested when the eSIM is entered.

A class representing an eSIM profile discovery event.

Gets the matching ID of the event.

A string containing the matching ID of the event.

Gets the RSP server address of the event.

A string containing the RSP server address of the event.

A class representing the result of an eSIM profile discovery operation.

Gets a collection of the discovery events related to the eSIM profile discovery operation.

A collection of ESimDiscoverEvent objects representing the discovery events.

Gets the kind of the result object from the eSIM profile discovery operation. Also see Result.

An ESimDiscoverResultKind object representing the kind of the result object.

Gets the returned profile metadata, if applicable, depending on Kind.

An ESimProfileMetadata object representing the returned profile metadata, if applicable.

Gets the result object from the eSIM profile discovery operation. This is a general operation result indicating success or failure. Also see Kind.

An ESimOperationResult object representing the result object.

Defines constants that specify the kind of the result object from an eSIM profile discovery operation.

Indicates that the result object contains events.

Indicates that the result object contains neither events nor a profile.

Indicates that the result object contains a profile.

A class that represents the outcome of an operation to download eSIM profile installation metadata (the result of the operation, and any installation metadata that was downloaded).

Gets an object representing any eSIM profile installation metadata that was downloaded.

An object representing the eSIM profile installation metadata that was downloaded, or `null` if the download operation did not succeed.

Gets the result of an operation to download eSIM profile installation metadata.

The result of an operation to download eSIM profile installation metadata.

A class that you can use to construct an ESimWatcher, and to obtain service information.

Gets service information for the eSIM manager object.

Service information for the eSIM manager object.

Occurs when a property of the service information object changes.

Attempts to create a new instance of the ESimWatcher class.

A new instance of the ESimWatcher class, or `null` if the caller's user security identifier (SID) is not authorized by the Windows service that handles eSIM-related operation requests.

A class that represents the result of certain asynchronous operations on an eSIM (for example, deleting a profile from the eSIM), or on an eSIM profile (for example, enabling the profile).

Gets the status of the eSIM operation result.

The status of the eSIM operation result.

Defines constants that specify the status of an ESimOperationResult object.

Indicates that the SIM card is busy.

Indicates that a card error occurred that prevented the download/install/other operation from completing successfully.

Indicates that the SIM card has been removed.

Indicates that the wrong confirmation code was supplied during the operation, and that no more retries are permitted.

Indicates that a confirmation code is needed in order to download the eSIM profile.

Indicates that an eSIM profile on the mobile operator (MO) server is already allocated for a different eSIM EID than the one the device has.

Indicates that the wrong confirmation code was supplied during the operation.

Indicates that there is not enough storage space on the card to complete the operation.

Indicates that the matching ID from the activation code or discovered event was refused.

Indicates that no corresponding request could be found.

Indicates that an eSIM profile compatible with this device could not be found. For example, a profile was found that requires LTE support, but the device only supports 3G.

Indicates that the operation was not authorized.

Indicates that the specified eSIM profile was not found.

Indicates that the operation aborted.

Indicates that the operation is not allowed for the eSIM profile class.

Indicates a status that's not accounted for by a more specific status.

Indicates that the operation violates policy.

Indicates that the user is trying to download an eSIM profile that has already been claimed/downloaded.

Indicates that an eSIM profile could not be found.

Indicates that the eSIM profile is available, but it is not yet marked as released for download by the mobile operator (MO). You can only download a released profile, so the MO needs to mark the profile as released.

Indicates that a server failure occurred during the operation.

Indicates that the server could not be reached during the operation.

Indicates that the operation was successful.

Indicates that user consent was not granted within the timeout period of the operation.

A class that represents the policy for an eSIM, regarding whether the eSIM should be shown on the Local User Interface (LUI) for eSIM management.

Gets a value indicating whether the policy for the eSIM calls for the eSIM to be shown on the Local User Interface (LUI) for eSIM management.

`true` if the policy calls for the eSIM to be shown on the LUI, otherwise `false`.

A class that represents an eSIM profile, which is a subscriber identity associated with a mobile network operator (MNO).

Gets the class of the eSIM profile (either Operational, Test, or Provisioning).

The class of the eSIM profile.

Gets the identification number (an ICCID) of the eSIM profile.

The identification number (an ICCID) of the eSIM profile.

Gets the nickname of the eSIM profile.

The nickname of the eSIM profile.

Gets the policy for the eSIM profile, regarding whether the profile can be disabled and/or deleted, and whether the policy is enterprise-managed.

The policy for the eSIM profile.

Gets a memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile.

A memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile.

Gets the identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile.

The identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile.

Gets the name of the mobile network operator (MNO) provider for the eSIM profile.

The name of the mobile network operator (MNO) provider for the eSIM profile.

Gets the state of the eSIM profile, which indicates the presence and enabled status of the profile.

The state (presence and enabled status) of the eSIM profile.

Asynchronously disables the eSIM profile so that it's no longer in use.

An asynchronous disable operation. On successful completion, contains an ESimOperationResult object representing the result of the disable operation.

Asynchronously enables the eSIM profile so that it's in use.

An asynchronous enable operation. On successful completion, contains an ESimOperationResult object representing the result of the enable operation.

Asynchronously sets the nickname of the eSIM profile.

The nickname to set. An asynchronous nickname set operation. On successful completion, contains an ESimOperationResult object representing the result of the nickname set operation.

Defines constants that specify an eSIM profile class.

Indicates the class of an operational eSIM profile.

Indicates the class of a provisioning eSIM profile.

Indicates the class of a test eSIM profile.

Represents the result of an asynchronous (with progress) operation to download and install an eSIM profile.

The installed size of the eSIM profile in whole bytes.

The total size of the eSIM profile in whole bytes.

A class representing eSIM profile installation metadata.

Gets the identification number (an ICCID) of the eSIM profile.

The identification number (an ICCID) of the eSIM profile.

Gets a value that indicates whether the profile requires a confirmation to download.

`true` if the profile requires a confirmation to download, otherwise `false`.

Gets the policy for an eSIM profile.

The policy for an eSIM profile.

Gets a memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile.

A memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile.

Gets the identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile.

The identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile.

Gets the name of the mobile network operator (MNO) provider for the eSIM profile.

The name of the mobile network operator (MNO) provider for the eSIM profile.

Gets the state of the eSIM profile metadata.

The state of the eSIM profile metadata.

Occurs when the state of the eSIM profile metadata changes.

Asynchronously (with progress) downloads and installs an eSIM profile.

Asynchronously (with progress) downloads and installs an eSIM profile whose confirmation code is provided.

The confirmation code for the eSIM profile being downloaded and installed. An asynchronous download and install operation with progress. On successful completion, contains an ESimProfileInstallProgress object representing the result of the download and install operation.

Asynchronously denies installation of the profile. The profile is revoked at the profile server.

An asynchronous deny-installation operation. On successful completion, contains an ESimOperationResult object representing the result of the deny-installation operation.

Asynchronously postpones the installation of an eSIM profile.

Defines constants that specify the state of eSIM profile metadata.

Indicates that the eSIM profile metadata has been denied by policy.

Indicates that the eSIM profile metadata is being downloaded.

Indicates that the eSIM profile metadata has expired.

Indicates that the eSIM profile metadata is being installed.

Indicates that the eSIM profile metadata is no longer available.

Indicates that download of the eSIM profile metadata is being rejected.

Indicates that the state of the eSIM profile metadata is not known.

Indicates that the eSIM profile metadata is waiting to be installed.

A class that represents the policy for an eSIM profile.

Gets a value indicating whether the eSIM profile policy represented by this object instance allows the profile to be deleted.

`true` if the policy allows the profile to be deleted, otherwise `false`.

Gets a value indicating whether the eSIM profile policy represented by this object instance allows the profile to be disabled.

`true` if the policy allows the profile to be disabled, otherwise `false`.

Gets a value indicating whether the eSIM profile policy represented by this object instance calls for the profile to be managed by the enterprise.

`true` if the policy calls for the profile to be managed by the enterprise, otherwise `false`.

Defines constants that specify the state of an eSIM profile, including its presence and enabled status.

Indicates that the eSIM profile has been deleted.

Indicates that the eSIM profile is disabled.

Indicates that the eSIM profile is enabled.

Indicates that the state of the eSIM profile is not known.

Provides data for the ESimWatcher.Removed event.

Gets the ESim instance that was removed from the device.

The ESim instance that was removed from the device.

A class that represents service information for an eSIM.

Gets a value indicating the condition under which the user should be challenged for eSIM authentication credentials.

A value indicating the condition under which the user should be challenged for eSIM authentication credentials.

Gets a value indicating whether the policy for the eSIM calls for the eSIM to be shown on the Local User Interface (LUI) for eSIM management.

`true` if the policy calls for the eSIM to be shown on the LUI, otherwise `false`.

Defines constants that specify the state of an eSIM, including its presence and working status.

Indicates that the eSIM is busy.

Indicates that the eSIM is idle.

Indicates that the eSIM has been removed.

Indicates that the state of the eSIM is not known.

Provides data for the ESimWatcher.Updated event.

Gets the ESim instance that was updated.

The ESim instance that was updated.

A class used to enumerate the eSIMs carried by a device and to watch for eSIMs being added to the device, removed from it, or updated.

Gets the status of the eSIM watcher.

The status of the eSIM watcher.

Occurs when an ESim is added to the device.

Occurs when the watcher has finished enumerating the collection of ESim objects carried by the device.

Occurs when an ESim is removed from the device.

Occurs when the eSIM watcher is stopped.

Occurs when an ESim on the device is updated.

Starts the eSIM watcher watching for eSIMs being added to the device, removed from it, or updated.

Stops the eSIM watcher watching for eSIMs being added to the device, removed from it, or updated.

Defines constants that specify the status of an ESimWatcher.

Indicates that the watcher has been created.

Indicates that the watcher has finished enumerating eSIMS.

Indicates that the watcher has been started.

Indicates that the watcher has been stopped.

Indicates that the watcher is stopping.

Provides the authentication context that contains details of the current authentication attempt and provides methods to perform the authentication.

Gets the HTTPS URL specified in the Wireless Internet Service Provider roaming (WISPr) redirect message.

A URI that contains the HTTPS authentication URL.

Gets the network interface that is connected to the WLAN access point of the hotspot.

An object that uniquely identifies the network.

Gets the URL of the web page where the Wireless Internet Service Provider roaming (WISPr) redirect message was found.

A URI that contains the HTTPS or HTTP redirect URL.

Gets the XML blob of the Wireless Internet Service Provider roaming (WISPr) redirect message of the hotspot.

The WISPr XML blob from the hotspot redirect message.

Gets the SSID of the WLAN access point of the hotspot.

A byte array that contains the SSID.

Aborts the current authentication attempt and disconnects the WLAN interface from the hotspot.

If **true**, Windows disables the auto-connect property for the corresponding WLAN profile and avoids future auto-connects to this hotspot. Otherwise, **false**.

Provides credentials to Windows for hotspot authentication

The *UserName* parameter of the Wireless Internet Service Provider roaming (WISPr) authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped. The *Password* parameter of the WISPr authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped. Additional parameters to be appended to the authentication string. IssueCredentials appends this parameter after an "&" character to the HTTP POST string as is without any encoding. This can be used to add multiple parameters. The default for this parameter is an empty string. If **true**, an application permanently disables the auto-connect property on a connection. If authentication fails, the connection will be disconnected and not retried in the current user session. Otherwise, **false**.

Asynchronously provides credentials to Windows for hotspot authentication Windows does not cache these credentials and another authentication event will be raised when the system connects to the same hotspot again.

The *UserName* parameter of the Wireless Internet Service Provider roaming (WISPr) authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped. The *Password* parameter of the WISPr authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped. Additional parameters to be appended to the authentication string. IssueCredentials appends this parameter after an "&" character to the HTTP POST string as is without any encoding. This can be used to add multiple parameters. The default for this parameter is an empty string. If **true**, an application permanently disables the auto-connect property on a connection. If authentication fails, the connection will be disconnected and not retried in the current user session. Otherwise, **false**. Results of the Hotspot authentication request.

Skips Wireless Internet Service Provider roaming (WISPr) Windows authentication.

Called by a background task handler to launch the foreground application when there is an authentication attempt to complete.

The foreground application ID within its application package. The application must belong to the same package as the background task handler. Optional command line parameters that are passed to the application at launch.

Gets the context of an authentication attempt.

The event token retrieved from the network operator hotspot authentication event. The token is a GUID in string format. The network operator hotspot authentication context. If **true**, the authentication context was retrieved. The authentication context can only be retrieved if the calling application matches the application ID specified in the hotspot profile of the underlying WLAN connection and if the authentication hasn’t be completed by the corresponding context already or timed out.

Provides the content of the event that is raised for background task handlers for the hotspot authentication event.

Gets a GUID that uniquely identifies the authentication attempt for which this event was raised.

A GUID that uniquely identifies the connection attempt.

Defines values used to indicate status of connection authentication with a mobile hotspot. Provides the response code from the WISPr server for an authentication attempt.

An internal error occurred in the access gateway.

The authentication request was aborted.

Hotspot authentication failed.

Hotspot authentication successful.

An error occurred that requires contacting the network administrator.

No response returned.

No response from authentication server.

Represents the results of a Hotspot authentication request.

Provides the XML blob containing the WISPr authentication reply message from the server.

Authentication reply message.

Indicates if a network error has occurred that prevented the authentication attempt. If true, the other properties should not be examined.

true if an error occurred; otherwise, false.

Provides the most recent Logoff URL as returned from the server in the authentication reply or from an earlier redirect message. If no Logoff URL was provided by the server, this property returns an empty URI.

The most recent Logoff URL.

Provides the WISPr Response Code for the authentication attempt as returned from the server. Possible values are defined by HotspotAuthenticationResponseCode.

The authentication result.

Static class that provides well known CSIM file paths.

Static property that gets the EFSPN path.

The EFSPN path.

Static property that gets the GID1 path.

GID1 path.

Static property that gets the GID2 path.

The GID2 path.

Static class that provides known RUIM file paths.

Static property that gets the EFSPN path.

The EFSPN path.

Static property that gets the GID1 path.

GID1 path.

Static property that gets the GID2 path.

The GID2 path.

Static class that provides known SIM file paths.

Static property that gets the EFONS path.

The EFONS path.

Static property that gets the EFSPN path.

The EFSPN path.

Static property that gets the GID1 path.

GID1 path.

Static property that gets the GID2 path.

The GID2 path.

Static class that provides known USIM file paths.

Static property that gets the EFOPL path.

The EFOPL path.

Static property that gets the EFPNN path.

The EFPNN path.

Static property that gets the EFSPN path.

The EFSPN path.

Static property that gets the GID1 path.

GID1 path.

Static property that gets the GID2 path.

The GID2 path.

Represents a mobile broadband account and related information about the network provider for the account.

Returns the Account Experience URL associated with the Mobile Broadband account.

The URL of the operator’s website used to configure Mobile Broadband.

A list of all network account IDs for the network service provider.

A list of all network account IDs for the network service provider.

Gets the mobile broadband device information associated with this account.

The mobile broadband device information associated with this account.

Gets the Mobile Broadband network object for this account.

The Mobile Broadband network object for this account.

Gets a unique identifier for the mobile broadband account.

A unique identifier for the mobile broadband account.

A unique identifier for the network provider for the mobile broadband account.

A unique identifier for the network provider for the mobile broadband account.

The name of the network provider for the mobile broadband account.

The name of the network provider for the mobile broadband account.

Creates a mobile broadband account for the mobile device associated with the supplied network account ID.

The network account ID to use to select the corresponding mobile broadband device to use for the account. A mobile broadband account for the mobile device associated with the supplied network account ID.

Retrieves an array of ConnectionProfile objects that represent connections associated with the Mobile Broadband account.

An array of ConnectionProfile objects.

Provides information for the AccountAdded and AccountRemoved events.

Gets the network account Id that was added or removed.

The network account Id that was added or removed.

Provides information for the AccountUpdated event.

Gets a value indicating whether the device information has changed for the account.

A value indicating whether the device information has changed for the account.

Gets a value that indicates if the CurrentNetwork was updated for the account.

A value that indicates if the CurrentNetwork was updated for the account.

Gets the network account Id of the updated account.

The network account Id of the updated account.

Provides information regarding availability of and updates to Mobile Broadband Accounts.

Creates a new instance of a MobileBroadbandAccountWatcher.

Gets the status of the account watcher.

The status of the account watcher.

Occurs when a Mobile Broadband Account is added to the client.

Occurs when a Mobile Broadband Account is removed from the client.

Occurs when a Mobile Broadband Account is updated on the client.

Occurs when the account watcher has finished enumerating accounts for the client.

Occurs when the MobileBroadbandAccountWatcher has stopped.

Starts the account watcher.

Stops the account watcher.

Describes different states of a MobileBroadbandAccountWatcherStatus object.

The watcher has aborted its watching operation due to an unexpected error condition. No events will be delivered while the watcher is in this state.

The watcher has been created but not started and is in its initial state.

The watcher is running and has finished enumerating the existing accounts.

The watcher has been started and has yet to enumerate the existing accounts.

The watcher has been stopped. No events will be delivered while the watcher is in this state.

Represents the antenna on a broadband modem.

Creates a new instance of a MobileBroadbandAntennaSar.

The identifier number of the antenna, in the form of a unique, zero-based index. The OEM/IHV-variant value for SAR backoff, in the form of an index entry in the device OEM/IHV's mapping table.

Gets the identifier number of the antenna, in the form of a unique, zero-based index.

The identifier number of the antenna, as a zero-based index.

Gets the OEM/IHV-variant value for SAR backoff, in the form of an index entry in the device OEM/IHV's mapping table.

The index entry for the SAR backoff value.

Represents CDMA network provider/cell information including identifications as well as its respective signal strength.

Gets the base station ID.

The base station ID.

Gets the time elapsed since the location information from base station reached mobile station.

The time elapsed since the location information from base station reached mobile station.

Gets the base station latitude.

The base station latitude.

Gets the base station longitude.

The base station longitude.

Gets the base station PN Number.

The base station PN Number.

Gets the network ID in CDMA only.

The network ID in CDMA

Gets the pilot signal strength in dB.

The pilot signal strength in dB.

Gets the system ID in CDMA only.

The system ID in CDMA

Represents GSM network provider/cell information including identifications as well as its respective signal strength.

Gets the base station ID.

The base station ID.

Gets the cell ID.

The cell ID.

Gets the Absolute Radio Frequency Channel Number for serving cell.

The Absolute Radio Frequency Channel Number for serving cell.

Gets the Location Area Code (LAC).

The Location Area Code (LAC).

Gets a concatenated string of MCC and MNC

The provider ID.

Gets the received signal strength in dB.

The received signal strength, in dB.

Gets the Timing Advance in bit periods, where a bit period is 48/13us.

The Timing Advance in bit periods.

Represents LTE network provider/cell information including identifications as well as its respective signal strength.

Gets the cell ID.

The cell ID.

Gets the UNTRA Absolute Radio Frequency Channel Number for serving cell.

The UNTRA Absolute Radio Frequency Channel Number for serving cell.

Gets the pysical cell ID.

The cell ID.

Gets a concatenated string of MCC and MNC.

The provider ID.

Gets the average Reference Signal Received Power in dBm.

The average Reference Signal Received Power in dBm.

Gets the average Reference Signal Received Quality in dBm.

The average Reference Signal Received Quality in dBm.

Gets the Timing Advance in bit periods, where a bit period is 48/13us.

The Timing Advance in bit periods.

Gets the Tracking Area Code.

The Tracking Area Code.

Retrieves the serving and neighboring network cell information including respective signal strength and cell tower identification information.

Gets a read-only array of neighboring [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md containing all CDMA providers.

A read-only array of neighboring [**MobileBroadbandCellCdma**](mobilebroadbandcellcdma.md containing all CDMA providers.

Gets a read-only array of neighboring MobileBroadbandCellGsm containing all GSM providers.

A read-only array of neighboring MobileBroadbandCellGsm containing all GSM providers.

Gets a read-only array of neighboring MobileBroadbandCellLte containing all LTE providers.

A read-only array of neighboring MobileBroadbandCellLte containing all LTE providers.

Gets a read-only array of neighboring MobileBroadbandCellTdscdma containing all TDSCMA providers.

A read-only array of neighboring MobileBroadbandCellTdscdma containing all TDSCMA providers.

Gets a read-only array of neighboring MobileBroadbandCellUmts containing all UMTS providers.

A read-only array of neighboring MobileBroadbandCellUmts containing all UMTS providers.

Gets a read-only array of serving MobileBroadbandCellCdma containing all CDMA providers.

A read-only array of serving MobileBroadbandCellCdma containing all CDMA providers.

Gets a read-only array of neighboring MobileBroadbandCellGsm containing all GSM providers.

A read-only array of neighboring MobileBroadbandCellGsm containing all GSM providers.

Gets a read-only array of neighboring MobileBroadbandCellLte containing all LTE providers.

A read-only array of neighboring MobileBroadbandCellLte containing all LTE providers.

Gets a read-only array of serving MobileBroadbandCellTdscdma containing all TDSCMA providers.

A read-only array of serving MobileBroadbandCellTdscdma containing all TDSCMA providers.

Gets a read-only array of serving MobileBroadbandCellUmts containing all UMTS providers.

A read-only array of serving MobileBroadbandCellUmts containing all UMTS providers.

Represents TDSCDMA network provider/cell information including identifications as well as its respective signal strength.

Gets the cell ID.

The cell ID.

Gets the cell parameter ID.

The cell parameter ID.

Gets the channel number for serving cell.

The channel number for serving cell.

Gets the Location Area Code (LAC).

The Location Area Code (LAC).

Gets the path loss in dB.

The path loss in dB.

Gets a concatenated string of MCC and MNC.

The provider ID.

Gets the received signal code power in dBm.

The received signal code power in dBm.

Gets the Timing Advance in bit periods, where a bit period is 48/13us.

The Timing Advance in bit periods.

Represents UMTS network provider/cell information including identifications as well as its respective signal strength.

Gets the cell ID.

The cell ID.

Gets the UTRAN Absolute Radio Frequency Channel Number for serving cell.

The UTRAN Absolute Radio Frequency Channel Number for serving cell.

Gets the Location Area Code (LAC).

The Location Area Code (LAC).

Gets the path loss in dB.

The path loss in dB.

Gets the primary scrambling code of serving cell.

The primary scrambling code of serving cell.

Gets a concatenated string of MCC and MNC.

The provider ID.

Gets the received signal code power in dBm.

The received signal code power in dBm.

Gets the signal to noise ratio in dB.

The received signal code power in dBm.

Represents the current state of the mobile broadband network device for the account.

Gets the cellular technology used by the mobile broadband network device.

The cellular technology used by the mobile broadband network device.

Gets a value indicating the radio state of the device.

A value indicating the radio state of the device.

Gets the name of the data class when the DataClasses property returns **Custom**.

The name of the data class when the DataClasses property returns **Custom**.

Gets the cellular data services supported by the mobile broadband network device.

The cellular data services supported by the mobile broadband network device.

Gets the DeviceInformation Id of the mobile broadband device.

The DeviceInformation Id of the mobile broadband device.

Gets a value indicating the type of Mobile Broadband device.

A value indicating the type of Mobile Broadband device.

Gets the device-specific firmware information for the mobile broadband network device.

The device-specific firmware information for the mobile broadband network device.

Gets the name of the manufacturer of the mobile broadband network device.

The name of the manufacturer of the mobile broadband network device.

Gets the value that uniquely identifies the mobile broadband device to the network provider.

The value that uniquely identifies the mobile broadband device to the network provider.

Gets the name of the model of the mobile broadband network device.

The name of the model of the mobile broadband network device.

Gets the readiness status of the mobile broadband network device.

The readiness status of the mobile broadband network device.

Gets a MobileBroadbandPinManager object for the mobile broadband device.

A MobileBroadbandPinManager object for the mobile broadband device.

Gets the revision of the mobile broadband device.

The revision of the mobile broadband device.

Gets the serial number of the mobile broadband device.

The serial number of the mobile broadband device.

Gets the Group Identifier Level 1 (GID1) of the mobile broadband network device.

THe string value of the GID1 obtained from the SIM card.

Gets the SIM integrated circuit card identifier (ICCID) for the mobile broadband network device.

The SIM integrated circuit card identifier (ICCID) for the mobile broadband network device.

Gets the Public Land Mobile Network (PLMN) name for the mobile broadband device.

The string value of the PLMN obtained from the SIM card.

Gets the Service Provider Name (SPN) for the mobile broadband device.

The string value of the SPN obtained from the SIM card.

Gets the subscriber identifier for the mobile broadband network device.

The subscriber identifier for the mobile broadband network device.

Gets the telephone numbers for the mobile broadband device.

The telephone numbers for the mobile broadband device.

Represents a mobile broadband device service.

Gets the unique device service identity for the mobile broadband device service.

The unique Device Service identity for the Mobile Broadband device service.

Gets a list of supported device service commands for the mobile broadband device service.

A list of supported device service commands for the mobile broadband device service.

Opens a new MobileBroadbandDeviceServiceCommandSession for the mobile broadband device service.

A new command session for the mobile broadband device service.

Opens a new MobileBroadbandDeviceServiceDataSession for the mobile broadband device service.

A new data session for the Mobile Broadband device service.

Represents the result of a mobile broadband device service command.

Gets the response data from the command execution on a mobile broadband device service.

The response data from the command execution on a mobile broadband device service.

Gets the status code of the command execution on a mobile broadband device service.

The status code of the command execution on a mobile broadband device service.

Represents a device service command session which allows the caller to submit predefined commands to the modem on a mobile broadband device service.

Closes the command session on a mobile broadband device service.

Starts an asynchronous operation on a mobile broadband device service to send a query command to the command session.

The command identifier for the query command to be executed. The data to be submitted as part of the command. An asynchronous operation that returns the result of the command.

Starts an asynchronous operation on a mobile broadband device service to send a set command to the command session.

The command identifier for the set command to be executed. The data to be submitted as part of the command. An asynchronous operation that returns the result of the command.

Provides data for a DataReceived event on a MobileBroadbandDeviceServiceDataSession when data is received .

Gets the data received on the MobileBroadbandDeviceServiceDataSession.

The data received on the MobileBroadbandDeviceServiceDataSession

Represents a device service data session which allows the caller to write data to the modem on a mobile broadband device service.

An event that indicates that data was received on the MobileBroadbandDeviceServiceDataSession object after the WriteDataAsync method was called.

Closes the data session on a mobile broadband device service.

Starts an asynchronous operation on a mobile broadband device service to write data to the data session.

The data to be submitted as part of the write operation. An asynchronous operation that returns the result of the write operation.

Contains information about a mobile broadband device service.

Gets the unique device service identifier for the mobile broadband device.

The unique device service identifier for the mobile broadband device.

Determines if the mobile broadband device service is able to read data.

If the mobile broadband device service is able to read data.

Determines if the mobile broadband device service is able to write data.

If the mobile broadband device service is able to write data.

Provides details for a network device service notification.

Gets the device ID of the device that triggered a broadband device service event.

The unique device identifier for the triggering event.

Gets the device service identifier for the device service trigger event.

The unique device service identifier for the triggering event.

Gets the received data associated with the triggered event.

The data associated with the triggered event. Data format is dependent upon the protocols of the specific device service.

Describes different types of Mobile Broadband devices.

The device is embedded in the system.

The device is remote. For example, a tethered cellular phone modem.

The device is removable.

The device type is unknown.

Represents a mobile broadband modem.

Gets the MobileBroadbandAccount associated currently with the mobile broadband modem.

The account associated currently with the mobile broadband modem.

Gets an object that describes the mobile broadband network that this modem us currently attached to.

Describes the current broadband network.

Gets the MobileBroadbandDeviceInformation for the mobile broadband modem.

The device information for the mobile broadband modem.

Gets a list of the device services available for the mobile broadband modem.

A list of the device services available for the mobile broadband modem.

Gets a value indicating whether the mobile broadband modem is in emergency call mode.

`true` if the mobile broadband modem is in emergency call mode, otherwise `false`.

Gets a value indicating whether the mobile broadband modem allows a reset operation.

When this value is true, the modem can be reset by calling ResetAsync. When this value is false, calling **ResetAsync** fails.

Gets the maximum device service command size, in bytes, for the mobile broadband modem.

The maximum device service command size, in bytes, for the mobile broadband modem.

Gets the maximum device service data size, in bytes, for the mobile broadband modem.

the maximum device service data size, in bytes, for the mobile broadband modem.

Occurs when the mobile broadband modem either enters or exits emergency call mode.

Determine if a mobile broadband device is a Wireless WAN device.

The mobile broadband device ID The mobile broadband modem.

Asynchronously retrieves mobile broadband modem configuration information.

An asynchronous retrieval operation. On successful completion, contains a MobileBroadbandModemConfiguration object representing the current configuration.

Determines the default mobile broadband modem.

The mobile broadband modem.

Gets a device selector for the mobile broadband modem.

A device selector for the mobile broadband modem.

Gets a specific device service for the mobile broadband modem.

The unique device service identifier for the device service to be retrieved. The mobile broadband device service retrieved.

Gets a value indicating whether passthrough mode is enabled.

An asynchronous operation that returns a boolean value on completion. The value is true if passthrough is enabled; otherwise, false.

Asynchronously performs a reset operation on the mobile broadband modem.

An asynchronous reset operation.

Asynchronously enables or disables passthrough mode.

True if passthrough should be enabled; otherwise, false. An asynchronous operation that returns a MobileBroadbandModemStatus value on completion.

Asynchronously retrieves the Protocol Configuration Options (PCO) data for the modem.

An asynchronous retrieval operation. On successful completion, contains a MobileBroadbandPco object representing Protocol Configuration Options (PCO) data.

Contains details about the mobile broadband modem configuration.

Gets the home provider ID associated with the mobile broadband modem.

The home provider ID.

Gets the home provider name for the mobile broadband modem.

The home provider name.

Gets the MobileBroadbandSarManager object that manages SAR and antenna relevant operations.

The MobileBroadbandSarManager object that manages SAR and antenna relevant operations.

Gets an object representing the Universal Integrated Circuit Card (UICC), commonly called a "SIM card", associated with the mobile broadband modem.

Represents the UICC.

A class with methods for disallowing and allowing certain types of data traffic through the mobile broadband modem; essentially isolating the user equipment (UE), or device.

Creates a new instance of a MobileBroadbandModemIsolation.

The DeviceInformation Id of the mobile broadband device. An Id used to track the configuration set by the MobileBroadbandModemIsolation instance being constructed.

Adds an allowed host. You can call this method multiple times to add multiple allowed hosts. Traffic to the added host(s) will be allowed after you call ApplyConfigurationAsync.

The allowed host, whose type must be either IPv4 or IPv6.

Adds a range of allowed hosts. You can call this method multiple times to add multiple ranges of allowed hosts. Traffic to the added host(s) will be allowed after you call ApplyConfigurationAsync.

The first allowed host in the range. Its type must be either IPv4 or IPv6. The last allowed host in the range. Its type must be the same as that of *first*.

Asynchronously isolates the modem to allow only core networking traffic (such as DHCP, DNS, and ICMP) or traffic to a set of allowed hosts as specified by AddAllowedHost or AddAllowedHostRange.

An asynchronous action.

Asynchronously allows all traffic through the modem.

An asynchronous action.

Specifies the status of a request to set the modem passthrough status by calling SetIsPassthroughEnabledAsync.

The modem is busy.

The modem does not support the request.

An unspecified failure occurred.

The call was successful.

Represents a mobile broadband network and the current network state.

The name of the currently connected access point.

The name of the currently connected access point.

Attempts to get the latest network activation error.

The latest network activation error.

Gets the unique network interface that identifies the mobile broadband network.

An object that uniquely identifies the network.

Gets the current network registration state.

The current network registration state.

Gets the latest packet attach network error.

The latest packet attach network error.

Gets the data class of the current mobile network.

The data class of the current mobile network.

Gets the provider ID for the currently registered mobile network.

The provider ID for the currently registered mobile network.

Gets the provider name for the currently registered mobile network.

The provider name for the currently registered mobile network.

Gets the latest network registration error.

The latest network registration error.

Gets a list of all UICC apps available on the SIM card that can be used for registration on a mobile network. This list includes UICC apps that are not currently used for registration, but could potentially could be used for registration.

A list of objects that represent UICC applications.

Retrieves a **MobileBroadbandCellsInfo** object that contains all serving and neighboring cell information when device is registered to a network.

An asynchronous operation that returns a **MobileBroadbandCellsInfo** object upon completion.

Asynchronously retrieves a value indicating whether this network currently supports voice calls.

An asynchronous retrieval operation. On successful completion, contains a value indicating whether the network supports voice calls (if true) or not.

Displays the connect UI for a specific mobile network.

Provides details about one network registration state change.

Gets the unique identifier of the device associated with a network registration state change.

Unique identifier of the device associated with a network registration state change notification.

Gets an object which contains details about the network associated with this network state change.

Details about the network associated with a network registration state change notification.

Provides details for a network registration state change notification.

Gets the collection of network registration state changes associated with this notification.

A list of registration state changes.

A class representing a Protocol Configuration Options information element (PCO). The purpose of a PCO is, during a packet data protocol (PDP) context activation, to transfer the external network protocol options associated with the activation.

From the modem, gets the details of the protocol configuration options (PCO) as set by you as the mobile network operator (MNO). Your MNO app should be able to understand this payload. It should decode the data, and control the modem accordingly (for example, turn off the radio, or isolate the modem).

A buffer containing the details of the protocol configuration options (PCO).

Gets the DeviceInformation Id of the mobile broadband device.

A device information identifier.

Gets a value indicating whether the data received from the modem is complete, or is a subset of the Protocol Configuration Options (PCO) data structure.

`true` if the data is complete; `false` if it's a subset of the Protocol Configuration Options (PCO) data structure.

A class providing details about a Protocol Configuration Options (PCO) data change notification.

Gets details about a Protocol Configuration Options (PCO) data change notification.

Details about the Protocol Configuration Options (PCO) data change notification.

Contains the properties and methods associated with a mobile broadband PIN.

Gets the number of attempts remaining before the mobile broadband PIN is blocked.

The number of attempts remaining before the mobile broadband PIN is blocked.

Gets a boolean value that indicates if the mobile broadband PIN is enabled.

A boolean value that indicates if the mobile broadband PIN is enabled.

Gets the format for a mobile broadband PIN.

The format for a mobile broadband PIN.

Gets the lock state for a mobile broadband PIN.

The lock state for a mobile broadband PIN.

Gets the maximum length, in bytes, of the mobile broadband PIN.

The maximum length, in bytes, of the mobile broadband PIN.

Gets the minimum length, in bytes, of the mobile broadband PIN.

The minimum length, in bytes, of the mobile broadband PIN.

Gets the PIN type for a mobile broadband PIN.

The PIN type for a mobile broadband PIN.

Starts an asynchronous operation to change an already-enabled mobile broadband PIN.

The current mobile broadband PIN. The new mobile broadband PIN. An asynchronous operation that returns the result.

Starts an asynchronous operation to disable a previously-enabled mobile broadband PIN.

The current mobile broadband PIN. An asynchronous operation that returns the result.

Starts an asynchronous operation to enable a previously-disabled mobile broadband PIN.

The current mobile broadband PIN. An asynchronous operation that returns the result.

Starts an asynchronous operation to get the current mobile broadband PIN from the user.

The current mobile broadband PIN. An asynchronous operation that returns the result.

Starts an asynchronous operation to unblock a previously-blocked mobile broadband PIN using a PIN unlock key (PUK).

The PIN unblock key. The new mobile broadband PIN. An asynchronous operation that returns the result.

Describes the possible formats for a mobile broadband PIN.

The PIN is alphanumeric.

The PIN is numeric.

No PIN format has been defined. This is normally not used.

Describes the possible PIN lock states of a mobile broadband PIN.

A PIN input is required. The MobileBroadbandPinType will contain more information on which PIN is needed.

An invalid PIN has been entered too often and a PIN Unblock Key (PUK) is needed to proceed.

The PIN lock state is unknown.

The PIN lock state is unlocked.

Contains details of a PIN lock state change notification.

Gets the device identifier associated with a PIN lock state change.

The unique device identifier associated with this PIN lock state change.

Gets a value representing the new PIN lock state after a PIN lock state change.

An enumeration value indicating the new PIN lock state.

Gets a value representing the type of PIN involved in a PIN lock state change.

An enumeration value describing the type of PIN whose state changed.

Provides details for a network registration state change notification.

Gets the collection of PIN lock state change details associated with a notification.

A list of PIN lock state change details.

Defines the PIN manager for a given mobile broadband modem and SIM Card.

Gets a list of the supported PIN types for the mobile broadband modem and SIM Card.

a list of the supported PIN types for the mobile broadband modem and SIM Card.

Gets the mobile broadband PIN of a specific PIN type.

The mobile broadband PIN type. The mobile broadband PIN returned. This value is either provided by the end user or from a cache if allowed. .

Represents the result of a mobile broadband PIN operation.

Gets the number of PIN entry attempts remaining until the mobile broadband PIN is blocked.

the number of PIN entry attempts remaining until the mobile broadband PIN is blocked.

Gets a value indicating whether the PIN operation was successful.

Successful when true.

Describes the possible types for a mobile broadband PIN.

This is a PIN that allows the device to be personalized to a specific company. For more information about this PIN type, see section 22.022 of the 3GPP specification.

This is a custom vendor-defined PIN type. It is not included in the list.

This is a PIN that locks the device to the very first inserted SIM card.

This is a PIN that allows the device to be personalized to a network. For more information about this PIN type, see section 22.022 of the 3GPP specification.

This is a PIN that allows the device to be personalized to a subset of a network. For more information about this PIN type, see section 22.022 of the 3GPP specification.

Not used (only for initialization).

For GSM-based devices, this is a Subscriber Identity Module (SIM) PIN. For CDMA-based devices, power-on device lock is reported as PIN1.

This is a SIM PIN2 that protects certain SIM functionality.

This is a PIN that allows the device to be personalized to a service provider. For more information about this PIN type, see section 22.022 of the 3GPP specification.

This is a PIN that locks the device to a specific SIM card.

This is a PIN that allows the device to be restricted to operate on a specific network. For more information about this PIN type, see section 22.022 of the 3GPP specification.

Describes radio states for a Mobile Broadband device.

The radio is off. This can be because it has been turned off using a physical switch on the device, or using a software mechanism such as **Airplane Mode** on the control panel.

The radio is on.

Contains details of a radio state change notification.

Gets the device ID of the device whose radio state changed.

Unique ID of the device whose radio state changed.

Gets the new state of the radio.

The new state of the radio after a radio state change.

Provides details for a radio state change notification.

Gets the collection of radio state change details associated with a notification.

A list of radio stat change details.

Contains the SAR configuration properties and the control method to change them on the device.

Gets the collection of current SAR configuration models for each antenna on the device.

The collection of current SAR configuration models for each antenna on the device.

Gets the time window of the hysteresis timer that is used to determine antenna's transmission state.

The time window of the hysteresis timer.

Gets a value indicating whether SAR backoff functionality is enabled on the device.

True if SAR backoff functionality is enabled; otherwise, false.

Gets a value indicating if SAR configuration is controlled by device hardware.

True if SAR configuration is controlled by device hardware; otherwise, false.

Gets a value indicating if WiFi and cellular SAR are integrated in the device.

True if WiFi and cellular SAR are integrated in the device; otherwise, false.

Occurs when there is notification received from device that indicate a change in the current transmission state.

Disables SAR backoff functionality on the device.

An asynchronous action.

Enables SAR backoff functionality on the device.

An asynchronous action.

Gets a value that indicates whether the modem is transmitting or idle.

True if the modem is transmitting; otherwise, it is idle.

Sets the device back to hardware control mode. The relevant SAR configuration values are reset to the hardware default settings.

An asynchronous action.

Sends a request to the device to change the SAR configuration.

The collection of antennas containing the SAR backoff property to configure. An asynchronous action.

Sets the hysteresis timer (1-5 seconds) used to determine if transmission activity is idle.

/** The time-window size ranging from 1 to 5 seconds. An asynchronous action.

Starts monitoring the transmission state change on the device.

Stops monitoring the transmission state change on the device.

Provides data for the TransmissionStateChanged event.

Gets a value that indicates whether the modem is transmitting.

True if the modem is transmitting; otherwise, false.

Represents a Universal Integrated Circuit Card (UICC), normally called a SIM Card on a mobile broadband device.

Gets the unique SIM Card identity on a mobile broadband device.

The unique SIM Card identity on a mobile broadband device.

Asynchronously retrieves a list of mobile broadband UICC (SIM card) applications.

An asynchronous retrieval operation. On successful completion, returns an object with the results of the retrieval operation.

Represents a UICC (SIM card) application.

Gets the ID of this UICC application.

The ID of the UICC application.

Gets what kind of UICC application this instance represents.

An enumeration value specifying what kind of UICC application this is.

Asynchronously retrieves details about a UICC application.

A sequence of characters specifying the UICC file path of the application. Use the MobileBroadbandUiccApp.Id property value of this instance, to get app record details for this application. An asynchronous retrieval operation. On successful completion, returns a MobileBroadbandUiccAppRecordDetailsResult instance initialized for the specified application's details.

Asynchronously reads a UICC application record.

A sequence of characters specifying the path to the UICC application. The record index within the UICC application's records. An asynchronous retrieval operation. On successful completion, returns a MobileBroadbandUiccAppReadRecordResult with the result of the operation.

Describes the status of an operation on a UICC application.

Operation failed due to an access condition not being met.

Operation failed due to an invalid UICC file path being specified.

Successful completion.

Operation failed because the UICC was busy.

Encapsulates the results of a UICC application record read operation.

Gets the data returned by the application record read operation. Note that if *Status* is not **Success**, this value may be invalid or empty.

The data. Format is defined by the UICC application.

Gets a value which indicates whether the record read completed successfully.

The status of the completed operation.

Contains details about results of a UICC application record read operation initiated with MobileBroadbandUiccAppClass.GetRecordDetailsAsync.

Gets an enumeration value specifying what kind of record this is.

The kind of record.

Gets a value specifying how read access to this record is determined.

The enumeration value that describes how read access is determined.

Gets the count of this record in the list of records provided by this UICC application.

This record's count.

Gets the size in bytes of this record.

Record size, in bytes.

Gets the status of the operation to retrieve UICC application record details. If this value is not **Success**, then other properties might not contain valid values.

The status value.

Gets a value specifying how write access to this record is determined.

The enumeration value that describes how write access is determined.

Reports results of a call to MobileBroadbandUicc.GetUiccAppsAsync.

Gets the status of the completed MobileBroadbandUicc.GetUiccAppsAsync operation. If this value is not **Success**, then other properties may not be valid.

The enumeration value that describes the status of the operation.

A list of UICC applications retrieved using MobileBroadbandUicc.GetUiccAppsAsync. Note that this is only valid when *Status* is **Success**.

A list of the UICC applications.

Describes the readiness of a device to connect to a wireless network.

A subscription account for the mobile broadband device is not active.

The SIM card is not valid. This can occur when PIN Unblock Key attempts have exceeded the limit.

The mobile broadband device is blocked by a PIN or password preventing the device from initializing and registering with a wireless network.

The mobile broadband device hardware is not responding.

The mobile broadband device is locked by a PIN or password preventing the device from initializing and registering with a wireless network.

The mobile broadband device is off.

The device is powered on and ready for mobile broadband operations.

The mobile broadband device does not have a SIM card.

Defines constants that specify the kind of data usage change that activated a NetworkOperatorDataUsageTrigger.

Indicates that actionable progress in data usage has occurred.

Provides details about the data usage change that activated a NetworkOperatorDataUsageTrigger.

Gets details about the kind of data usage change that activated a mobile network operator data usage trigger.

Describes the type of a network operator notification message.

The message type is CDMA.

Data plan has been deleted.

Data plan has been reset.

Data plan data threshold has been reached.

The message type is GSM.

Profile connected to mobile operator.

Profile disconnected from mobile operator.

Mobile broadband device registered as home.

Mobile broadband device registered as roaming.

Mobile broadband device can be used for tethering.

Number of clients currently using the tethering network has changed.

Operational state of the device's tethering capability has changed.

The message type is USSD.

Provides the ability to configure and create a NetworkOperatorTetheringAccessPointConfiguration object that contains a specific network account ID (SSID) and specifies the passphrase used to authenticate clients trying to establish a network connection to the tethering network.

Creates an instance of the NetworkOperatorTetheringAccessPointConfiguration.

Gets or sets the wireless frequency band of the Wi-Fi access point. Use IsBandSupported or IsBandSupportedAsync to check whether the Wi-Fi adapter allows configuring a specific frequency band.

A TetheringWiFiBand constant, specifying the frequency band.

Gets or sets the passphrase used to authenticate the connection.

The network passphrase.

Gets or sets the network account ID.

The network account ID

Checks whether the Wi-Fi access point supports the specified wireless frequency band.

A TetheringWiFiBand constant, specifying the frequency band to query about. `true` if the frequency band is supported, otherwise `false`.

Asynchronously checks whether the Wi-Fi access point supports the specified wireless frequency band.

A TetheringWiFiBand constant, specifying the frequency band to query about. An asynchronous object which, on completion, contains `true` if the frequency band is supported, otherwise `false`.

Contains details about a tethering client.

Gets a list of hostnames used by this tethering client.

List of hostnames.

Gets the MAC address of this tethering client.

MAC address.

This interface exposes the methods and properties used to control and configure tethering capabilities for a specific network account.

Gets the current number of connected clients on the tethering network.

The current number of clients.

Gets the maximum number of client connections over a tethered network.

The maximum number of client connections

Gets the current operational state of the tethering feature. Possible values are defined by TetheringOperationalState

The current operational state.

Use this method to provide tethering network configuration details for the tethering network.

Provides a network account ID (SSID) and specifies the passphrase used for authentication when establishing a tethered network connection. The asynchronous action.

Creates a NetworkOperatorTetheringManager using the given profile as the public interface and Wi-Fi as the private interface.

Connection profile to be used. The resulting manager object.

Creates a NetworkOperatorTetheringManager using the given profile as the public interface, and on the given NetworkAdapter as the private interface.

Connection profile to be used. The network adapter where the connection is shared. The shared connection will be controlled by the NetworkOperatorTetheringManager. The resulting manager object.

Creates an instance of NetworkOperatorTetheringManager for a specific network account using the provided network account ID for the mobile broadband device.

The network account ID. A NetworkOperatorTetheringManager object.

Disables the *NoConnections* timeout.

Asynchronously disables the *NoConnections* timeout.

An asynchronous object, which you can await.

Enables the *NoConnections* timeout. This means that tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away.

Asynchronously enables the *NoConnections* timeout. This means that tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away.

An asynchronous object, which you can await.

Gets the current access point configuration for a network account as defined by a NetworkOperatorTetheringAccessPointConfiguration object.

Indicates the network account id and specifies the pass-phrase used for authentication when establishing a connection over the tethering network.

Indicates if a device is capable of creating a tethering network. Possible values are defined by TetheringCapability.

The network account ID. The tethering capabilities of a network account.

Gets tethering capabilities, based on the given connection profile.

Connection profile to be checked. Tethering capabilities of the connection profile.

Retrieves a list of tethering clients for this NetworkOperatorTetheringManager.

A list of clients.

Gets a value indicating whether the *NoConnections* timeout is enabled. If enabled, tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away.

`true` if the *NoConnections* timeout is enabled, otherwise `false`.

Establishes the tethering network.

The result of the tethering network operation.

Shuts down the tethering network.

The result of the tethering network operation.

Represents the results of a StartTetheringAsync or StopTetheringAsync operation. In addition to the TetheringOperationStatus value, it can include an optional error message string that provides mobile operator specific context to the error.

An optional error message string that provides mobile operator specific context to the error.

The mobile operator defined error context.

Indicates the result of a tethering operation. Possible values are defined by TetheringOperationStatus.

The result of a tethering operation.

Describes the network registration state of a mobile broadband device.

The device was denied registration. Emergency voice calls may be made. This applies to voice and not data.

The device is not registered and is not searching for a network provider.

The device is on a home network provider.

No connectivity.

The device is on a roaming partner network provider.

The device is on a roaming network provider.

The device is not registered and is searching for a network provider.

Describes network types for provisioned network connectivity profiles.

The profile is for a wireless local area network (WLAN).

The profile is for a wireless wide area network (WWAN).

Used to update the usage of plan data.

The last time *UsageInMegabytes* was updated.

Updates the usage in megabytes.

Updates cost and usage information for a mobile broadband profile.

Called by the application to update the cost for a specific profile.

Updates the cost for the profile.

Called by the application to update the usage for a specific profile.

Updates the usage for a profile.

The results object returned to the application when the provisioning operation has completed.

Determines whether all elements specified in the provisioning XML were applied.

**True** if all elements specified in the provisioning XML could be applied; otherwise **false**.

Indicates which elements in the provisioning profile could not be successfully provisioned.

An instance of ResultsSchema that indicates which elements in the provisioning profile could not be successfully provisioned.

Represents an agent that provisions connectivity and subscription information with a network provider.

Creates a new instance of a ProvisioningAgent.

Creates a provisioning agent for the mobile device associated with the supplied network account ID.

The network account ID to use to select the corresponding mobile broadband device to use for the provisioning agent. The provisioning agent for the mobile device associated with the supplied network account ID.

Retrieves cost and plan information associated with the mobile broadband profile.

The media type that the profile belongs to. The name of the profile that the cost will be applied to. The profile.

Provisions a device for network connectivity asynchronously, based on the supplied XML document.

An instance of CarrierControlSchema that contains the network connectivity provisioning information. An asynchronous handler to start the provisioning attempt and track its completion.

Defines values that can be returned after calling NetworkOperatorTetheringManager.GetTetheringCapability to indicate the tethering capabilities of a network account.

Tethering is disabled according to the current group policy.

Tethering not available due to hardware limitations.

Tethering operations disabled for this account by the network operator.

An application required for tethering operations is not available.

Tethering is not supported by the current account services.

Tethering has been disabled by the system because the app lacks the necessary **DeviceCapability** entry in its manifest. See CreateFromConnectionProfile for more information about manifest requirements.

Tethering is disabled for unknown reasons.

Tethering is enabled.

Provides details about the tethering event that activated a TetheringEntitlementCheckTrigger.

Gets a value specifying the network account ID (SSID), which is a unique identifier for the mobile broadband account that received the notification.

A value specifying the network account ID (SSID).

Indicates that tethering is permitted for the network account ID (SSID) for the device.

Indicates that tethering is denied for the network account ID (SSID) for the device.

A string specifying the reason for the tethering failure.

Defines values used by the NetworkOperatorTetheringManager.TetheringOperationalState property to indicate the operational state of a device's tethering capabilities.

The tethering feature is currently in transition between the **On** and **Off** states.

Tethering is off.

Tethering is on.

Current operational state is unknown.

Defines the values returned with a NetworkOperatorTetheringOperationResult object to indicate the status of a tethering operation.

The operation could not begin because Bluetooth or a required Bluetooth device is turned off.

The operation did not complete because the account does not currently support tethering operations.

The operation did not complete because the mobile operator could not be contacted to confirm tethering capabilities are provided for this account.

The operation could not begin because the mobile broadband device is turned off.

The operation did not complete because of limited network connectivity.

The operation is still in progress.

The operation completed successfully.

The status of the operation is unknown.

The operation could not begin because the Wifi device is turned off.

Defines constants that specify a wireless frequency band for a WiFi adapter.

Specifies that the WiFi adapter is free to choose any band per internal logic.

Specifies that the WiFi adapter uses only the 5 GHz band.

Specifies that the WiFi adapter uses only the 2.4 GHz band.

Describes the conditions placed on operations using a UICC application.

Access requires Administrative 5.

Access requires Administrative 6.

Access is always allowed.

Access is never allowed.

Access requires PIN 1.

Access requires PIN 2.

Access requires PIN 3.

Access requires PIN 4.

Describes the kinds of UICC applications.

CDMA application.

IP multimedia services application.

Master File application.

Removable user identity card application.

A GSM application.

An unknown kind.

UMTS application.

Describes the kinds of UICC application record.

A file that consists of a sequence of records.

A transparent file - a sequence of bytes without further structure .

An unknown app record kind. For example, a UICC app that is enumerable by the modem, but is not an app used for cellular registration, would be reported as **Unknown**.

Represents a USSD message that is used for sending messages to and receiving messages from the network.

Creates a new instance of a UssdMessage and encodes the supplied string into the message payload.

The payload for the UssdMessage.

Gets or sets the encoding scheme of the payload of this UssdMessage.

The encoding scheme of the payload of this UssdMessage.

Gets or sets the payload of this UssdMessage as text.

The payload of this UssdMessage as text.

Gets the raw payload of this UssdMessage.

The raw payload of this UssdMessage.

Sets the raw payload of this UssdMessage.

The raw payload of this UssdMessage.

Represents the network response after sending a USSD message.

Gets the message for the USSD response.

The message for the USSD response.

Gets the result code for the USSD response.

The result code for the USSD response.

Describes the USSD response codes for messages sent to the network.

The USSD message that was received is either a USSD request from the network or a response to a message sent to the network. Additional information is needed. The USSD session is open.

The USSD session has been closed because there was no response from the network.

The USSD message that was received is either a USSD notification from the network or a response to an earlier request. No further information is necessary. The USSD session is closed.

The previous USSD request failed because the request was invalid or cannot be handled by the driver, device, or network.

The previous USSD request failed because another local client has an active USSD session.

The USSD session has been terminated by the network or a local client.

Represents a session of the USSD network protocol.

Closes the USSD session with the network.

Creates a USSD session for the mobile device associated with the supplied network account ID.

The network account ID to use to select the corresponding mobile broadband device to use for the USSD session. The USSD session for the mobile device associated with the supplied network account ID.

Creates a USSD session for the mobile device associated with the supplied network interface ID.

The network interface ID to use to select the corresponding mobile broadband device to use for the USSD session. The USSD session for the mobile device associated with the supplied network interface ID.

Sends a message to a USSD session and returns a handler to retrieve the reply asynchronously.

The message to send to the USSD session. An asynchronous handler to retrieve the USSD response to the sent message.

Contains properties that are passed to an application with the ConnectionRequested event.

Gets the information for a peer that's requesting a connection.

The information for a peer that's requesting a connection.

Describes the method that handles the DeviceArrived event.

The proximity device that raised the DeviceArrived event.

Describes the method that handles the DeviceDeparted event.

The proximity device that raised the DeviceDeparted event.

Describes the method that will handle the event that's fired when a message that has been subscribed to has been received.

The proximity device that received the message. The message and related data that were passed to the event handler.

Describes the method that will handle the event that's fired when a published message has been transmitted.

The proximity device that published the message. The publication ID of the message.

Indicates which discovery options are available to use with the PeerFinder class.

You can use Wifi-Direct to find peers by using the FindAllPeersAsync and ConnectAsync methods of the PeerFinder class.

No supported discovery types are available. You can't use the PeerFinder class.

You can tap to connect to peers by using the PeerFinder class.

Enables you to discover other instances of your app on nearby devices and create a socket connection between the peer apps by using a tap gesture or by browsing. For creating Bluetooth socket connections on Windows 8.1 and later, use Windows.Devices.Bluetooth.Rfcomm instead.

Specifies whether the PeerFinder class may connect a StreamSocket object by using Bluetooth.

True if the PeerFinder class may connect a StreamSocket object by using Bluetooth; otherwise false. The default is true.

Specifies whether the PeerFinder class may connect to a StreamSocket object using TCP/IP.

True if the PeerFinder class may connect to a StreamSocket object using TCP/IP; otherwise false.

Specifies whether the PeerFinder class may connect a StreamSocket object by using Wi-Fi Direct.

True if the PeerFinder class may connect a StreamSocket object by using Wi-Fi Direct; otherwise false. The default is true.

Gets a list of alternate appId values to match with peer applications on other platforms.

A list of alternate appId values to match with peer applications on other platforms.

Gets or sets user or device data to include during device discovery.

User or device data to include during device discovery. Must be less than 32 bytes.

Gets or sets the name that identifies your computer to remote peers.

The name that identifies your computer to remote peers.

Gets or sets the role of the app in peer-to-peer connections.

The role of the app in peer-to-peer connections.

Gets a value that indicates which discovery options are available to use with the PeerFinder class.

A value that indicates which discovery options are available to use with the PeerFinder class.

Occurs when a remote peer requests a connection using the ConnectAsync method.

Occurs during a tap gesture from a remote peer.

Connects to a peer discovered by a call to the FindAllPeersAsync method.

A peer information object representing the peer to connect to. An asynchronous operation for connecting to a remote peer using the supplied StreamSocket object.

Creates a new instance of a PeerWatcher object for dynamic discovery of peer apps.

An instance of a PeerWatcher object for dynamic discovery of peer apps.

Asynchronously browses for peer devices that are running the same app within wireless range.

The asynchronous operation for browsing for peer devices that are running your app.

Makes an app discoverable to remote peers.

Makes an app discoverable to remote peers.

The message to deliver to the proximate device.

Stops advertising for a peer connection.

Contains information that identifies a peer.

Gets the device data included during device discovery.

User or device data to include during device discovery. Must be less than 32 bytes.

Gets the display name of the peer.

The display name of the peer.

Gets the hostname or IP address of the peer.

The hostname or IP address of the peer

Gets the app id for the peer app.

The app id for the peer app.

Gets the service name or TCP port number of the peer.

The service name or TCP port number of the peer.

Describes the role of the peer app when connected to multiple peers.

The app is a client peer app in a multi-peer connection.

The app is the host peer app in a multi-peer connection.

The app is part of a two-peer connection.

Dynamically discovers peer apps within wireless range.

Gets the current state of the PeerWatcher object.

The current state of the PeerWatcher object.

Occurs when a peer app is found within wireless range.

Occurs after a scan operation is complete and all peer apps within wireless range have been found.

Occurs when a peer app is no longer within wireless range.

Occurs when the PeerWatcher object has been stopped.

Occurs when the DisplayName or DiscoveryData for a peer app within wireless range has changed.

Begin dynamically searching for peer apps within wireless range.

Stop dynamically searching for peer apps within wireless range.

Describes the status of a PeerWatcher object.

Watching for peers has stopped due to a failure.

The peer watcher has been created and can start watching for peer apps within wireless range.

A scan operation is complete and all peer apps within wireless range have been found.

The peer watcher has started watching for peer apps within wireless range.

The peer watcher has stopped watching for peer apps within wireless range.

The peer watcher is stopping.

Enables you to publish messages to proximate devices or subscribe to messages from proximate devices.

Gets the transfer rate of a proximity device.

The transfer rate of a proximity device.

Gets the DeviceInformation Id for a proximity device.

The DeviceInformation Id for a proximity device.

Gets the maximum size of a published message that this proximity device supports.

The maximum size of a published message that this proximity device supports.

Occurs when a device enters the proximate range.

Occurs when a device leaves the proximate range.

Creates an instance of a ProximityDevice class and activates the specified proximity device interface.

The DeviceInformation Id of a proximity device. A new ProximityDevice that uses the specified proximity device interface. Throws a **System.IO.FileNotFoundException** exception if the specified proximity device interface isunavailable.

Creates an instance of a ProximityDevice class and activates the default proximity provider.

A new proximity device that uses the default proximity provider. Returns **NULL** if no proximity devices are installed.

Returns the class selection string that you can use to enumerate proximity devices.

The class selection string for proximity devices.

Publishes to subscribers of the specified message type a message that contains binary data.

The type of message to deliver to subscribers. The binary message data to deliver to subscribers. A unique publication ID for the published message.

Publishes a message that contains binary data to subscribers of the specified message type. The specified handler is called when the message has been transmitted.

The type of message to deliver to subscribers. The binary message data to deliver to subscribers. The handler to call when the message has been transmitted. A unique publication ID for the published message.

Publishes a message to subscribers of the specified message type.

The type of message to deliver to subscribers. The message to deliver to subscribers. A unique publication ID for the published message. Pass this value to the StopPublishingMessage method to stop publishing the message.

Publishes a message to subscribers of the specified message type. The specified handler is called when the message has been transmitted.

The type of message to deliver to subscribers. The message to deliver to subscribers. The handler to call when the message has been transmitted. A unique publication ID for the published message.

Publishes a Uniform Resource Identifier (URI) to a proximate device.

The URI to publish. The publication ID of the message.

Publishes a Uniform Resource Identifier (URI) to a proximate device. The specified handler is called when the message has been transmitted.

The URI to publish. The handler to call when the message has been transmitted. The publication ID of the message.

Stops publishing a message.

The publication ID for the message.

Cancels a message subscription.

The subscription ID for the message.

Creates a subscription for a specified message type.

The type of message to deliver to this subscription. The handler that the proximity provider will call when it delivers a message. A unique ID for the subscription.

Represents a message that's received from a subscription.

Gets the binary data of the message.

The binary data of the message.

Gets the message data as text.

The message data as text.

Gets the type of the message.

The type of the message.

Gets the subscription ID of the message.

The subscription ID of the message.

Contains properties that the TriggeredConnectionStateChanged event passes to an application.

Gets the unique identifier for the connection in progress.

The unique identifier for the connection in progress.

Gets the StreamSocket instance for the connection.

The StreamSocket instance for the connection.

Gets the state of the connection in progress.

The state of the connection in progress.

Indicates the current state of a connection to a peer application.

The connection was stopped before it was completed.

The connection is complete, and the StreamSocket class can now be used to communicate with the peer.

This side of the socket connection will be the client and is attempting to connect to the peer.

An error prevented a successful connection.

This side of the socket connection will be the host and is waiting for a connection from the peer.

A device that supports proximity socket connections is within proximity. The tap gesture is complete.

Represents a delivery vehicle and addressing mechanism for push notifications.

Gets the time at which the channel expires. Notifications sent to this channel after this time are rejected.

The time at which the channel expires. Notifications sent to this channel after this time are rejected.

Gets the Uniform Resource Identifier (URI) to which an app server sends a push notification intended for an application or secondary tile bound to this channel. This Uniform Resource Identifier (URI) is transmitted to and stored by the third-party app server.

The Uniform Resource Identifier (URI) (https) that the app server uses to post notifications.

Raised when a push notification arrives on this channel.

Explicitly invalidates this channel. Any notifications pushed to this channel after this method is called are not delivered.

Creates objects that you use to retrieve push notification channels from the Windows Push Notification Services (WNS). These channels are bound to an app or secondary tile.

Raised when your push channel is revoked, so that you can immediately request a new channel. This minimizes any downtime resulting from using a revoked WNS channel. The event arguments type is PushNotificationChannelsRevokedEventArgs.

Creates an object, bound to the calling app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS).

The object, bound to the calling app, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Creates an object, bound to a specified app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app. This overload should only be called from a multi-app package, most apps should use the method with no parameter.

The package-relative application identifier (PRAID) of the app to bind to the push notification channel. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. The object, bound to the app specified in *applicationId*, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Creates an object, bound to a secondary tile, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The tile can be a secondary tile of the calling app or any other app in the same package.

The ID of the secondary tile to bind to the push notification channel. The object, bound to the secondary tile, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Gets the manager for the active user.

A PushNotificationChannelManagerForUser object.

Gets the push notifications for the specified user.

The user account for the push notifications. A PushNotificationChannelManagerForUser object.

Creates objects that you use to retrieve push notification channels from the Windows Push Notification Services (WNS). These channels are bound to the current user through an app or secondary tile.

Gets the user.

The user.

Creates an object, bound to the calling app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS).

The object, bound to the calling app, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Creates an object, bound to a specified app, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app.

The package-relative application identifier (PRAID) of the app to bind to the push notification channel. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. The object, bound to the app specified in *applicationId*, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Creates an object, bound to a secondary tile, through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The tile can be a secondary tile of the calling app or any other app in the same package.

The ID of the secondary tile to bind to the push notification channel. The object, bound to the secondary tile, that is used to request a PushNotificationChannel from the Windows Push Notification Services (WNS).

Creates an object bound to a specified app through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app.

An uncompressed key in ANSI X9.62 format. This value is from the P-256 curve defined in the Secure Hash Standard specification. The ID of the push notification channel. The object, bound to the app server specified in appServerKey, that is used to request a PushNotificationChannel from WNS.

Creates an object bound to a specified app through which you retrieve a push notification channel from Windows Push Notification Services (WNS). The specified app must be in the same package as the calling app.

An uncompressed key in ANSI X9.62 format. This value is from the P-256 curve defined in the Secure Hash Standard specification. The ID of the push notification channel. The package-relative application identifier (PRAID) of the app to bind to the push notification channel. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. The object, bound to the app server specified in appServerKey, that is used to request a PushNotificationChannel from WNS.

Represents the event arguments for the PushNotificationChannelManager.ChannelsRevoked event.

Encapsulates a push notification that has been received from the app server, identifying the type and supplying the content of the notification. Windows passes this information in the PushNotificationReceived event.

Gets the content of a badge update to perform in response to this push notification.

Holds the update information. If NotificationType is not of type **Badge**, this value is **NULL**.

Gets or sets whether Windows should perform its default handling of the notification.

True to prevent default processing of the notification by Windows, otherwise false. The default value is false.

Gets the type of push notification that has been received from the app server.

The type (badge, tile, toast, or raw) of push notification that has been received.

Gets the app-defined content contained in this push notification, the contents of which are used to perform a background task on the app.

Encapsulates the app-defined content of the raw notification. If NotificationType is not of type **Raw**, this value is **NULL**.

Gets the content of a tile update to perform in response to this push notification.

Holds the update information. If NotificationType is not of type **Tile**, this value is **NULL**.

Gets the content of a toast to display in response to this push notification.

Holds the toast information. If NotificationType is not of type **Toast**, this value is **NULL**.

The type of push notification that has been received from the app server. Used by the NotificationType property.

A push notification to update a tile's badge overlay.

A push notification to perform an update to a tile that does not involve UI.

A push notification to update one or more elements of a tile.

A push notification to update an app's tile flyout.

A push notification to display as toast.

Encapsulates the app-defined content of a raw notification (a push notification that does not involve UI). Its contents can be used in an app's background task, if the app has that capability, or otherwise consumed by the app and acted on as needed.

Gets the Channel ID of the raw notification.

A string that contains the app-defined Channel ID, as set by the app server.

Gets the content of the raw notification as a string. This string specifies a background task associated with the app.

A string that contains the app-defined notification content, as set by the app server.

Gets the content of the raw notification as an IBuffer.

An IBuffer representing the content of the raw notification.

Gets the raw header content from the notification.

A map view of the header values. See remarks for the header format.

Encapsulates detailed information about the result of an attempt to register a service instance using DNS-SD.

Constructor.

Indicates whether the instance name was changed in the course of the registration process.

When **true**, the name has been changed.

The IP address of the successfully-created service instance.

The IP address of the successfully created service instance.

An enumeration value indicating the result of a service instance registration attempt.

The enumeration value.

Gets the DNS SRV RR of a successfully registered service instance.

The DNS SRV RR of the instance.

Values representing the status of a DNS-SD registration attempt.

The service was not registered because the service name provided is not valid.

The service was not registered because security settings did not allow it.

The service was not registered because of an error on the DNS server.

The service has been registered successfully.

Encapsulates an instance of a service that uses DNS Service Discovery (DNS-SD).

Creates a new DnssdServiceInstance object with the specified instance name, host name, and port.

The service instance name for the service instance being created. The hostname for the service instance being created. The port number for the service instance being created.

Gets or sets the DNS-SD service instance name for this DnssdServiceInstance.

The name of the service.

Gets or sets the hostname of the host for this DnssdServiceInstance.

The name of the host, encapuslated in a HostName instance.

Gets or sets the port number used by this DnssdServiceInstance.

The port number used by this service instance.

Gets or sets the priority value to assign to this service instance, as defined in RFC 2782. Clients use **Priority** to decide which of several equivalent service instances to attach to.

The priority value for this service instance. See RFC 2782 for details on how clients use this value.

Gets the attributes of this service instance, as a list of [name, value] pairs of strings. Attributes can be inspected by service clients to determine additional information about a service instance.

A collection of attribute [name,value] pairs.

Gets or sets the weight value assigned to this service instance, as defined in RFC 2782. Clients use the **Weight** value to choose between servers with the same **Priority** value.

The weight value for this service instance. See RFC 2782 for details on how clients use this value.

Asynchronously registers a datagram (UDP) socket listener for the service, on a given socket.

Describes the socket that this service instance uses to listen for new service clients. On successful completion of the asynchronous operation, returns an object describing the results of registration.

Asynchronously registers a datagram (UDP) socket listener for the service, on a given socket and network adapter.

Describes the socket that this service instance uses to listen for new service clients. Specifies the network adapter this service uses to listen for new service clients. On successful completion of the asynchronous operation, returns an object describing the results of registration.

Asynchronously registers a stream (TCP) socket listener for the service, on the given socket.

Describes the socket that this service instance uses to listen for new service clients. On successful completion of the asynchronous operation, returns an object describing the results of registration.

Asynchronously registers a stream (TCP) socket listener for the service, on the given socket and network adapter.

Describes the socket that this service instance uses to listen for new service clients. Specifies the network adapter this service uses to listen for new service clients. On successful completion of the asynchronous operation, returns an object describing the results of registration.

Gets the DNS Server Resource Record (SRV RR) of this service instance, as a string.

The DNS Server Resource Record of this server instance.

A collection of DNS Service Discovery (DNS-SD) service instances.

Gets the number of items in the collection

The number of items in the collection.

Gets an iterator that is initialized to refer to the first item in the instance collection.

Gets an iterator instance initialized to the first item in the service instance collection. Your code can use this iterator to enumerate all members of the collection.

Gets the DnssdServiceInstance at a given index into the DnssdServiceInstanceCollection.

The index of the instance to be retrieved. Indices are 0-based. If your code specifies an index that is out of bounds, an exception is thrown. The maximum valid index is equal to one less than the DnssdServiceInstanceCollection.Size value. The DnssdServiceInstance at the given index in the collection.

Gets multiple DnssdServiceInstance objects from a DNS-SD service instance collection.

Index of the first collection item to be retrieved. The retrieved DnssdServiceInstance objects. The number of items in *items*.

Gets a value indicating whether a given DnssdServiceInstance is at the specified index in this service instance collection.

The DnssdServiceInstance to get the index of. The index, if the DnssdServiceInstance is found. **true** if *value* is found at *index*, **false** otherwise.

Maintains a collection of available DNS Service Discovery (DNS-SD) service instances.

Gets the current status of the DnssdServiceWatcherStatus.

Value describing the current status of the watcher.

Event that is triggered when a DnssdServiceWatcher has added a DNS Service Discovery (DNS-SD) instance to its collection of available service instances.

Event triggered when a DnssdServiceWatcher has finished enumerating available DNS Service Discovery (DNS-SD) service instances.

Event triggered when an in-progress enumeration has been stopped.

Starts an enumeration of the network for available DNS Service Discovery (DNS-SD) service instances.

Stops an in-progress enumeration of available DNS Service Discovery (DNS-SD) service instances.

Values representing the status of a DnssdServiceWatcher.

The watcher has been aborted in the process of enumerating service instances.

The watcher has been created.

The watcher has finished enumerating service instances.

The watcher has acknowledged receiving a start command.

The watcher has completed processing a stop command.

The watcher has acknowledged receiving a stop command.

Represents bandwidth information for network data transfer using a StreamSocket, StreamWebSocket, or MessageWebSocket object.

A Boolean value that indicates whether the computed inbound bandwidth estimate for the network has peaked.

The computed inbound bandwidth estimate in bits per second.

A measure of the instability of the inbound bandwidth estimate in bits per second.

A Boolean value that indicates whether the computed outbound bandwidth estimate for the network path has peaked.

The computed outbound bandwidth estimate in bits per second.

A measure of the instability of the outbound bandwidth estimate in bits per second.

Specifies if the system was able to complete configuration of a ControlChannelTrigger object for use by class elements in the Windows.Networking.Sockets and related namespaces.

A hardware slot was allocated by the system.

The policy check succeeded and a hardware slot has been requested from the system.

A policy error occurred when the system tried to complete configuration of a ControlChannelTrigger. This error can occur when an app has requested more connections for hardware or software slots than are permitted by system policy.

The service provided by the ControlChannelTrigger is unavailable. This can happen if the network connection broker service is not yet ready but the app is trying to establish a ControlChannelTrigger channel. This status code is provided under the following conditions:

The policy check succeeded and a software slot was allocated by the system.

A system error occurred when the system tried to complete configuration of a ControlChannelTrigger for a hardware slot.

The network transport associated with the ControlChannelTrigger was disconnected. The underlying TCP connection was already disconnected by a TCP reset received from the remote destination or a graceful disconnect by either the app or the remote destination. The most common occurrence is a TCP reset or a graceful disconnect sent by the remote destination.

Supports network communication using a UDP datagram socket.

Creates a new DatagramSocket object.

Gets socket control data on a DatagramSocket object.

Socket control data on a DatagramSocket object.

Gets socket information on the local and remote hostnames and local and remote service names for the DatagramSocket object.

Socket information for the DatagramSocket object.

Gets the output stream to write to the remote host.

A stream of bytes to be written to the remote host in a UDP datagram.

An event that indicates that a message was received on the DatagramSocket object.

Starts a bind operation on a DatagramSocket to a local hostname and a local service name.

The local hostname or IP address on which to bind the DatagramSocket object. The local service name or UDP port on which to bind the DatagramSocket object. An asynchronous bind operation on a DatagramSocket object.

Starts a bind operation on a DatagramSocket to a local service name.

The local service name or UDP port on which to bind the DatagramSocket object. An asynchronous bind operation on a DatagramSocket object.

Starts a bind operation on a DatagramSocket to a local service name and specific network interface.

The local service name or UDP port on which to bind the DatagramSocket object. The network adapter on which to bind the DatagramSocket object. An asynchronous bind operation on a DatagramSocket object.

Cancels pending reads and writes over a DatagramSocket object.

An asynchronous cancel operation on a DatagramSocket object.

Closes the DatagramSocket object and aborts any pending operation on the **DatagramSocket**.

Starts a connect operation on a DatagramSocket to a remote network destination specified as an EndpointPair object.

An EndpointPair object that specifies local hostname or IP address, local service name or UDP port, the remote hostname or remote IP address, and the remote service name or remote UDP port for the remote network destination. An asynchronous connect operation on a DatagramSocket object.

Starts a connect operation on a DatagramSocket to a remote destination specified by a remote hostname and a remote service name.

The hostname or IP address of the remote network destination. The service name or UDP port of the remote network destination. An asynchronous connect operation on a DatagramSocket object.

Enables your app's background task to be triggered by the socket broker when traffic for this DatagramSocket arrives while the app is not active.

The IBackgroundTaskRegistration.TaskId of the background task that will be triggered by the socket broker when traffic arrives for this DatagramSocket.

Enables your app's background task to be triggered by the socket broker when traffic for this DatagramSocket arrives while the system is in connected standby.

The IBackgroundTaskRegistration.TaskId of the background task that will be triggered by the socket broker when traffic arrives for this DatagramSocket. Specifies whether to enable or disable the activation of the background task when traffic arrives.

Gets a list of EndpointPair objects based on a remote hostname and remote service name that can be used to send datagrams to a remote network destination.

The remote hostname or IP address. The remote service name or UDP port. A list of EndpointPair objects.

Gets a list of EndpointPair objects based on a remote hostname and remote service name and the sort order to be used.

The remote hostname or IP address. The remote service name or UDP port. The sort order to use when returning the list. A list of EndpointPair objects.

Starts an operation to get an IOutputStream to a remote network destination specified by an EndpointPair object that can then be used to send network data.

An endpoint pair that represents the local hostname or local IP address, the local service name or local UDP port, the remote hostname or remote IP address, and the remote service name or remote UDP port. An IOutputStream that represents the asynchronous operation.

Starts an operation to get an IOutputStream to a remote destination specified by a remote hostname and a remote service name that can then be used to send network data.

The remote hostname or remote IP address. The remote service name or remote UDP port. An IOutputStream that representing the asynchronous operation.

Joins a DatagramSocket object to a multicast group.

The hostname or IP address for the multicast group.

Transfers ownership of the DatagramSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket.

Transfers ownership of the DatagramSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket. Use the SocketActivityContext to pass context information through the socket broker. When your app is notified by the broker of activity, this SocketActivityContext will be provided to your app to help establish the context in which you should handle the notification.

Transfers ownership of the DatagramSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket. Use the SocketActivityContext to pass context information through the socket broker. When your app is notified by the broker of activity, this SocketActivityContext will be provided to your app to help establish the context in which you should handle the notification. How long the socket brokering service should monitor the socket for activity.

Provides socket control data on a DatagramSocket object.

Gets or sets a Boolean value that specifies whether the DatagramSocket allows IP datagrams for UDP to be fragmented.

Whether the DatagramSocket allows datagrams to be fragmented.

Gets or sets the size, in bytes, of the buffer used for receiving data on the DatagramSocket object.

The size, in bytes, of the buffer used for receiving data on the DatagramSocket object.

Gets or sets a Boolean value that specifies whether the DatagramSocket is able to coexist with other Win32 or WinRT multicast sockets bound to the same address/port.

Setting this property to **true** enables the DatagramSocket instance to share its local port with any Win32 sockets that are bound using **SO_REUSEADDR/SO_REUSE_MULTICASTPORT**, and with any other **DatagramSocket** instances that have **MulticastOnly** set to true.

Gets or sets the hop limit on an outbound packet sent to a unicast IP address by the DatagramSocket object.

The hop limit on an outbound packet sent by the DatagramSocket object. The default is 128.

Gets or sets the quality of service on a DatagramSocket object.

The quality of service on a DatagramSocket object. The default is **normal**.

Provides socket information on a DatagramSocket object.

The local IP address associated with a DatagramSocket object.

The local hostname or IP address.

The local service name or UDP port number associated with a DatagramSocket.

The local service name or UDP port number.

The IP address of the remote network destination associated with a DatagramSocket object.

The IP address of the remote network destination.

The UDP port number of the remote network destination associated with a DatagramSocket object.

The UDP port number of the remote network destination.

Provides data for a MessageReceived event on a DatagramSocket.

Gets the local IP address associated with a DatagramSocket when a message was received.

The local IP address where the message was received by the DatagramSocket.

Gets the IP address of the remote sender of the datagram on the DatagramSocket when a message is received.

The IP address of the remote network destination when the message is received on a DatagramSocket.

Gets the UDP port number of the remote sender of the datagram received on the DatagramSocket.

The UDP port number of the remote network destination when a message is received on a DatagramSocket.

Gets a DataReader object to read incoming data received from the remote network destination on a DatagramSocket object.

A DataReader object to read incoming data received from the remote network destination on a DatagramSocket object.

Gets an IInputStream object that represents a sequential stream of bytes to be read as a message from the remote network destination on a DatagramSocket object.

An IInputStream object that represents a sequential stream of bytes to be read as a message.

Provides access to network communication that allows reading and writing using a WebSocket.

Gets the output stream to write to the remote network destination on a IWebSocket object.

A sequential stream of bytes to be written to the remote destination.

Occurs when a close frame is received on the IWebSocket object as part of the close handshake.

Closes the IWebSocket.

Status code indicating the reason for closure. Optional UTF-8-encoded data with additional information about the closure.

Starts an asynchronous operation to connect to a remote network destination on a IWebSocket object.

An absolute Uri for the server to connect to. An asynchronous connect operation on a IWebSocket object.

Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the IWebSocket object.

The name of the request header. The value of the request header.

Provides socket control data on an IWebSocket object.

The size, in bytes, of the send buffer to be used for sending data on an IWebSocket object.

The size, in bytes, of the send buffer to be used for sending data.

The credential to use to authenticate to the proxy server through HTTP header authentication using an IWebSocket object.

The credential to use to authenticate to the proxy server through HTTP header authentication.

The credential to use to authenticate to the WebSocket server through HTTP header authentication using an IWebSocket object.

The credential to use to authenticate to the WebSocket server through HTTP header authentication.

Gets a collection that can be used to add a list of supported sub-protocols that will be advertised to the server during the connect handshake.

A collection that contains the WebSocket sub-protocols supported by the IWebSocket object.

Provides socket control data on an IWebSocket object. This interface extends the IWebSocketControl interface with an additional property.

Gets a list of ignorable server certificate errors. Get this list and add ChainValidationResult values for server certificate errors that you wish to ignore during the secure WebSocket (**wss://** protocol) server certificate validation process.

A list of ChainValidationResult values indicating the server certificate errors to ignore when validating server certificates. By default, the list is empty, and all errors cause validation to fail.

Provides socket information on an IWebSocket object.

Gets bandwidth information for network data transfer on an IWebSocket object.

Bandwidth information for network data transfer on an IWebSocket object.

Gets the IP address associated with an IWebSocket object.

The IP address associated with an IWebSocket object.

Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a IWebSocket object.

The sub-protocol negotiated with the server during WebSocket handshake.

Provides socket information on an IWebSocket object. This interface extends IWebSocketInformation with additional properties.

Gets the certificate provided by the server when a secure WebSocket connection has been established.

The server certificate.

Gets a list of the errors that occurred while establishing a secure WebSocket connection.

A list of values describing secure connection errors.

Gets the category of an error that occurred making an SSL connection with a WebSocket server.

The category of error on an SSL connection.

Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a WebSockets server.

The set of certificates sent by the server during SSL negotiation.

Supports network communication that allows reading and writing whole messages using a WebSocket.

Creates a new MessageWebSocket object.

Gets socket control data on a MessageWebSocket object.

Socket control data on a MessageWebSocket object.

Gets socket information on a MessageWebSocket object.

Socket information on a MessageWebSocket object.

Gets the output stream to write to the remote network destination on a MessageWebSocket object.

A sequential stream of bytes to be written to the remote destination as a single message.

Occurs when a close frame is received on the MessageWebSocket object as part of the close handshake.

An event that indicates that a message was received on the MessageWebSocket object.

Occurs when a new MessageWebSocket connection to a secured server URI (**wss:** protocol) is being validated. Handle this event if you want to implement custom server validation for the connection.

Closes the MessageWebSocket object and sends an empty close frame to the server.

Closes the MessageWebSocket object and indicates a reason for the closure.

Status code indicating the reason for closure. The list of appropriate codes is on the IANA (Internet Assigned Numbers Authority) WebSocket Protocol Registry and is also documented on MDN. Optional UTF-8-encoded data with additional information about the closure.

Starts an asynchronous operation to connect to a remote network destination on a MessageWebSocket object.

An absolute Uri for the server to connect to. An asynchronous connect operation on a MessageWebSocket object.

Asynchronously (with progress) writes a frame of data in a sequential stream, with the semantics that this is the last frame in a WebSocket message (the FIN bit on this frame is set to 1). This method and SendNonfinalFrameAsync allow you to send individual WebSocket frames.

A buffer containing the data that constitutes the frame to be sent. An asynchronous byte writer operation with progress.

Asynchronously (with progress) writes a frame of data in a sequential stream, with the semantics that more frames will follow for the same WebSocket message (the FIN bit on this frame is set to 0). This method and SendFinalFrameAsync allow you to send individual WebSocket frames.

A buffer containing the data that constitutes the frame to be sent. An asynchronous byte writer operation with progress.

Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the MessageWebSocket object.

The name of the request header. The value of the request header.

Provides socket control data on a MessageWebSocket.

Allows an app to get the actual unsolicited WebSocket PONG interval.

System.Timespan

Gets the certificate provided by the client when a secure WebSocket connection has been established.

The client certificate.

Allows an app to get and set the desired unsolicited WebSocket PONG interval.

System.Timespan

Gets a list of ignorable server certificate errors. Get this list and add ChainValidationResult values for server certificate errors that you wish to ignore during the secure WebSocket (**wss://** protocol) server certificate validation process.

A list of ChainValidationResult values indicating the server certificate errors to ignore when validating server certificates. By default, the list is empty, and all errors cause validation to fail.

The maximum message size, in bytes, for a WebSocket message to be configured on the MessageWebSocket object.

The maximum message size, in bytes, to be configured on the MessageWebSocket object.

The WebSocket message type to be configured on a MessageWebSocket object for write operations.

The WebSocket message type. The default is binary.

The size, in bytes, of the send buffer to be used for sending data on a MessageWebSocket object.

The size, in bytes, of the send buffer to be used for sending data.

The credential to use to authenticate to the proxy server through HTTP header authentication using a MessageWebSocket object.

The credential to use to authenticate to the proxy server through HTTP header authentication.

Allows clients to control receiving either complete or partial messages.

A MessageWebSocketReceiveMode enumeration member indicating either complete or partial messages.

The credential to use to authenticate to the WebSocket server through HTTP header authentication using a MessageWebSocket object.

The credential to use to authenticate to the WebSocket server through HTTP header authentication.

Gets a collection that can be used to add a list of supported sub-protocols that will be advertised to the server during the connect handshake.

A collection that contains the WebSocket sub-protocols supported by the MessageWebSocket object.

Provides socket information on a MessageWebSocket.

Gets bandwidth information for network data transfer on a MessageWebSocket object.

Bandwidth information for network data transfer on a MessageWebSocket object.

Gets the IP address associated with a MessageWebSocket object.

The IP address associated with a MessageWebSocket object.

Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a MessageWebSocket object.

The sub-protocol negotiated with the server during the WebSocket handshake.

Gets the certificate provided by the server when a secure WebSocket connection has been established.

The server certificate.

Gets a list of the errors that occurred while establishing a secure WebSocket connection.

A list of values describing secure connection errors.

Gets the category of an error that occurred making an SSL connection with a WebSocket server.

The category of error on an SSL connection.

Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a WebSockets server.

The set of certificates sent by the server during SSL negotiation.

Provides data for a message received event on a MessageWebSocket.

Allow clients to query if a MessageReceived callback indicates the received message is complete or just a partial message.

TRUE if the message is complete. The default value is FALSE.

Gets the type of the message received by a MessageWebSocket object.

The type of the message received.

Gets a DataReader object to read incoming data received from the remote network destination on a MessageWebSocket.

A DataReader object to read incoming data received from the remote network destination on a MessageWebSocket.

Gets an IInputStream object (a message represented as a sequential stream of bytes) from the remote network destination on a MessageWebSocket object.

A message represented as a sequential stream of bytes.

Describes the kind of message that the client will accept.

The client will accept a full message.

The client will accept a partial message.

Represents round trip time information for a StreamSocket object.

The maximum sampled round trip time, in microseconds, for a StreamSocket object.

The minimum sampled round trip time, in microseconds, for a StreamSocket object.

A smoothed value round trip time, in microseconds, computed from all sampled round trip times for a StreamSocket object. The smoothing is a weighted additive function that uses the member.

The round trip time variation, in microseconds, for a StreamSocket object. This value is used for receive window auto-tuning.

Supports network communication that allows reading and writing whole messages using a WebSocket object owned by a web server. You can't register for an arbitrary WebSocket connection; instead, an instance of **ServerMessageWebSocket** is created by system code such as the Windows Device Portal (WDP).

Gets socket control data on a ServerMessageWebSocket object.

Socket control data on a ServerMessageWebSocket object.

Gets socket information on a ServerMessageWebSocket object.

Socket information on a ServerMessageWebSocket object.

Gets the output stream to write to the remote network destination on a ServerMessageWebSocket object.

A sequential stream of bytes to be written to the remote destination as a single message.

Occurs when a close frame is received on the ServerMessageWebSocket object as part of the close handshake.

An event that indicates that a message was received on the ServerMessageWebSocket object.

Closes the ServerMessageWebSocket object and sends an empty close frame to the server.

Closes the ServerMessageWebSocket object and indicates a reason for the closure.

Status code indicating the reason for closure. The list of appropriate codes is on the IANA (Internet Assigned Numbers Authority) WebSocket Protocol Registry and is also documented on MDN. Optional UTF-8-encoded data with additional information about the closure.

Provides socket control data on a ServerMessageWebSocket.

Gets and sets the WebSocket message type to be configured on a ServerMessageWebSocket object for write operations.

The WebSocket message type. The default is binary.

Provides socket information on a ServerMessageWebSocket.

Gets bandwidth information for network data transfer on a ServerMessageWebSocket object.

Bandwidth information for network data transfer on a ServerMessageWebSocket object.

Gets the IP address associated with a ServerMessageWebSocket object.

The IP address associated with a ServerMessageWebSocket object.

Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a ServerMessageWebSocket object.

The sub-protocol negotiated with the server during the WebSocket handshake.

Supports network communication that allows reading and writing streams using a WebSocket object owned by a web server. You can't register for an arbitrary WebSocket connection; instead, an instance of **ServerStreamWebSocket** is created by system code such as the Windows Device Portal (WDP).

Gets socket information on a ServerStreamWebSocket object.

Socket information on a ServerStreamWebSocket object.

Gets the input stream to read from the remote destination on a ServerStreamWebSocket object.

A sequential stream of bytes to be read from the remote destination.

Gets the output stream to write to the remote network destination on a ServerStreamWebSocket object.

A sequential stream of bytes to be written to the remote destination.

Occurs when a close frame is received on the ServerStreamWebSocket object as part of the close handshake.

Closes the ServerStreamWebSocket and sends an empty close frame to the server.

Closes the ServerStreamWebSocket object and indicates a reason for the closure.

Status code indicating the reason for closure. The list of appropriate codes is on the IANA (Internet Assigned Numbers Authority) WebSocket Protocol Registry and is also documented on MDN. Optional UTF-8-encoded data with additional information about the closure.

Provides socket information on a ServerStreamWebSocket object.

Gets bandwidth information for network data transfer on a ServerStreamWebSocket object.

Bandwidth information for network data transfer on a ServerStreamWebSocket object.

Gets the IP address associated with a ServerStreamWebSocket object.

The IP address associated with a ServerStreamWebSocket object.

Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a ServerStreamWebSocket object.

The sub-protocol negotiated with the server during WebSocket handshake.

Indicates whether an app that uses the socket brokering service can receive packets when the system goes to connected stand by.

The app should not receive packets when the system goes to stand by.

The app can receive packets even when the system goes to stand by.

The context associated with a socket while transferring ownership of the socket between an app and the socket brokering service.

Constructs a new SocketActivityContext object with given context data.

Context data to be used when the socket broker notifies the app of socket activity.

Get the serialized data to associate the app context to a transferred socket.

The serialized data to associate the app context to a transferred socket.

Provides information on the transferred socket from the Socket Broker.

Gets a list of all the sockets transferred to the socket brokering service by this app.

A list of all the sockets transferred to the socket brokering service by this app.

Get the context associated while transferring ownership of the socket.

The context associated while transferring ownership of the socket.

Based on the socket type, the app can reclaim the ownership of the appropriate DatagramSocket.

The DatagramSocket to reclaim.

A unique string for this app used to identify the transferred socket. This is passed by the app while transferring the socket ownership to the service.

A unique string to identify the transferred socket.

Gets a SocketActivityKind enumeration value that identifies socket kind.

The socket kind.

Based on the socket type, the app can reclaim the ownership of the appropriate StreamSocket.

The StreamSocket to reclaim.

Based on the socket type, the app can reclaim the ownership of the appropriate StreamSocketListener.

The StreamSocketListener to reclaim.

The background task ID used while transferring ownership of the socket.

The background task ID.

Describes the kind of socket object being transferred to or from the socket broker.

A socket type of DatagramSocket.

The socket type is unknown.

A socket type of StreamSocket.

A socket type of StreamSocketListener.

A object instantiated by the background broker infrastructure and used by an app to retrieve details when a SocketActivityTrigger occurs.

Get the reason the SocketActivityTrigger occurred.

The reason the SocketActivityTrigger occurred.

Get the SocketActivityInformation object for socket that caused the SocketActivityTrigger to occur.

Socket activity information for socket that caused the SocketActivityTrigger to occur.

The reason why a SocketActivityTrigger occurred.

A connection was accepted by the socket brokering service for a StreamSocketListener.

The keep-alive timer expired on a StreamSocket.

No reason why a occurred is available.

A packet was received by the socket brokering service for a StreamSocket or DatagramSocket.

A StreamSocket was closed.

Provides socket error status for operations on a DatagramSocket, StreamSocket, or StreamSocketListener.

Gets a SocketErrorStatus value based on an error encountered by a socket operation.

The error encountered by a socket operation represented as an **HRESULT**. The socket error status value for a socket operation.

Specifies status values for a socket operation.

The address is already in use.

The address family is not supported.

Cannot assign requested address.

The certificate is not valid for the requested usage. This error is also returned if the certificate has an invalid name. The name is not included in the permitted list or is explicitly excluded.

A required certificate is not within its validity period when verifying against the current system clock or the timestamp in the signed file. This error is also returned if the validity periods of the certification chain do not nest correctly.

The supplied certificate is invalid. This can be returned for a number of reasons:

The revocation function was unable to check revocation for the certificate.

The revocation function was unable to check revocation because the revocation server was offline.

A certificate was explicitly revoked by its issuer. This error is also returned if the certificate was explicitly marked as untrusted by the user.

A certificate chain processed, but terminated in a root certificate which is not trusted by the trust provider. This error is also returned if a certificate chain could not be built to a trusted root authority.

The certificate is not valid for the requested usage.

The specified class was not found.

The connection was refused.

The connection was reset by the peer.

A connection timeout was exceeded.

The host is down.

The host was not found.

A bad response was received from the HTTP server.

A message sent on a datagram socket was larger than the internal message buffer or some other network limit, or the buffer used to receive a datagram was smaller than the datagram itself.

The network dropped connection on reset.

The network is down.

The network is unreachable.

The pipe is being closed.

The requested name is valid and was found in the database, but it does not have the correct associated data being resolved for.

This is usually a temporary error during hostname resolution and means that the local server did not receive a response from an authoritative server.

The operation was aborted.

The socket type is not supported.

Software caused a connection abort.

Too many open files.

The socket status is unknown.

The host is unreachable.

Specifies the type of a message for a MessageWebSocket object.

The message type is binary.

The message type is UTF-8 text.

Specifies the level of encryption to use on a StreamSocket object.

A Bluetooth socket that prefers that encryption be used, but allows a NULL cipher (no encryption) based on the configuration of the target server.

A Bluetooth socket that must use encryption. This value requires encryption and never allows a NULL cipher.

A plain socket with no encryption.

A TCP socket that must use the Secure Sockets Layer (SSL) for encryption. This value requires encryption and never allows a NULL cipher (no encryption).

Ssl may result in insecure connections and may be altered or unavailable for releases after Windows 8.1. Instead, use one of the TLS SocketProtectionLevel values.

A TCP socket that must use SSL for encryption. This value supports the SSL 3.0 protocol and all encryption ciphers installed on the system except the NULL cipher. This value allows RC4 and other weak ciphers which are considered insecure. For domain-joined machines, an administrator can configure additional restrictions on which ciphers are allowed.

Ssl3AllowWeakEncryption may result in insecure connections and may be altered or unavailable for releases after Windows 8.1. Instead, use one of the TLS SocketProtectionLevel values.

A TCP socket that prefers to use SSL for encryption. This value prefers that full encryption be used, but allows a NULL cipher (no encryption) based on the server configuration.

A TCP socket that must use SSL for encryption. This value supports the TLS 1.0 protocol and all encryption ciphers installed on the system except RC4, other weak ciphers, and the NULL cipher. For domain-joined machines, an administrator can configure additional restrictions on which ciphers are allowed.

A TCP socket that must use SSL for encryption. This value supports the TLS 1.1 and TLS 1.0 protocols and all encryption ciphers installed on the system except RC4, other weak ciphers, and the NULL cipher. For domain-joined machines, an administrator can configure additional restrictions on which ciphers are allowed.

A TCP socket that must use SSL for encryption. This value supports the TLS 1.2, TLS 1.1 and TLS 1.0 protocols and all encryption ciphers installed on the system except RC4, other weak ciphers, and the NULL cipher. For domain-joined machines, an administrator can configure additional restrictions on which ciphers are allowed.

The protection level is unspecified.

Specifies the quality of service for a DatagramSocket or StreamSocket object.

Low latency quality of service commonly used for audio.

Normal quality of service.

The category of error that occurs on an SSL connection.

Fatal errors indicate the SSL server’s certificate cannot be validated. Reasons for encountering this severity level include:

Ignorable errors indicate that the SSL server’s certificate cannot be properly validated.

No error occurs on the SSL connection.

Supports network communication using a stream socket over TCP or Bluetooth RFCOMM in UWP apps.

Creates a new StreamSocket object.

Gets socket control data on a StreamSocket object.

Socket control data on a StreamSocket object.

Gets socket information on a StreamSocket object.

Socket information on a StreamSocket object.

Gets the input stream to read from the remote destination on a StreamSocket object.

A sequential stream of bytes to be read from the remote destination.

Gets the output stream to write to the remote host on a StreamSocket object.

A sequential stream of bytes to be written to the remote destination.

Cancels pending reads and writes over a StreamSocket object.

An asynchronous cancel operation on a StreamSocket object.

Closes the StreamSocket object.

Starts an asynchronous operation on a StreamSocket object to connect to a remote network destination specified as an EndpointPair object.

An EndpointPair object that specifies the local hostname or IP address, the local service name or TCP port, the remote hostname or remote IP address, and the remote service name or remote TCP port for the remote network destination. An asynchronous connect operation on a StreamSocket object.

Starts an asynchronous operation on a StreamSocket object to connect to a remote network destination specified as an EndpointPair object and a SocketProtectionLevel enumeration. This method is not callable from JavaScript.

An EndpointPair object that specifies local hostname or IP address, local service name or TCP port, the remote hostname or remote IP address, and the remote service name or remote TCP port for the remote network destination. The protection level that represents the integrity and encryption for a StreamSocket object. An asynchronous connect operation on a StreamSocket object.

Starts an asynchronous operation on a StreamSocket object to connect to a remote network destination specified by a remote hostname and a remote service name.

The hostname or IP address of the remote network destination. For Bluetooth RFCOMM, this is a MAC address. The service name or TCP port number of the remote network destination. For Bluetooth RFCOMM, this is the Bluetooth address. An asynchronous connect operation on a StreamSocket object.

Starts an asynchronous operation on a StreamSocket object to connect to a remote destination specified by a remote hostname, a remote service name, and a SocketProtectionLevel.

The hostname or IP address of the remote network destination. For Bluetooth RFCOMM, this is a MAC address. The service name or TCP port number of the remote network destination. For Bluetooth RFCOMM, this is the Bluetooth address. The protection level that represents the integrity and encryption for the StreamSocket object. An asynchronous connect operation on a StreamSocket object.

Starts an asynchronous operation on a StreamSocket object on a specified local network adapter to connect to a remote destination specified by a remote hostname, a remote service name, and a SocketProtectionLevel.

The hostname or IP address of the remote network destination. For Bluetooth RFCOMM, this is a MAC address. The service name or TCP port number of the remote network destination. For Bluetooth RFCOMM, this is the Bluetooth address. The protection level that represents the integrity and encryption for the StreamSocket object. The local network adapter to use for the connect operation on the StreamSocket object. An asynchronous connect operation on a StreamSocket object.

Enables your app's background task to be triggered by the socket broker when traffic for this StreamSocket arrives while the app is not active.

The IBackgroundTaskRegistration.TaskId of the background task that will be triggered by the socket broker when traffic arrives for this StreamSocket.

Enables or disables the ability of your app's background task to be triggered by the socket broker when traffic for this StreamSocket arrives while the system is in connected standby.

The IBackgroundTaskRegistration.TaskId of the background task being enabled or disabled. Specifies whether to enable or disable the activation of the background task when traffic arrives.

Gets a list of EndpointPair objects based on a remote hostname and remote service name that can be used to send TCP packets to a remote network destination.

The hostname of a service. The service might actually be hosted on multiple services, so that a DNS lookup returns multiple IP addresses for the various servers. This method returns one endpoint pair for each of the servers found by a DNS lookup. The name or port number of a remote service. Note that different servers might support the named service on different physical ports, so not all of the returned endpoints will use the same service port number. An asynchronous lookup operation. On successful completion, the returned list contains one EndpointPair for each remote host found, with one end point being one of the remote hosts and the other being the local host.

Gets a list of EndpointPair objects based on a remote hostname and remote service name and the sort order to be used.

The remote hostname or IP address. The remote service name or UDP port. The sort order to use when returning the list. A list of EndpointPair objects.

Transfers ownership of the StreamSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket.

Transfers ownership of the StreamSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity. Specifies a new SocketActivityContext for the socket.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket. Use the SocketActivityContext to pass context information through the socket broker. When your app is notified by the broker of activity, this SocketActivityContext will be provided to your app to help establish the context in which you should handle the notification.

Transfers ownership of the StreamSocket to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity. Specifies a new SocketActivityContext and a keep alive time for the socket.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket. Use the SocketActivityContext to pass context information through the socket broker. When your app is notified by the broker of activity, this SocketActivityContext will be provided to your app to help establish the context in which you should handle the notification. How long the socket brokering service should monitor the socket for activity.

Starts an asynchronous operation to upgrade a connected socket to use SSL on a StreamSocket object.

The protection level that represents the integrity and encryption on the StreamSocket object. The hostname of the remote network destination that is used for validation when upgrading to SSL. An asynchronous operation to upgrade to use SSL on a StreamSocket object.

Provides socket control data on a StreamSocket object.

Gets or sets the client SSL/TLS certificate that will be sent to the server if the server requests a client certificate.

The client certificate.

Get a vector of SSL server errors to ignore when making an SSL connection with a StreamSocket.

A vector of SSL server errors to ignore.

A value that indicates whether keep-alive packets are sent to the remote destination on a StreamSocket object.

Whether keep-alive packets are sent to the remote destination.

Constrains the TLS protocol version that will be negotiated when the developer uses the ConnectAsync() or UpgradeToSslAsync() methods that require TLS.

A SocketProtectionLevel enumeration member indicating the socket protection level.

A value that indicates whether the Nagle algorithm is used on a StreamSocket object.

A value that indicates whether the Nagle algorithm is used on the TCP connection of a StreamSocket object

The size, in bytes, of the send buffer to be used for sending data on a StreamSocket object.

The size, in bytes, of the send buffer to be used for sending data.

The hop limit on an outbound packet sent to a unicast IP address by the StreamSocket object.

The hop limit on an outbound packet sent by the StreamSocket object. The default is 128.

The quality of service on a StreamSocket object.

The quality of service on a StreamSocket object.

A value that indicates whether, when multiple connection attempts are being made, the attempts are made in parallel or serially.

When true, at most one connection attempt will be active at one time on this StreamSocket. Default value is false.

Provides socket information on a StreamSocket object.

Gets bandwidth information for network data transfer on a StreamSocket object.

Bandwidth information for network data transfer on a StreamSocket object.

Gets the local IP address associated with a StreamSocket object.

The local IP address or hostname.

Get the TCP port number associated with a StreamSocket.

The local TCP port number of service name.

Gets the protection level that represents the integrity and encryption set on a StreamSocket object.

The protection level that represents the integrity and encryption set on a StreamSocket object.

Get the IP address or hostname of the remote network destination associated with a StreamSocket object.

The IP address of the remote network endpoint after a connection is established.

Get the hostname or IP address of the remote network destination associated with a StreamSocket object.

The hostname or IP address of the remote network destination.

Get the TCP port number or service name of the remote network destination associated with a StreamSocket object.

The TCP port number of the remote network endpoint after a connection is established.

Get the service name or TCP port number of the remote network destination associated with a StreamSocket object.

The service name or TCP port number of the remote network destination.

Gets round trip time information for a StreamSocket object.

Round trip time information for a StreamSocket object.

Gets the certificate from the server when making an SSL connection with a StreamSocket.

The certificate from the server with the SSL information.

Gets the list of errors that occurred making an SSL connection with a StreamSocket.

The list of errors that occurred making an SSL connection.

Gets the category of an error that occurred making an SSL connection with a StreamSocket.

The category of error on an SSL connection.

Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a StreamSocket.

The set of certificates sent by the server during SSL negotiation.

Get a byte array that represents the private shared secret exchanged by proximity devices.

A byte array that represents the private shared secret exchanged by proximity devices.

Supports listening for an incoming network connection using a TCP stream socket or Bluetooth RFCOMM.

Creates a new StreamSocketListener object.

Gets socket control data on a StreamSocketListener object.

Socket control data on a StreamSocketListener object.

Gets socket information for the StreamSocketListener object.

Socket information for the StreamSocketListener object.

An event that indicates that a connection was received on the StreamSocketListener object.

Starts a bind operation on a StreamSocketListener to a local hostname and a local service name.

The local hostname or IP address on which to bind the StreamSocketListener object. The local service name or TCP port on which to bind the StreamSocketListener object. An asynchronous bind operation on a StreamSocketListener object.

Starts a bind operation on a StreamSocketListener to a local service name.

The local service name or TCP port on which to bind the StreamSocketListener object. For Bluetooth RFCOMM, this parameter is the Bluetooth Service ID. The asynchronous bind operation on a StreamSocketListener object.

Starts a bind operation on a StreamSocketListener to a local service name with a specified SocketProtectionLevel to set on any bound sockets.

The local service name or TCP port on which to bind the StreamSocketListener object. For Bluetooth RFCOMM, this parameter is the Bluetooth Service ID. The protection level for encryption to set on any bound sockets. The asynchronous bind operation on a StreamSocketListener object.

Starts a socket bind operation on a StreamSocketListener to a local service name on a specified network adapter with a specified SocketProtectionLevel to set on any bound sockets.

The local service name or TCP port on which to bind the StreamSocketListener object. For Bluetooth RFCOMM, this parameter is the Bluetooth Service ID. The protection level for encryption to set on any bound sockets. The network adapter on which to bind the StreamSocketListener object. The asynchronous bind operation on a StreamSocketListener object.

Cancels pending reads and writes over a StreamSocketListener object.

An asynchronous cancel operation on a StreamSocketListener object.

Closes the StreamSocketListener object.

Enables your app's background task to be triggered by the socket broker when traffic for this StreamSocketListener arrives while the app is not active.

The IBackgroundTaskRegistration.TaskId of the background task that will be triggered by the socket broker when traffic arrives for this StreamSocketListener.

Enables your app's background task to be triggered by the socket broker when traffic for this StreamSocketListener arrives while the system is in connected standby.

The IBackgroundTaskRegistration.TaskId of the background task that will be triggered by the socket broker when traffic arrives for this StreamSocketListener. Specifies whether to enable or disable the activation of the background task when traffic arrives.

Transfers ownership of the StreamSocketListener to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket.

Transfers ownership of the StreamSocketListener to the socket brokering service, which monitors socket activity and notifies the app through a background task if there is any activity.

A string the app uses to identify the transferred socket. The string should identify this socket uniquely within the app. When activity occurs on this socket, this string will be provided to the app to identify the socket. Use the SocketActivityContext to pass context information through the socket broker. When your app is notified by the broker of activity, this SocketActivityContext will be provided to your app to help establish the context in which you should handle the notification.

Provides data for a ConnectionReceived event on a StreamSocketListener object.

The StreamSocket object created when a connection is received by the StreamSocketListener object.

The StreamSocket object created when a connection is received by the StreamSocketListener object.

Provides socket control data on a StreamSocketListener object.

A value that indicates whether keep-alive packets should be sent on a StreamSocket object created when a connection is received by the StreamSocketListener object.

Whether keep-alive packets are sent on the StreamSocket object created.

A value that indicates whether the Nagle algorithm is used on a StreamSocket object created when a connection is received by the StreamSocketListener object.

A value that indicates whether the Nagle algorithm is used on the TCP connection of a StreamSocket object created.

The size, in bytes, of the send buffer to be used for sending data on a StreamSocket object created when a connection is received by the StreamSocketListener object.

The size, in bytes, of the send buffer to be used for sending data on the StreamSocket object created.

The hop limit on an outbound packet sent to a unicast IP address by the StreamSocket object created when a connection is received by the StreamSocketListener object.

The hop limit on an outbound packet sent by the StreamSocket object created. The default is 128.

The quality of service to be set on a StreamSocket object created when a connection is received by the StreamSocketListener object.

The quality of service set on a StreamSocket object created when a connection is received by the StreamSocketListener object.

Provides socket information on a StreamSocketListener object.

Get the local TCP port number associated with a StreamSocketListener object.

The local TCP port number or service name.

Supports network communication that allows reading and writing streams using a WebSocket.

Creates a new StreamWebSocket object.

Gets socket control data on a StreamWebSocket object.

Socket control data on a StreamWebSocket object.

Gets socket information on a StreamWebSocket object.

Socket information on a StreamWebSocket object.

Gets the input stream to read from the remote destination on a StreamWebSocket object.

A sequential stream of bytes to be read from the remote destination.

Gets the output stream to write to the remote network destination on a StreamWebSocket object.

A sequential stream of bytes to be written to the remote destination.

Occurs when a close frame is received on the StreamWebSocket object as part of the close handshake.

Occurs when a new StreamWebSocket connection to a secured server URI (**wss:** protocol) is being validated. Handle this event if you want to implement custom server validation for the connection.

Closes the StreamWebSocket and sends an empty close frame to the server.

Closes the StreamWebSocket and indicates a reason for the closure.

Status code indicating the reason for closure. Optional UTF-8-encoded data with additional information about the closure.

Starts an asynchronous operation to connect to a remote network destination on a StreamWebSocket object.

An absolute Uri for the server to connect to. An asynchronous connect operation on a StreamWebSocket object.

Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the StreamWebSocket object.

The name of the request header. The value of the request header.

Provides socket control data on a StreamWebSocket object.

Allows an app to get the actual unsolicited WebSocket PONG interval.

System.Timespan

Gets the certificate provided by the client when a secure WebSocket connection has been established.

The client certificate.

Allows an app to get and set the desired unsolicited WebSocket PONG interval.

System.Timespan

Gets a list of ignorable server certificate errors. Get this list and add ChainValidationResult values for server certificate errors that you wish to ignore during the secure WebSocket (**wss://** protocol) server certificate validation process.

A list of ChainValidationResult values indicating the server certificate errors to ignore when validating server certificates. By default, the list is empty and all errors cause validation to fail.

A value that indicates whether the Nagle algorithm is used on a StreamWebSocket object.

A value that indicates whether the Nagle algorithm is used on the TCP connection of a StreamWebSocket object.

The size, in bytes, of the send buffer to be used for sending data on a StreamWebSocket object.

The size, in bytes, of the send buffer to be used for sending data.

The credential to use to authenticate to the proxy server through HTTP header authentication using a StreamWebSocket object.

The credential to use to authenticate to the proxy server through HTTP header authentication.

The credential to use to authenticate to the WebSocket server through HTTP header authentication using a StreamWebSocket object.

The credential to use to authenticate to the WebSocket server through HTTP header authentication.

Gets a collection that can be used to add a list of supported sub-protocols that will be advertised to the server during the connect handshake.

A collection that contains the WebSocket sub-protocols supported by the StreamWebSocket object.

Provides socket information on a StreamWebSocket object.

Gets bandwidth information for network data transfer on a StreamWebSocket object.

Bandwidth information for network data transfer on a StreamWebSocket object.

Gets the IP address associated with a StreamWebSocket object.

The IP address associated with a StreamWebSocket object.

<!--Info taken from published (now removed) StreamWebSocket.Protocol page - needs review.-->

The sub-protocol negotiated with the server during WebSocket handshake.

Gets the certificate provided by the server when a secure WebSocket connection has been established.

The server certificate.

Gets a list of the errors that occurred while establishing a secure StreamWebSocket connection.

A list of values describing secure connection errors.

Gets the category of an error that occurred making an SSL connection with a StreamWebSocket server.

The category of error on an SSL connection.

Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a StreamWebSocket server.

The set of certificates sent by the server during SSL negotiation.

Provides data for a closed event on a MessageWebSocket, StreamWebSocket, or IWebSocket object.

Gets information about the reason that a WebSocket object was closed.

Status code indicating the reason for closure.

Gets additional details about the reason that a WebSocket object was closed.

Detailed information about the closure.

Provides socket error status on a MessageWebSocket or StreamWebSocket object.

Gets a WebErrorStatus value based on an error encountered by a WebSocket operation.

The error encountered by a WebSocket operation represented as an **HRESULT**. The socket error status value for a WebSocket operation.

Provides the ability to send a WebSocket protocol keep-alive on a connected WebSocket.

Creates a new WebSocketKeepAlive object.

Sends a WebSocket protocol keep-alive on a connected WebSocket.

Specific instance of a background task.

Provides data for a ServerCustomValidationRequested event on a WebSocket. This event occurs when a new, secure connection to a WebSocket is being made, and gives your code the opportunity to perform custom validation of the server certificates before the connection has been established.

The certificate being offered by the server for validation.

The server certificate.

A list of errors encountered in validating the server certificate.

A list of enumeration values giving validation results.

Gets the category of an error that occurred making an SSL connection with this WebSocket server.

A value describing the severity of errors encountered so far in validating this connection.

Gets a list of intermediate certificates from the validation process currently being validated.

A list of intermediate certificates.

Gets the Deferral object that manages the validation operation. Call this method when you begin your validation operation, and call Deferral.Complete when the operation is complete.

The Deferral object.

Rejects validation of this server. Call this method when your validation has determined that you should not connect to the server.

Provides static functions for VPN plug-ins.

A VPN plug-in must always call this function in its background tasks Run() method.

The plug-in to be processed.

Provides an interface for the VPN platform to support requested credentials.

Gets an additional PIN supplied by the user, typically when requesting user name, password, and PIN.

An additional PIN provided by the user.

Gets the certificate that the plug-in was granted access to after requesting it.

Gets the certificate to which we were granted access for use in the VPN connection.

Gets the previous credential the user used to log on to the VPN server, as in the case of a password change.

The previous credential the user used to log in to the VPN server.

Gets password or PIN corresponding to this credential request.

The password or PIN corresponding to this credential request.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Provides a common interface for all UI element objects used in the VpnChannel.RequestCustomPromptAsync method.

Gets or sets whether the object is required to receive input before continuing the UI flow.

If the user must provide some input, it is TRUE; otherwise , it is FALSE.

Gets or sets the text label of the input UI element.

The text label of the input UI element.

Gets or sets whether the UI element is emphasized (bordered) or not.

If the input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Factory to create VpnDomainNameInfo objects.

Creates a VpnDomainNameInfo object.

The domain name. This could be an FQDN, or a DNS suffix. An enum value indicating whether the namespace in question is a FQDN, or a DNS suffix. A list of DNS servers to perform DNS resolution against when resolving a name in the namespace. A list of web proxy servers to be used when connecting to a resource in the specified namespace. Specifies the name policy for a specific namespace. It can specify the DNS servers to use for name resolution of the namespace, the web proxies to use when connecting to the namespace, or whether it should be exempted from the policy itself.

Factory to create VpnInterfaceId objects.

Creates a VpnInterfaceId object.

The address represented as a set of bytes. Represents an interface ID used in the construction and assignment of an IPv6 address to the VPN interface. The ID contained in this class fills the interface ID portion of the IPv6 address.

**IVpnNamespaceInfoFactory** is not supported and may be altered or unavailable in the future. Instead, use IVpnDomainNameInfoFactory.

Not supported.

Not supported. Not supported. Not supported. A list of web proxy servers to be used when connecting to a resource in the specified namespace.

This interface is reserved for system use.

Reserved.

Reserved. Reserved. Not used. Reserved.

Provides an interface to implement specific third party VPN client operations.

This method instructs the VPN plug-in to connect to the VPN server and establish the VPN channel.

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server.

This method instructs the VPN plug-in to prepare receive a buffer from the VPN server **outerTunnelTransport**, extract any number of IP packets encapsulated in the buffer, and return the IP packets together with any other reply buffers that are needed to be sent back through the **outerTunnelTransport** to the VPN server.

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server. A buffer originated from the VPN server and received through the **outerTunnelTransport.** An **IVpnPacketBuffer** chain representing any L3 IP packets extracted and decapsulated from the buffer and which need to be injected through the VPN interface to be received by the client machine's TCP/IP stack. An **IVpnPacketBuffer** chain representing any control messages that VPN plug-in is required by its protocol specification to reply back to the VPN server.

This method instructs the VPN plug-in to disconnect from the VPN server and destroy the VPN channel.

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server.

This method instructs the VPN plug-in to prepare the indicated L3 IP packet for transmission to the VPN server. The process might include any encapsulation specific to the VPN protocol.

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server. An L3 IP packets originated by the client machine TCP/IP stack and that needs to be processed to be sent to the corporate network. An buffer containing an encapsulated IP packet (framed in a specific VPN protocol message and or potentially encrypted) that is ready to be sent to the VPN server through the **outerTunnelTransport.**

This method instructs the VPN plug-in to compute and return a Keep alive payload ready to be sent to the VPN server.

The VPN channel object representing the instance VPN connection of the VPN plug-in to the VPN server. An VPN protocol specific message payload used by the VPN Plug-in to indicate to the server that the client and its VPN connection are still alive.

Exposes the **VpnProfile** base object.

Gets or sets the AlwayOn property. If true, indicates that the VPN profile is always connected.

If the VPN profile is an AlwaysOn profile, it is TRUE; otherwise , it is FALSE.

Gets a list of apps that will trigger the VPN connection to connect.

A list of apps that will trigger the VPN connection to connect.

Gets a list of Name Resolution Policy Table (NRPT) rules for the VPN plug-in profile.

A list of Name Resolution Policy Table (NRPT) rules for the VPN plug-in profile.

Gets or sets the name of the VPN profile.

The name of the VPN profile.

Gets or sets whether the credentials for the VPN profile will be cached. If TRUE, the credentials for the VPN profile will be cached where applicable.

If the credentials for the VPN profile will be cached, it is TRUE; otherwise , it is FALSE.

Gets a list of routes that must go over the VPN interface in the case of a Split Tunneled VPN.

A list of routes that must go over the VPN interface in the case of a Split Tunneled VPN.

Gets a list of Traffic Filters (including per App) included in the VPN profile.

A list of Traffic Filters (including per App) included in the VPN profile.

Factory to create VpnRoute objects.

Creates VpnRoute objects.

Represents the ID or the address of the subnet under the route control. The size (in bits) to be considered by the subnet. Represents a route relative to the VPN channel. It is composed of an address and a prefix size to identify the subnet being routed.

Represents an application identifier, which can be a file path, a package family name, or a fully qualified binary name (FQBN) string.

Creates a **VpnAppId** object with specified app ID and type.

The type of app ID to be created. The value of the app ID to be created. Value must be correct for the given *type* value.

Gets or sets the type of the app ID.

An enum value that corresponds to the type of the app ID.

Gets or sets the value of the app ID.

The app ID. The format of the ID must be correct for the VpnAppId.Type value.

Specifies the type of AppId understood by the VPN platform.

File path.

Fully qualified binary name (FQBN).

Package family name.

Specifies the type of authentication methods allowed by the operating system native VPN protocols.

Certificate

Extensible Authentication Protocol

Microsoft Challenge-Handshake Authentication Protocol v2

Preshared key

Provides methods to create and destroy a VPN channel, and methods to perform buffer management. A VPN channel is the object in the system that links the network traffic data flow between the VPN plug-in's VPN server socket and the client machine network stack.

Gets or sets a **VpnChannelConfiguration** object corresponding to the configuration of the VpnChannel and which dictates how to establish the communication with the VPN server.

A **VpnChannelConfiguration** object containing the configuration pertaining the VpnChannel object.

Gets the transport context object in use, for example the name of a host or server.

The transport context object in use, for example the name of a host or server. The value is `null` if the property is accessed outside of a callback (for example, in the case of a reconnection).

Gets the unique instance ID of a VPN channel. This can be used to simplify demuxing operations between two VPN connection instances.

A number representing the unique ID of the VPN channel.

Gets or sets a context object that VPN plug-ins can use to associate their internal state with a VpnChannel object for later use while the session is in progress.

The contents of the Object are defined by the individual plug-in, based on the needs of the plug-in.

Gets the statement of health of the client machine.

A pointer to the VpnSystemHealth class that provides access to the statement of health for the client machine.

Not supported.

Event raised when the channel's activity state has changed. Used by VPN plug-ins to determine whether the channel is active with traffic or idle.

Prepares, marks, and creates the transport for use by the VPN framework as a transport link communicating the VPN plug-in to the VPN server. This call must be performed before any other operations related to the VPN framework APIs.

An **IInspectable** object for socket transport. This object can be a Windows.Networking.StreamSocket, a Windows.Networking.StreamWebSocket, or a Windows.Networking.DatagramSocket. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call. The transport context object to use, for example the name of a host or server.

Prepares and marks the transport for use by the VPN framework as a transport link communicating the VPN plug-in to the VPN server. This call must be performed before any other operations related to the VPN framework APIs.

An **IInspectable** object for socket transport. This object can be a Windows.Networking.StreamSocket, a Windows.Networking.StreamWebSocket, or a Windows.Networking.DatagramSocket. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call. An optional **IInspectable** object for socket transport. This object can be a Windows.Networking.StreamSocket, a Windows.Networking.StreamWebSocket, or a Windows.Networking.DatagramSocket. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data.

Retrieves the slot type (hardware or software) for the specified transport context object.

A transport context object, for example the name of a host or server. A value that indicates a slot type (hardware or software).

Requests a VpnPacketBuffer object from the receive packet buffer pool to be used in the decapsulation or injection of a received packet from the VPN server into the local network stack

The requested packet buffer object.

Retrieves a VpnPacketBuffer object from the send packet buffer pool to use in encapsulation and transmission of a data packet from the client network stack to the VPN server.

The requested packet buffer object.

Writes a diagnostic message to the system log.

The text of the diagnostic message.

Processes any pending VpnChannel events.

The plug-in to be processed.

Replaces an existing transport with a new one for use by the VPN framework as a transport link communicating the VPN plug-in to the VPN server.

An **IInspectable** object for socket transport. This object can be a Windows.Networking.StreamSocket, a Windows.Networking.StreamWebSocket, or a Windows.Networking.DatagramSocket. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call. The transport context object to use, for example the name of a host or server.

Request the VPN platform to collect credentials from the user. The plug-in can specify the type and form of credentials to collect. The result is an object containing the main credentials depending on the type and the secondary credentials for change and expiration cases.

An enum value indicating type of credential to collect. If the request is a retry from as previous failed attempt, it is TRUE; otherwise, it is FALSE. If the credential should be used by all applications operating over the VPN tunnel and authenticating to resources on the VPN, it is TRUE; otherwise, it is FALSE. This provides a single sign on experience over the VPN. The certificate that can be optionally passed to indicate the platform its intention of use and obtain consent and unlock its protection. An object containing the main credentials and any other transitional credentials filled by the user.

Requests the VPN platform to collect credentials of a given credential type from the user.

An enum value indicating the type of credential to collect. An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

Requests the VPN platform to collect credentials from the user. The plug-in can specify the type and form of credentials to collect. The result is an object containing the main credentials depending on the type, and the secondary credentials for change and expiration cases.

An enum value indicating the type of credential to collect. Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on. An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

VPN platform to collect credentials from the user. If user interaction is required to obtain a credential or consent, the platform provides the necessary user interaction. A VPN plug-in must request credentials before using any type of credential, even if the intent is not to invoke user interaction for it.

An enum value indicating the type of credential to collect. Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on. A certificate to be used in validating the credential. An asynchronous retrieval operation on a VpnCredential object containing the main credentials of the requested type, and secondary credentials for change and expiration cases.

Not supported.

Not used.

Requests information from the user by presenting a prompt. Allows the use of prompt elements that can be mixed to construct a full prompt to the user. Input provided by the user is returned to the caller in the objects specified.

A list custom prompt elements. Represents an asynchronous action.

Not supported. Requests a **IVpnPacketBuffer** from the specified pool. There is one **IVpnPacketBuffer** for the send path and another **IVpnPacketBuffer** for the receive path

An enum value indicating which buffer pool to pick a buffer from. If the buffer requested for the packet to be sent to the VPN server, pick the Send enum type. If the buffer requested is for a received L3 decapsulated packet ready to be injected into the client network stack, pick the Receive enum type. A **IVpnPacketBuffer** object returned from the specified buffer pool.

Not supported.

An optional **IInspectable** object for socket transport. The object can be a **Windows.Networking.StreamSocket**, **Windows.Networking.WebStreamSocket** or **Windows.Networking.DatagramSocket**. This socket controls the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. If Transport Security Layer 1.2 should be used, it is TRUE; otherwise, it is FALSE.

Not supported.

The text of the error message.

Creates the VPN channel to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network.

A pointer to an IVectorView< Windows.Networking.HostName *> vector specifying the IPv4 address assigned by the VPN server to the VPN client. The address should be set on the VPN L3 interface. If **null**, DHCPv4 is used. A pointer to a Windows.Networking.HostName structure specifying the IPv6 address assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If **null**, DHCPv6 or RD is used. A pointer to a VpnInterfaceId. A pointer to Windows.Networking.VpnRouteAssignment class that represents the routes which should be associated / not associated with the VPN interface A pointer to Windows.Networking.DomainNameAssignment class that represents the list of name prefixes that are associated to the VPN channel, including its DNS and proxy servers. A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the IVpnPacketBuffers in the Receive pool. A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the *outerTunnelTransport*. This is also the size of the **IVpnPacketBuffers** in the Send pool. A **Boolean** specifying whether the VPN framework should monitor and use low cost networks as they are available. If **TRUE** the VPN framework will invoke the connect() callback to the VPN plug-in to reconnect it whenever the old network was costed and a new low cost network becomes available. An *IInspectable* object for socket transport. The object can be a Windows.Networking.StreamSocket, Windows.Networking.WebStreamSocket or Windows.Networking.DatagramSocket. This socket controls the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. An optional *IInspectable* object for socket transport. The object can be a Windows.Networking.StreamSocket, Windows.Networking.WebStreamSocket or Windows.Networking.DatagramSocket. This socket controls the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data.

Creates the VPN channel to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network.

A pointer to a**Windows.Networking.HostName** structure specifying the IPv4 address assigned by the VPN server to the VPN client. The address should be set on the VPN L3 interface. If null, DHCPv4 is used. A pointer to a **Windows.Networking.HostName** structure specifying the IPv6 address assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv6 or RD is used. A pointer to a **VpnInterfaceId** object. A pointer to a **Windows.Networking.VpnRouteAssignment** class that represents the routes which should be associated / not associated with the VPN interface. A pointer to a **Windows.Networking.DomainNameAssignment** class that represents the list of name prefixes that are associated to the VPN channel, including its DNS and proxy servers. A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the **IVpnPacketBuffers** in the Receive pool. A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the outerTunnelTransport. This is also the size of the **IVpnPacketBuffers** in the Send pool. Reserved.

Reconnect the socket transport. Transport and transport context are the only parameters that can be changed on a socket transport reconnection.

An **IInspectable** object for socket transport. This object can be a Windows.Networking.StreamSocket, a Windows.Networking.StreamWebSocket, or a Windows.Networking.DatagramSocket. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call. The transport context object to use, for example the name of a host or server.

Creates the VPN channel to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network.

A pointer to a **Windows.Networking.HostName** structure specifying the IPv4 address assigned by the VPN server to the VPN client. The address should be set on the VPN L3 interface. If null, DHCPv4 is used. A pointer to a **Windows.Networking.HostName** structure specifying the IPv6 address assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv6 or RD is used. A pointer to a **VpnInterfaceId** object. A pointer to a **Windows.Networking.VpnRouteAssignment ** class that represents the routes which should be associated / not associated with the VPN interface. A pointer to a **Windows.Networking.DomainNameAssignment** class that represents the list of name prefixes that are associated to the VPN channel, including its DNS and proxy servers. A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the **IVpnPacketBuffers** in the Receive pool. A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the outerTunnelTransport. This is also the size of the **IVpnPacketBuffers** in the Send pool. Reserved An **IInspectable** object for socket transport. This object can be a **Windows.Networking.StreamSocket**, a **Windows.Networking.WebStreamSocket**, or a **Windows.NetworkingDatagramSocket**. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call.

Creates the VPN channel for an arbitrary numbers of transports to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network. It allows the specification of traffic filters to use in per-app VPN scenarios.

A list of **Windows.Networking.HostName** objects specifying the IPv4 address(es) assigned by the VPN server to the VPN client. The address(es) should be set on the VPN L3 interface. If null, DHCPv4 is used. A list of **Windows.Networking.HostName** objects specifying the IPv6 address(es) assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv6 or RD is used. A **VpnInterfaceId** object. A **Windows.Networking.VpnRouteAssignment** object that represents the routes that should be associated / not associated with the VPN interface. A **Windows.Networking.DomainNameAssignment** object that represents the list of name prefixes that are associated with the VPN channel, including its DNS and proxy servers. A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the **IVpnPacketBuffers** in the Receive pool. A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the outerTunnelTransport. This is also the size of the **IVpnPacketBuffers** in the Send pool. Reserved. A list of **IInspectable** objects for socket transport. Each can be a **Windows.Networking.StreamSocket**, a **Windows.Networking.WebStreamSocket**, or a **Windows.NetworkingDatagramSocket**. They will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The sockets must be unconnected at the point of the call. A **VpnTrafficFilterAssignment** object, which allows the specification of traffic filters to a VPN channel.

Creates the VPN channel to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network. It allows the specification of traffic filters to use in per-app VPN scenarios.

A list of **Windows.Networking.HostName** objects specifying the IPv4 address(es) assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv4 is used. A list of **Windows.Networking.HostName** objects specifying the IPv6 address(es) assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv6 or RD is used. A **VpnInterfaceId** object. A **Windows.Networking.VpnRouteAssignment** object that represents the routes that should be associated / not associated with the VPN interface. A **Windows.Networking.DomainNameAssignment** object that represents the list of name prefixes that are associated with the VPN channel, including its DNS and proxy servers. A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the **IVpnPacketBuffers** in the Receive pool. A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the outerTunnelTransport. This is also the size of the **IVpnPacketBuffers** in the Send pool. Reserved. An **IInspectable** object for socket transport. This object can be a **Windows.Networking.StreamSocket**, a **Windows.Networking.WebStreamSocket**, or a **Windows.NetworkingDatagramSocket**. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The socket must be unconnected at the point of the call. An optional **IInspectable** object for socket transport. This object can be a **Windows.Networking.StreamSocket**, a **Windows.Networking.WebStreamSocket**, or a **Windows.NetworkingDatagramSocket**. This socket will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. A **VpnTrafficFilterAssignment** object, which allows the specification of traffic filters to a VPN channel.

Destroys a previously established VPN channel object. Disassociates and closes the *outerTunnelTransport* connection to the VPN server.

Allows a VPN plugin to indicate an error message and terminate the connection attempt performed inside the IVpnPlugin.Connect method. Should not be called on reconnect cases.

The text of the error message.

**VpnChannelActivityEventArgs** is not supported and may be altered or unavailable in the future. Instead, use VpnChannelActivityStateChangedArgs.

**VpnChannelActivityEventArgs** is not supported and may be altered or unavailable in the future. Instead, use VpnChannelActivityStateChangedArgs.

Not supported.

Specifies the type of activity events.

Mode in which traffic is currently being sent over the VPN channel.

Mode in which no traffic is being sent over the VPN channel.

Represents the ActivityStateChanged event specifying the new VPN channel state (idle or active).

Gets a value identifying whether the VPN channel is idle or active.

An enum value that indicates whether the VPN channel is idle or active.

The configuration of the VpnChannel, which dictates how to establish the communication with the VPN server.

Gets the custom configuration as a string which the VPN plug-in parses to configure VPN vendor specific settings. The field is a string to allow XML as the data format of the configuration.

The custom configuration string data which the VPN plug-in parses to configure VPN vendor specific settings.

Gets the server hostname of the VPN server to which the VPN plug-in should connect.

The server hostname of the VPN server to which the VPN plug-in should connect.

Gets the service name of the VPN server listening for remote access connections.

The service name of the VPN server listening for remote access connections. Also known as the VPN server port.

Gets the list of URIs that describe the VPN servers to connect to and the URI to use when connecting to them. This is analogous to the ServerHostNames, but are in URI format which allows for more information to be carried per server.

The list of URIs that describe the VPN servers to connect to and the URI to use when connecting to them.

Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on.

None.

Retrying.

Use for single sign on.

Represents the credentials requested and provided by the platform. This class holds username, password, PIN, OTP, and any additional PIN or certificate to which access has been granted.

Gets an additional PIN provided by the user, typically used when requesting a credential type of username, password, and PIN.

An additional PIN provided by the user.

Gets the certificate to which we were granted access for use in the VPN connection.

The certificate to which we were granted access for use in the VPN connection.

Gets the previous credential the user used to log on to the VPN server, as in the case of a password change.

The previous credential the user used to log in to the VPN server.

Gets the current password credential used by the user to log on to the VPN server.

The current password credential used by the user to log in to the VPN server.

Specifies the types of credentials that can be requested by the VPN platform.

Represents a credential type of a protected certificate.

Represents a credential type of smart card.

Represents a credential type of a certificate.

Represents a credential type of username, and a PIN or OTP.

Represents a credential of type Username and Password.

Represents a credential type of username, password, and PIN.

Represents a password change. The current password, new password, and a confirmation of the new password will be collected.

**VpnCustomCheckBox** is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptBooleanInput.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

**VpnCustomComboBox** is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptOptionSelector.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

**VpnCustomEditBox** is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptTextInput.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

**VpnCustomErrorBox** is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptText.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Represents a Boolean type of UI control prompt required from the user. This is typically a checkbox. This is used in the construction of custom prompts used in the VpnChannel.RequestCustomPromptAsync method.

Constructs an object representing the Boolean input UI element to be used in the VpnChannel.RequestCustomPromptAsync method.

Gets or sets whether the user must provide some input in this element before the UI flow can continue (the next button is grayed out).

If the user must provide some input, it is TRUE; otherwise, it is FALSE.

Gets or sets the text label of the input UI element.

The text label of the input UI element.

Gets or sets whether the Boolean input UI element is emphasized or not.

If the input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Gets or sets whether the initial Boolean value displayed to the user is true or false.

The initial Boolean value displayed to the user, TRUE or FALSE.

Gets the value selected by the user.

The value selected by the user.

Represents a multiple choice UI control prompt required from the user. This is typically a combo box. This is used in the construction of custom prompts used in the VpnChannel.RequestCustomPromptAsync method.

Constructs an object representing a multiple choice UI element to be used in the VpnChannel.RequestCustomPrompt method.

Gets or sets whether the user must provide some text input in this element before the UI flow of the can continue (the next button is grayed out).

If the user must provide some text input, it is TRUE; otherwise , it is FALSE.

Gets or sets the text label of the text input UI element.

The text label of the text input UI element.

Gets or sets whether the input UI element is emphasized or not

If the text input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Gets the list of strings that are presented as choices for the multiple choice UI element. The plug-in is expected to retrieve the list, and fill it with the strings needed (in the order that they are to be presented).

The list of strings that are presented as choices for the multiple choice UI element.

Gets the index into the options string vector of the option selected by the user.

The index into the options string vector of the option selected by the user.

Represents a text UI element used in the VpnChannel.RequestCustomPromptAsync method.

Allows VPN plug-ins to specify a text UI element to be used in the RequestCustomPromptAsync method.

Not supported.

If the user must provide some text input, it is TRUE; otherwise , it is FALSE.

Gets or sets the text label of the text input UI element.

The text label of the text input UI element.

Gets or sets whether the text UI element is emphasized.

If the text input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Gets or sets the text typed into the text input UI element.

The text typed into the text input UI element.

Represents a text input UI element used in the RequestCustomPromptAsync method.

Allows VPN plug-ins to create a text input UI element object to be used in the RequestCustomPromptAsync method.

Gets or sets whether the user must provide some text input in this element before the UI flow of the can continue (the next button is grayed out).

If the user must provide some text input, it is TRUE; otherwise , it is FALSE.

Gets or sets the text label of the text input UI element.

The text label of the text input UI element.

Gets or sets whether the text input UI element is emphasized.

If the text input UI element is emphasized, it is TRUE; otherwise , it is FALSE.

Gets or sets whether the text typed into the text input UI element must be hidden by showing different characters. This is typically used when the input is expected to be a password, other text credential, or secret.

If the text typed into the text input UI element must be hidden , it is TRUE; otherwise , it is FALSE.

Gets or sets the text that is displayed as grayed out when the text input UI element does not contain any text typed by the user. This can be sample text.

Sample text that is displayed as grayed out when the text input UI element does not contain any text typed by the user.

Gets the text typed into the text input UI element.

The text typed into the text input UI element.

**VpnCustomTextBox** is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptText.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

**VpnDataPathType** is not supported and may be altered or unavailable in the future.

Not supported.

Not supported.

Contains VPN domain name policies, like name resolution, namespace configuration, and web proxies.

Allows the plugin to construct a VpnDomainNameAssignment object to create name resolution policy, and assign it to the VPN channel.

Gets a list of name resolution rule policies.

A list of name resolution rule policies.

Gets or sets the location of the global AutoConfigURL script in the corporate network. [This is an optional property.]

The location of the global AutoConfigURL script in the corporate network. [This is an optional property.]

Specifies the name policy for a specific namespace. It can specify the DNS servers to use for name resolution of the namespace, the web proxies to use when connecting to the namespace, or whether it should be exempted from the policy itself.

Allows the VPN plug-in to construct this object to be added to a VpnDomainNameAssignment object.

The domain name. This could be an FQDN, or a DNS suffix. An enum value indicating whether the namespace in question is a FQDN, or a DNS suffix. A list of DNS servers to perform DNS resolution against when resolving a name in the namespace. A list of web proxy servers to be used when connecting to a resource in the specified namespace.

Gets a list of DNS servers to perform DNS resolution against when resolving a name in the namespace.

A list of DNS servers to perform DNS resolution against when resolving a name in the namespace.

Gets or sets the domain name. This could be an FQDN, or a DNS suffix.

The domain name. This could be an FQDN, or a DNS suffix.

Gets or sets whether the namespace in question is a FQDN, or a DNS suffix.

An enum value indicating whether the namespace in question is a FQDN, or a DNS suffix.

Gets a list of web proxy servers to be used when connecting to a resource in the specified namespace.

A list of web proxy servers to be used when connecting to a resource in the specified namespace.

Gets a web proxy URI to be used when connecting to a resource in the specified namespace. This value differs from WebProxyServers in that the URI can be specify a custom port number, while the WebProxyServers value assumes port 80.

A list of web proxy server URIs to be used when connecting to a resource in the specified namespace.

Describes whether a name is a domain name suffix or a fully qualified domain name.

Fully qualified domain name (FQDN)

Reserved

Domain name suffix

Represents an interface ID used in the construction and assignment of an IPv6 address to the VPN interface. The ID contained in this class fills the interface ID portion of the IPv6 address.

Allows the VPN plug-in to construct this object and use it in the VpnChannel.Start method.

The address represented as a set of bytes.

Gets the address represented as the set of bytes to be used as the interface ID.

The address represented as the set of bytes.

Defines constants that specify IP protocols (numeric values).

Internet Control Message Protocol (ICMP)

Internet Group Management Protocol (IGMP)

Internet Protocol version 6 (IPv6) Internet Control Message Protocol (ICMP)

Specifies no protocol.

Pragmatic General Multicast (PGM)

Transmission Control Protocol (TCP)

User Datagram Protocol (UDP)

Allows the creation, deletion, edit, connect, and disconnect flows for VPN. These can be used to manage the lifecycle of a VPN profile, and to create a custom VPN connection manager.

Constructor to allows VPN app to create this object.

Creates a new VPN Profile based on the **VpnProfile** input object.

A **VpnProfile** object. An enum value indicating the error status.

Creates a new VPN connection based on a ProfileXML-encoded string (see ProfileXML XSD ).

A **VpnProfile** object. An enum value indicating the error status.

Connects to an existing VPN profile.

A **VpnProfile** object. An enum value indicating the error status.

Connects to a VPN profile using a specified set of password credentials.

A **VpnProfile** object. The current password used by the user to log on to the VPN server. An enum value indicating the error status.

Deletes an existing VPN profile.

A **VpnProfile** object. An enum value indicating the error status.

Disconnects from a connected VPN profile.

A **VpnProfile** object. An enum value indicating the error status.

Gets the accessible list of present VPN profiles.

A list of present VPN profiles.

Updates a VPN profile based on an input object.

A **VpnProfile** object. An enum value indicating the error status.

Updates an existing VPN profile based on an input WAP XML string.

A Wireless Application Protocol (WAP) XML string. An enum value indicating the error status.

Values used to report the current status of a VPN profile.

The profile is connected.

The profile is in the process of connecting.

The profile is disconnected.

The profile is in the process of disconnecting.

Describes the known VPN management errors.

Access is denied.

The connection already exists.

The connection is in the process of being disconnected.

A specified profile cannot be found.

Certificate authentication has failed.

A given hostname was not resolvable through the available DNS.

EAP authentication has failed.

Connection failed during authentication. No further details available.

A given IP address was invalid.

Invalid XML syntax

No internet connection is available.

No error.

Other

The app id is invalid.

The profile name is too long.

The server configuration is invalid.

Can't connect to the server.

Smart Card authentication has failed.

User name/password authentication has failed.

**VpnNamespaceAssignment** is not supported and may be altered or unavailable in the future. Instead, use VpnDomainNameAssignment.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

**VpnNamespaceInfo** is not supported and may be altered or unavailable in the future. Instead, use VpnDomainNameInfo.

Not supported.

A list of DNS servers to perform DNS resolution against when resolving a name in the namespace. A list of DNS servers to perform DNS resolution against when resolving a name in the namespace. A list of web proxy servers to be used when connecting to a resource in the specified namespace.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Represents a profile for an OS Native/Inbox VPN protocol.

Allows a VPN management app to create a native VPN profile.

Gets or sets a value that indicates whether the profile is for Always On VPN.

`true` if the VPN profile is always connected, otherwise `false`.

Gets a list of apps that can trigger the Inbox VPN profile.

A list of apps that can trigger the Inbox VPN profile.

Gets the current connection status.

An enumeration value giving current connection status.

Gets a list of domain name policies to be used for the profile.

A list of domain name policies to be used for the profile.

Gets or sets the EAP Authentication configuration for an Inbox/Native VPN profile.

The EAP Authentication configuration for an Inbox/Native VPN profile.

Gets or sets the tunnel protocol type for the Inbox VPN connection.

An enum value indicating tunnel protocol type for the Inbox VPN connection.

Gets or sets the profile name for the Inbox/Native VPN profile.

The profile name for the Inbox/Native VPN profile.

Gets or sets whether the credentials for the VPN profile will be cached. If TRUE, the credentials for the VPN profile will be cached where applicable.

If the credentials for the VPN profile will be cached, it is TRUE; otherwise , it is FALSE.

Gets or sets a value that determines whether this VPN profile appears in the system's VPN connection UI.

When true, this profile should appear in the system VPN connection user interface. By default, this value is **false**.

Gets a list of routes that should go over the VPN interface in the case of a Split Tunneled VPN.

A list of routes that should go over the VPN interface in the case of a Split Tunneled VPN.

Gets or sets whether the apps allowed by this traffic filter are force tunneled through the VPN interface, or whether they are split tunneled and allowed to talk through other interfaces.

An enum value indicating whether a VPN profile is Split Tunneled or Force Tunneled.

Gets a list of VPN servers for the Inbox VPN profile.

A list of VPN servers for the Inbox VPN profile.

Gets a list of Traffic Filters (including per App) included in the VPN profile.

A list of Traffic Filters (including per App) included in the VPN profile.

Gets or sets the authentication method to be used in the tunnel layer of the native VPN protocol.

An enum value indicating authentication method to be used in the tunnel layer of the native VPN protocol.

Gets or sets the authentication method to be used to authenticate the user.

An enum value indicating authentication method to be used to authenticate the user.

Specifies the native protocol types.

Internet Protocol Security Internet Key Exchange v2 (IPsec IKEv2)

Layer 2 Tunneling Protocol (L2TP)

Point-to-Point Tunneling Protocol (PPTP)

Used by the platform to manage a memory buffer. **VpnPacketBuffer** allows buffers to be chained together in a **IVpnPacketBufferList** object list to be sent or received in a specific order.

Not used.

A pointer to the parent buffer in the chain. Offset value. The size of the buffer.

Gets the app ID representing the app that caused this packet to flow. This is present only on the first packet of a flow. The presence of this property indicates it is the first packet.

The app ID representing the app that caused this packet to flow.

Gets the memory buffer object, designed to contain packets of date to be sent or received as part of a **IVpnPacketBufferList**.

The memory buffer object.

Gets the status of **VpnPacketBuffer**. The status property may be used to report errors when manipulating the **IVpnPacketBufferList.**

An enum value indicating the status of a **VpnPacketBuffer** object.

Gets or sets a number specifying which transport object to use as specified in the VpnChannel:Start* methods. This allows the selection between the main and the optional transports.

A value of 0 sets this packet to be sent over the main transport. A value of 1 sets this packet to be sent over the optional transport.

Gets or sets a transport context object, for example the name of a host or server.

A transport context object, for example the name of a host or server.

Used to manage **VpnPacketBuffer** objects.

Gets the number of **IVpnPacketBuffer** objects in the **IVpnPacketBufferList** object.

Number of **IVpnPacketBuffer** objects.

Gets the status of **VpnPacketBuffer**. The status property may be used to report errors when manipulating the **IVpnPacketBufferList.**

An enum value indicating the status of a **VpnPacketBuffer** object. The default value is 0, indicating there are no errors.

Add a new **IVpnPacketBuffer** object to the start of the **IVpnPacketBufferList**.

The new **IVpnPacketBuffer** object to add to the **IVpnPacketBufferList** object.

Add a new **IVpnPacketBuffer** object to the end of the **IVpnPacketBufferList**.

The new **IVpnPacketBuffer** object to add to the **IVpnPacketBufferList** object.

Removes all the **IVpnPacketBuffer** objects from a **IVpnPacketBufferList**.

Provides access to the First parameter. This SDK programming element is introduced in Windows PowerShell 3.0.

Returns **IVpnPacketBuffer**.

Remove the **IVpnPacketBuffer** object at the start of the **IVpnPacketBufferList**.

The **IVpnPacketBuffer** object which was at the start of the **IVpnPacketBufferList**.

Remove the **IVpnPacketBuffer** object at the end of the **IVpnPacketBufferList**.

The **IVpnPacketBuffer** object which was at the end of the **IVpnPacketBufferList**.

Defines constants that specify the possible states of the VPN packet buffer.

Specifies an invalid buffer size.

Specifies that the state is ok.

**VpnPickedCredential** is not supported and may be altered or unavailable in the future. Instead, use VpnCredential.

Not supported. Use VpnCredential instead.

Not supported.

Not supported. Use VpnCredential instead.

Not supported.

Not supported. Use VpnCredential instead.

Not supported.

Represents a VPN plug-in profile.

Allows VPN management apps to create, edit, and manage, VPN profiles for VPN plug-ins.

Gets or sets the AlwayOn property. If true, indicates that the VPN profile is always connected.

If the VPN profile is an AlwaysOn profile, it is TRUE; otherwise , it is FALSE.

Gets a list of apps that will trigger the VPN connection to connect.

A list of apps that will trigger the VPN connection to connect.

Gets the current connection status.

An enumeration value giving current connection status.

Gets or sets an XML string to configure the VPN plug-in. Refer to the documentation from the VPN plug-in for format and support.

A string representing the XML to configure the VPN plug-in.

Gets a list of Name Resolution Policy Table (NRPT) rules for the VPN plug-in profile.

A list of Name Resolution Policy Table (NRPT) rules for the VPN plug-in profile.

Gets or sets the name of the VPN profile.

The name of the VPN profile.

Gets or sets whether the credentials for the VPN profile will be cached. If TRUE, the credentials for the VPN profile will be cached where applicable.

If the credentials for the VPN profile will be cached, it is TRUE; otherwise , it is FALSE.

Gets or sets a value that determines whether this VPN profile appears in the system's VPN connection UI.

When true, this profile should appear in the system VPN connection user interface. By default, this value is **false**.

Gets a list of routes that must go over the VPN interface in the case of a Split Tunneled VPN.

A list of routes that must go over the VPN interface in the case of a Split Tunneled VPN.

Gets a list of server URIs to connect to for the VPN profile.

A list of server URIs to connect to for the VPN profile.

Gets a list of Traffic Filters (including per App) included in the VPN profile.

A list of Traffic Filters (including per App) included in the VPN profile.

Gets or sets the package family name of the VPN plug-in to be used for this VPN plug-in profile.

The package family name of the VPN plug-in to be used for this VPN plug-in profile.

Represents a route relative to the VPN channel. It is composed of an address and a prefix size to identify the subnet being routed. The route can then be either included or excluded from the VPN channel scope.

Constructs a VpnRoute object.

The ID or the address of the subnet under the route control. The size (in bits) to be considered by the subnet.

Gets or sets the ID or the address of the subnet under the route control.

The ID or the address of the subnet under the route control.

Gets or sets the size (in bits) to be considered by the subnet..

The size (in bits) to be considered by the subnet.

Represents the list of routes assigned to the VPN channel for the correct flow and redirection of traffic.

Allows a VPN plug-in to create the set of routing traffic policy to be set on a VPN channel.

Gets or sets whether the physical infrastructure network, such as the local subnet, should always be exempted from flowing over the VPN interface.

If local subnets are excluded, it is **TRUE**; otherwise , it is **FALSE**.

Gets or sets a list of IPv4 routes that should not sent traffic over the VPN interface.

A list of IPv4 routes that should not sent traffic over the VPN interface.

Gets or sets a list of IPv4 routes that should send traffic over the VPN interface.

A list of IPv4 routes that should send traffic over the VPN interface.

Gets or sets a list of IPv6 routes that should not sent traffic over the VPN interface.

The list of IPv6 routes that should not sent traffic over the VPN interface.

Gets or sets a list of IPv6 routes that should always sent traffic over the VPN interface.

The list of IPv6 routes that should always sent traffic over the VPN interface.

Specifies the routing policy type.

Apps are force tunneled through the VPN interface.

Apps are split tunneled and allowed to talk through other interfaces.

Allows access to the security health of the system device.

Gets the RFC compliant blob representing the Statement of Health. This can be used to send directly in any of the network protocols embedding a RFC compliant statement of health.

The RFC compliant blob representing the Statement of Health.

Defines the traffic filtering properties (including per app VPN). A description of the type of network traffic that will be allowed over the VPN connection, such as a specific application and protocol allowed for the connection.

Allows a VPN plug-in or VPN management app to create a traffic filter.

The app ID associated with the new traffic filter.

Gets a security descriptor specifying the set of checks of claims a process must have to be allowed by this traffic filter.

A security descriptor specifying the set of checks of claims a process must have to be allowed by this traffic filter.

Gets or sets the ID of the app that is allowed by this traffic filter.

The ID of the app that is allowed by this traffic filter.

Gets a list of the local address ranges that are allowed by this traffic filter.

A list of the local address ranges that are allowed by this traffic filter.

Gets a list of the local port ranges that are allowed by this traffic filter. Specially useful for identifying SMB.

A list of the local port ranges that are allowed by this traffic filter. Specifically useful for identifying SMB.

Gets or sets the IP protocol that is allowed by this traffic filter.

An enum value indicating which IP protocol is allowed by this traffic filter.

Gets a list of the remote address ranges that are allowed by this traffic filter.

A list of the remote address ranges that are allowed by this traffic filter.

Gets a list of the remote port ranges that are allowed by this traffic filter.

A list of the remote port ranges that are allowed by this traffic filter.

Gets or sets whether the apps allowed by this traffic filter are force tunneled through the VPN interface, or whether they are split tunneled and allowed to talk through other interfaces.

An enum value indicating the routing policy.

Allows the specification of a set of traffic filters as policy to a VPN channel.

Allows a VPN plug-in to create a traffic filter policy assignment for the VPN channel.

Gets or sets whether inbound traffic is allowed or not.

If inbound traffic is allowed, it is **TRUE**; otherwise , it is **FALSE**.

Gets or sets whether outbound traffic is allowed or not.

If outbound traffic is allowed, it is **TRUE**; otherwise , it is **FALSE**.

Gets a list of traffic filters composing the traffic filter policy to assign to a VPN channel.

The list of traffic filters composing the traffic filter policy to assign to a VPN channel.

Represents a particular prediction of the future, or a snapshot of the past.

For timestamps about the future, gets the span of time between when the prediction was made and TargetTime.

The prediction duration.

Gets the specific time that is the subject of this timestamp, represented in the system-relative QueryPerformanceCounter (QPC) time domain.

The system-relative QPC time.

Gets the specific time that is the subject of this timestamp.

The time.

Static methods for working with PerceptionTimestamp objects.

Gets a timestamp that targets the specified time in the past.

The moment in the past to target with the timestamp. The timestamp.

Gets a timestamp that targets the specified system-relative time, represented in the system-relative QueryPerformanceCounter (QPC) time domain.

The system-relative moment in QPC time to target with the timestamp. The timestamp.

Represents the user's eye gaze in relation to their surroundings.

Gets the user's eye gaze in the specified coordinate system.

The eye gaze, if calibration is valid for the current user and their eyes are currently detected; otherwise, null.

Gets whether eye gaze has been calibrated for the current user in the headset.

Whether eye gaze has been calibrated for the current user.

Gets the timestamp at which this eye gaze snapshot was taken.

The timestamp.

Gets whether eye gaze is supported by the current headset.

Whether eye gaze is supported.

Requests access for an app to use spatial eye gaze. This requires the **gazeInput** capability.

Operation that triggers once the user has completed any consent dialog, providing the access status.

Specifies a joint within the user's hand.

The third knuckle that poses the index finger's distal phalanx.

The second knuckle that poses the index finger's intermediate phalanx.

The joint in the base of the hand that poses the index finger's metacarpal bone.

The first knuckle that poses the index finger's proximal phalanx.

The point on the surface of the index finger at the tip.

The third knuckle that poses the little finger's (pinky's) distal phalanx.

The second knuckle that poses the little finger's (pinky's) intermediate phalanx.

The joint in the base of hand that poses the little finger's (pinky's) metacarpal bone.

The first knuckle that poses the little finger's (pinky's) proximal phalanx.

The point on the surface of the little finger's (pinky's) at the tip.

The third knuckle that poses the middle finger's distal phalanx.

The second knuckle that poses the middle finger's intermediate phalanx.

The joint in the base of the hand that poses the middle finger's metacarpal bone.

The first knuckle that poses the middle finger's proximal phalanx.

The point on the surface of the middle finger at the tip.

The center of the palm.

The third knuckle that poses the ring finger's distal phalanx.

The second knuckle that poses the ring finger's intermediate phalanx.

The joint in the base of hand that poses the ring finger's metacarpal bone.

The first knuckle that poses the ring finger's proximal phalanx.

The point on the surface of the ring finger at the tip.

The second knuckle that poses the thumb's distal phalanx.

The joint in the base of the hand that poses the thumb's metacarpal bone.

The first knuckle that poses the thumb's proximal phalanx.

The point on the surface of the thumb at the tip.

The center of the wrist.

Provides mesh updates each frame that track the detected shape of a hand.

Gets a hand mesh model ID to identify the same index buffer across multiple source detection and loss events.

The hand mesh model ID.

Gets the current neutral HandPose for this hand.

The neutral hand pose.

Gets the version of the NeutralPose for this hand.

The neutral hand pose version.

The SpatialInteractionSource whose hand mesh is tracked by this HandMeshObserver.

The source.

Gets the number of elements in the index buffer for this hand mesh model.

The index buffer size.

Gets the count of vertices for this hand.

The count of vertices for this hand.

Fills an index buffer for this hand mesh model.

The index buffer to fill.

Gets the vertex buffer and other state needed to render the hand mesh for a given frame's hand pose, or for the hand mesh's neutral pose.

The hand pose for which to get the vertex state. The vertex state.

Represents an individual vertex in a hand mesh vertex buffer.

The normal of the vertex.

The position of the vertex.

Represents the vertex buffer and other state needed to render the hand mesh.

Gets the coordinate system within which this frame's vertex positions and normals are expressed.

The coordinate system.

Gets the timestamp at which the vertex positions and normals were last updated.

The update timestamp.

Fills a vertex buffer for this hand mesh model.

The vertex buffer to fill.

Represents the poses of the user's hand joints in relation to their surroundings.

Gets the pose of a hand joint, expressed relative to a reference joint.

The hand joint kind to locate. The reference hand joint kind, relative to which the joint will be located. The relative pose of the joint.

Gets the pose of multiple hand joints, each expressed relative to its matching reference joint.

The array of hand joint kinds to locate. The array of reference hand joint kinds, relative to which each matching joint in the *joints* array will be located. The array of relative poses to fill, one for each matching element in the *joints* and *referenceJoints* arrays.

Gets the pose of a hand joint, expressed in the specified coordinate system.

The coordinate system in which to express the joint pose. The hand joint kind to locate. The pose to fill for the specified joint. True if the hand can be located within the specified coordinate system; otherwise, false.

Gets the pose of multiple hand joints, expressed in the specified coordinate system.

The coordinate system in which to express the joint poses. The array of hand joint kinds to locate. The array of poses to fill, one for each matching element in the joints array. True if the hand can be located within the specified coordinate system; otherwise, false.

Represents the user's head gaze in relation to their surroundings.

Gets the forward direction of the user's head gaze in the specified coordinate system, as a unit vector.

The forward direction unit vector.

Gets the position of the user's head in the specified coordinate system.

The position.

Gets the up direction that orients the user's head gaze in the specified coordinate system, as a unit vector.

The up direction unit vector.

The pose of a hand joint.

The accuracy of this joint pose.

The joint's orientation, with forward (-z) pointing towards the tip of each finger, up (+y) pointing out of the back of the hand or finger, and right (+x) pointing perpendicular to forward and up.

The joint's position. All joints except for tip joints are interior to the hand. Finger joint poses represent the base of the named bone.

The distance from the joint position to the surface of the hand.

Specifies the accuracy of a hand joint's position and orientation.

The hand joint is only being tracked approximately, perhaps due to occlusion.

The hand joint is being tracked at its nominal accuracy.

Represents a coordinate system that is strongly anchored to a point in the user's surroundings.

Gets the coordinate system of the anchor, with easing adjustments applied.

The eased coordinate system.

Gets the coordinate system of the anchor, without easing applied.

The raw coordinate system.

Gets a value indicating whether the persisted anchor was removed by the user.

**True**, if the anchor was removed; otherwise, **false**.

Occurs when the device adjusts the anchor's precise location, which updates the RawCoordinateSystem.

Creates an anchor at the origin of the specified coordinate system.

The reference SpatialCoordinateSystem object. The new anchor, if the creation attempt is successful; otherwise, null.

Creates an anchor at a specific position within the specified coordinate system.

The reference SpatialCoordinateSystem object. A point specified relative to the coordinate system of the source SpatialCoordinateSystem object. The new anchor, if the creation attempt is successful; otherwise, null.

Creates an anchor at a specific position and orientation within the specified coordinate system.

The reference SpatialCoordinateSystem object. A point specified relative to the coordinate system of the source SpatialCoordinateSystem object. A rotation specified relative to the coordinate system of the source SpatialCoordinateSystem object. The orientation of the created anchor's coordinate system is offset by this rotation relative to the source coordinate system. The new anchor, if the creation attempt is successful; otherwise, null.

Allows apps to export spatial anchors for sharing and relocalization across devices, so that both devices can reason about the same locations in their users' surroundings.

Returns information about whether a spatial anchor's data is sufficient for sharing or relocalization.

The spatial anchor that will be exported. The purpose of the export, sharing or relocalization. The anchor's export sufficiency.

Gets the default **SpatialAnchorExporter** instance for the current device.

The exporter.

Requests access for an app to export spatial anchors. This requires the **spatialPerception** capability.

Operation that triggers once the user has completed any consent dialog, providing the access status.

Exports a spatial anchor to a stream for sharing or relocalization. This allows multiple devices to reason about the same locations in their users' surroundings.

The spatial anchor to export. The purpose of the export, sharing or relocalization. The stream to export the anchor to. Operation that triggers once the export has been attempted, providing true if the export succeeded; otherwise, false.

Specifies the purpose of a given spatial anchor export, sharing or relocalization.

This export is to relocalize an existing spatial anchor.

This export is to share a new spatial anchor.

Represents information about whether a spatial anchor's data is sufficient for sharing or relocalization.

Gets whether the spatial anchor has gathered enough data to successfully export for the specified purpose.

Whether the export will succeed.

Gets the SufficiencyLevel value that is ideal for an export for the specified purpose.

The ideal sufficiency level.

Gets the amount of data the spatial anchor has gathered relative to the minimal amount needed to successfully export for the specified purpose.

The amount of data gathered for this export.

Static methods for getting the spatial anchor store for the current app.

Retrieves the anchor store for the current app.

The anchor store.

Provides data for the SpatialAnchor.RawCoordinateSystemAdjusted event.

Gets a transform representing the adjustment of this SpatialAnchor relative to its previous location.

The transform.

Represents a collection of SpatialAnchor objects stored by Windows on behalf of an app.

Clears all anchors in the app's anchor store.

Gets a map of all anchors saved in the store, with their identifiers as the keys.

The map of anchors.

Removes a specific anchor from the store. The anchor is specified by its identifier.

The identifier of the anchor to remove.

Persists an anchor to the store.

An identifier for the anchor. The identifier must be unique within your app. The anchor to save. True, if the save succeeded; otherwise, false.

Static methods for transferring spatial anchors between devices, so that both devices can reason about the same locations in their users' surroundings.

Use SpatialEntityStore instead of SpatialAnchorTransferManager. For more info, see MSDN.

Requests access for an app to export or import spatial anchors. This requires the spatialPerception capability.

Use SpatialEntityStore instead of SpatialAnchorTransferManager. For more info, see MSDN. Operation that triggers once the user has completed any consent dialog, providing the access status.

Exports spatial anchors to a stream, which can later be imported on another device. This allows both devices to reason about the same locations in their users' surroundings.

Use SpatialEntityStore instead of SpatialAnchorTransferManager. For more info, see MSDN. The collection of anchors to export, each identified by an app-specified string key. The stream to export anchors to. Operation that triggers once the export is complete.

Imports a stream of spatial anchors that was previously exported from another device. This allows both devices to reason about the same locations in their users' surroundings.

Use SpatialEntityStore instead of SpatialAnchorTransferManager. For more info, see MSDN. The stream to import anchors from. The operation that triggers once the import is complete, providing the imported anchors.

An axis-aligned bounding box in the user's surroundings, with coordinates expressed in meters.

The position of the center of the bounding box.

The distance from the center of the bounding box to its edges, along each axis.

A bounding frustum in the user's surroundings defined as a set of 6 planes, with coordinates expressed in meters.

The bottom Plane defines the boundary for the bottommost content within the frustum.

The far Plane defines the boundary for the farthest content within the frustum.

The left Plane defines the boundary for the leftmost content within the frustum.

The near Plane defines the boundary for the closest content within the frustum.

The right Plane defines the boundary for the rightmost content within the frustum.

The top Plane defines the boundary for the topmost content within the frustum.

An oriented bounding box in the user's surroundings, with coordinates expressed in meters.

The position of the center of the bounding box.

The size of the bounding box along each axis, prior to rotation.

The rotation of the bounding box, relative to the coordinate system's axes.

A bounding sphere in the user's surroundings, with coordinates expressed in meters.

The position of the center of the sphere.

The radius of the sphere.

Represents a bounding volume of some kind in the user's surroundings, for example, a box, oriented box, sphere or frustum.

Creates a bounding volume from the specified box, with its coordinates interpreted within the specified coordinate system.

The coordinate system within which to interpret the bounding box's coordinates. The bounding box. The new bounding volume.

Creates a bounding volume from the specified frustum, with its coordinates interpreted within the specified coordinate system.

The coordinate system within which to interpret the bounding frustum's coordinates. The bounding frustum. The new bounding volume.

Creates a bounding volume from the specified oriented box, with its coordinates interpreted within the specified coordinate system.

The coordinate system within which to interpret the bounding box's coordinates. The oriented bounding box. The new bounding volume.

Creates a bounding volume from the specified sphere, with its coordinates interpreted within the specified coordinate system.

The coordinate system within which to interpret the bounding sphere's coordinates. The bounding sphere. The new bounding volume.

Represents a coordinate system used to reason about the user's surroundings.

Provides a transform matrix that you can use to convert geometry expressed in one coordinate system to another coordinate system.

The target coordinate system that you want to transform geometry to. If the transformation is successful, this parameter returns the Matrix4x4 structure that you can use to transform geometry from being represented in the source SpatialCoordinateSystem to the specified target coordinate system.

Represents a physical location in the user's surroundings and its metadata, which an app intends to share with other devices.

Creates a new spatial entity to share the provided spatial anchor.

The spatial anchor to share.

Creates a new spatial entity to share the provided spatial anchor and metadata.

The spatial anchor to share. The metadata to share for this anchor.

Gets the spatial anchor representing the shared location in the user's surroundings.

The anchor.

Gets the globally-unique ID for this spatial entity.

The ID.

Gets the key/value store of metadata for this spatial entity.

The metadata.

Event data for spatial entity added events.

Gets the spatial entity that was added.

The added entity.

Event data for spatial entity removed events.

Gets the spatial entity that was removed.

The removed entity.

Represents a shared pool of spatial entities, synchronized automatically among the participants in a remote session.

Gets whether spatial entity sharing is supported on this system.

Whether spatial entity sharing is supported on this system.

Gets a watcher that lets an app observe when participants add, update or remove entities in the store.

The entity watcher.

Removes a spatial entity from the store for all participants.

The spatial entity to remove. Action that triggers once the entity removal has been communicated to the host.

Saves a new or updated spatial entity into the store, to be synchronized with all participants.

The new or updated spatial entity. Action that triggers once the entity data has been communicated to the host.

Establishes or retrieves an automatically-synchronized pool of spatial entities for a remote session.

The remote session with the participants that will share spatial entities. The spatial entity store.

Event data for spatial entity updated events.

Gets the spatial entity that was updated.

The updated entity.

Monitors changes to the set of entities that participants add, update, or remove within a spatial entity store, and provides notifications when that set changes.

Gets the operational status of the spatial entity watcher.

The status.

The event that is raised when a new spatial entity is added to the store by a participant.

The event that is raised when the initial replay of prior changes to the spatial entity store has completed.

The event that is raised when a spatial entity is removed from the store by a participant.

The event that is raised when an existing spatial entity has its metadata updated by a participant.

Starts watching for changes to the set of spatial entities in the store.

Stops watching for changes to the set of spatial entities in the store.

Describes the state of a SpatialEntityWatcher object.

The watcher has aborted operation. No subsequent events will be raised.

This is the initial state of a Watcher object. During this state clients can register event handlers.

The watcher has completed enumerating the initial collection. Items can still be added, updated or removed from the collection.

The watcher transitions to the Started state once Start is called. The watcher is enumerating the initial collection. Note that during this enumeration phase it is possible to receive Updated and Removed notifications but only to items that have already been Added.

The client has called Stop and the watcher has completed all outstanding events. No further events will be raised.

The client has called Stop and the watcher is still in the process of stopping. Events may still be raised.

Indicates the lifecycle state of the device's spatial location system. This lets an app know whether it can reason about the device's orientation or its position in the user's surroundings.

The device is reporting its orientation, and has not been asked to report its position in the user's surroundings.

The device is reporting its orientation, and is preparing to locate its position in the user's surroundings.

The device is reporting its orientation and position in the user's surroundings.

The device is reporting its orientation, but cannot locate its position in the user's surroundings due to external factors, like lighting conditions.

The device's spatial location system is not available.

Represents the location of the device in the user's surroundings at a point in time.

Gets the absolute angular acceleration of the device in a clamped quaternion representation of the rotation per second squared. This acceleration is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The angular acceleration as a clamped quaternion.

Gets the absolute angular acceleration of the device in an axis-angle representation in units of radians per second squared. This acceleration is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The angular acceleration as an axis-angle.

Gets the absolute angular velocity of the device in a clamped quaternion representation of the rotation per second. This velocity is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The angular velocity as a clamped quaternion.

Gets the absolute angular velocity of the device in an axis-angle representation in units of radians per second. This velocity is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The angular velocity as an axis-angle.

Gets the absolute acceleration vector of the device in units of meters per second squared. This acceleration is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The acceleration.

Gets the absolute velocity vector of the device in units of meters per second. This velocity is expressed in the supplied coordinate system, although the motion is measured relative to the user's surroundings.

The velocity.

Gets the orientation of the device within the supplied coordinate system.

The orientation.

Gets the position of the device within the supplied coordinate system.

The position.

Provides access to the location of a device that's tracked relative to the user's surroundings, such as a HoloLens or other Mixed Reality headset.

Gets the current state of the device's spatial location system.

The locatability.

Occurs when the state of the spatial location system changes.

Occurs when the device's spatial location system is deactivating due to inactivity.

Creates a frame of reference that's positionally attached to this SpatialLocator with the current orientation as its fixed heading.

The locator-attached frame of reference.

Creates a frame of reference that's positionally attached to this SpatialLocator with the current orientation as its fixed heading and with its origin offset by the specified relative position.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The locator-attached frame of reference.

Creates a frame of reference that's positionally attached to this SpatialLocator with the current orientation as its fixed heading and with its origin offset and rotated by the specified relative position and orientation.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The rotation of the origin of the frame of reference, relative to the direction of the heading. The locator-attached frame of reference.

Creates a frame of reference that's positionally attached to this SpatialLocator with the supplied heading in radians relative to the current orientation and with its origin offset by the specified relative position and orientation.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The rotation of the origin of the frame of reference, relative to the direction of the heading. The amount to rotate the fixed heading from the SpatialLocator's current orientation, in radians. The locator-attached frame of reference.

Creates a frame of reference that remains stationary relative to the user's surroundings, with its initial origin at the SpatialLocator's current location.

The stationary frame of reference.

Creates a frame of reference that remains stationary relative to the user's surroundings, with its initial origin at the specified offset from the SpatialLocator's current location.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The stationary frame of reference.

Creates a frame of reference that remains stationary relative to the user's surroundings, with its initial origin at the specified offset from the SpatialLocator's current location, and then rotated at the specified rotation.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The rotation of the origin of the frame of reference, relative to the orientation of the SpatialLocator. The stationary frame of reference.

Creates a frame of reference that remains stationary relative to the user's surroundings, with its initial origin at the specified offset from the SpatialLocator's current location along the specified relative heading in radians, and then rotated at the specified rotation.

The positional offset of the origin of the frame of reference, expressed within its coordinate system. The rotation of the origin of the frame of reference, relative to the direction of the heading. The amount to rotate the fixed heading from the SpatialLocator's current orientation, in radians, before the positional offset. The stationary frame of reference.

Gets the SpatialLocator instance that tracks the location of the current device, such as a HoloLens, relative to the user's surroundings.

The spatial locator.

Returns a SpatialLocation representing the device's location at the specified timestamp. The coordinates within are expressed relative to the supplied coordinate system. If the device cannot be located in that coordinate system at the specified timestamp, the return value will be null. This can happen when the device has lost tracking, for example.

The timestamp at which to locate the device. The coordinate system in which to express the location's coordinates. The location.

Represents a frame of reference that is positionally attached to the device.

Gets or sets the orientation of this frame of reference's origin relative to the direction of the heading.

The orientation.

Gets or sets the position of this frame of reference's origin relative to the SpatialLocator that it is tracking.

The offset.

Adjusts the fixed heading of this frame of reference relative to its current heading.

The amount to change the heading, in radians.

Gets a coordinate system whose origin is the position of the device at the specified timestamp, oriented at this frame of reference's fixed heading. This coordinate system stays stationary and does not track any further movement of the device.

The timestamp to compute the coordinate system for. The coordinate system that corresponds with the timestamp.

Computes the device's heading in radians for the specified timestamp, relative to this frame's fixed heading.

The timestamp to compute the relative heading for. The relative heading in radians that corresponds with the timestamp, or null if it is not available for the specified time.

Provides data for the SpatialLocator.PositionalTrackingDeactivating event.

Gets or sets a value indicating whether to cancel the deactivation of positional tracking due to inactivity.

A boolean value indicating whether to cancel the deactivation of positional tracking due to inactivity.

The extent to which the user can look around with their headset.

The user will generally be looking forward as defined by the CoordinateSystem property.

The user may look in any direction.

The extent to which the user can move while wearing their headset.

The user can walk around within the bounds returned by TryGetMovementBounds.

The user can stand but has not defined a boundary within which they intend to walk while using the headset.

This enumeration describes an app's ability to see the user's surroundings in ways that require the spatialPerception capability. This includes use of either SpatialSurfaceObserver or SpatialAnchorTransferManager.

The user has allowed the app to use this spatial perception functionality.

The system has denied the app use of this spatial perception functionality.

The user has denied the app use of this spatial perception functionality.

The user has not yet decided whether the app can use this spatial perception functionality.

A ray in the user's surroundings, with coordinates expressed in meters.

The unit vector pointing in the direction of the ray.

The origin of the ray.

Represents a spatial stage, defined by the user to establish the physical space in which they intend to use a Mixed Reality headset.

Gets a floor-level coordinate system located at the stage origin defined by the user.

The coordinate system.

Gets the current spatial stage, if one has been defined by the user.

The current spatial stage.

Gets the extent to which the user can look around with their headset.

The look direction range.

Gets the extent to which the user can move while wearing their headset.

The movement range.

Occurs when the user changes or redefines the current spatial stage.

Gets a floor-level coordinate system at the user's current position and orientation.

The spatial locator with the position and orientation to use as the origin for the returned coordinate system. The coordinate system.

Shows system UI to guide the user in defining a new stage to replace the current stage.

An app may call RequestNewStageAsync if there is no stage defined or if the current stage is insufficient to meet the app's needs, such as not defining movement bounds.

Gets the boundary vertices of the open area defined by the user where they intend to move while using their headset.

The coordinate system in which to express the boundary vertices. The boundary vertices.

Represents a frame of reference that remains stationary relative to the user's surroundings at a point in time.

Gets a stationary coordinate system with an origin at the position and orientation of the device at the time this frame was created.

The coordinate system.

Represents a spatial node created for interop based on a spatial coordinate system from the app.

Gets the coordinate system on which this interop frame of reference is based.

The coordinate system.

Gets the transform from the basis coordinate system to the static node.

The transform.

Gets the spatial node ID created for this interop frame of reference.

The spatial node's ID.

Provides preview functionality that lets apps track spatial nodes, allowing the user to reason about places and things in their surroundings.

Creates a spatial coordinate system that tracks adjustments to a static spatial node.

The static spatial node's ID. The spatial coordinate system.

Creates a spatial coordinate system that tracks adjustments to a static spatial node with its origin offset by the specified relative position.

The static spatial node's ID. The rigid positional offset from the spatial node origin to this coordinate system's origin, expressed within the coordinate system of the node origin. The spatial coordinate system.

Creates a spatial coordinate system that tracks adjustments to a static spatial node with its origin offset and rotated by the specified relative position and orientation.

The static spatial node's ID. The rigid positional offset from the spatial node origin to this coordinate system's origin, expressed within the coordinate system of the node origin. The rigid rotation from the spatial node origin to the coordinate system's origin, expressed within the coordinate system of the node origin. The spatial coordinate system.

Creates a spatial locator that tracks the motion of a dynamic spatial node.

The dynamic spatial node's ID. The spatial locator.

Creates an interop frame of reference based on a given spatial coordinate system.

The coordinate system. The interop frame of reference.

Creates an interop frame of reference based on a given spatial coordinate system with its origin offset by the specified relative position.

The coordinate system. The position of the interop frame's origin relative to the origin of the coordinate system. The interop frame of reference.

Creates an interop frame of reference based on a given spatial coordinate system with its origin offset and rotated by the specified relative position and orientation.

The coordinate system. The rigid positional offset from the coordinate system's origin to the interop frame of reference's origin, expressed within the coordinate system. The rigid rotation from the coordinate system's origin to the interop frame of reference's origin, expressed within the coordinate system. The interop frame of reference.

Represents a snapshot of metadata for a surface observed in the user's surroundings.

Gets the persistent identifier for this surface.

The identifier.

Gets the last update time represented by this surface metadata snapshot.

The update time.

Generates a mesh object and its vertex and index buffers for this surface. This chooses the most detailed mesh that does not exceed the specified triangle density, in triangles per cubic meter.

The maximum triangle density that the app can accept, in triangles per cubic meter. The operation that triggers once the mesh is ready.

Generates a mesh object and its vertex and index buffers for this surface, with the specified mesh generation options. This chooses the most detailed mesh that does not exceed the specified triangle density, in triangles per cubic meter.

The maximum triangle density that the app can accept, in triangles per cubic meter. The mesh generation options. The operation that triggers once the mesh is ready.

Gets the bounds of this surface, expressed in the specified coordinate system.

The coordinate system in which to express the bounds. The bounds.

Represents the mesh data for a surface observed in the user's surroundings.

Gets the coordinate system in which the VertexPositions and VertexNormals buffers express their coordinates.

The vertex coordinate system.

Gets the surface metadata that's associated with this mesh.

The surface info.

Gets the buffer object representing the mesh's index buffer.

The mesh buffer.

Gets the buffer object representing the mesh's normal buffer, if IncludeVertexNormals was set as a mesh option in the call to SpatialSurfaceInfo.TryComputeLatestMeshAsync. Otherwise, this property is null.

The mesh buffer if available; otherwise null.

Gets the buffer object representing the mesh's vertex buffer.

The mesh buffer.

Gets the scale vector that you must use to scale the elements of VertexPositions.

The scale vector.

Represents a vertex, index, or normal buffer that holds mesh data for surfaces in the user's surroundings.

The memory buffer containing the mesh data.

The data.

Gets the number of elements in the buffer.

The element count.

Gets the DXGI format to use when creating a GPU buffer to hold this mesh data or when otherwise interpreting the mesh elements. This enum value can be reinterpreted as a DXGI_FORMAT value.

The format.

Gets the size, in bytes, between the start of each element in the buffer.

The stride.

Provides options to customize the SpatialSurfaceMesh objects you get back from SpatialSurfaceInfo.TryComputeLatestMeshAsync.

Initializes a new instance of the SpatialSurfaceMeshOptions class.

Gets or sets whether to compute a normal buffer.

Whether to compute normals.

Gets a list of the triangle index formats that the system can generate an index buffer in.

The supported index buffer formats.

Gets a list of the vertex normal formats that the system can generate a normal buffer in.

The supported normal buffer formats.

Gets a list of the vertex position formats that the system can generate a vertex buffer in.

The supported vertex buffer formats.

Gets or sets the element format for generated index buffers.

The triangle index format.

Gets or sets the element format for generated normal buffers.

The vertex normal format.

Gets or sets the element format for generated vertex buffers.

The vertex position format.

Provides methods for observing surfaces in the user's surroundings.

Initializes a new instance of the SpatialSurfaceObserver class.

Occurs when the set of surface metadata observed within the bounding volume has changed.

Gets metadata for the set of surfaces observed within the bounding volume at the moment.

The observed surfaces.

Gets whether spatial mapping is supported on the current system.

Whether spatial mapping is supported.

Requests access for an app to use spatial mapping. This requires the spatialPerception capability.

Operation that triggers once the user has completed any consent dialog, providing the access status.

Sets the single bounding volume that this observer will track for new, updated or removed surfaces.

The new bounding volume for this observer to track for surface updates.

Sets the list of bounding volumes that this observer will track for new, updated or removed surfaces.

The bounding volumes.

Contains information about an enterprise key credential registration.

Gets the key Id.

The key Id.

Gets the key name.

The key name.

Gets the subject.

The subject.

Gets the tenant Id.

The tenant Id.

Gets the tenant name.

The tenant name.

Provides access to information about enterprise key credential registrations.

Gets the current enterprise key credential registration manager.

The current enterprise key credential registration manager.

Gets the enterprise key credential registrations.

When this method completes, it returns the enterprise key credential registrations.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code. This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

This API is for internal use only and should not be used in your code.

Contains core methods for authenticating with a companion device.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the device configuration data.

The device configuration data.

Gets the device nonce.

The device nonce.

Gets the service authentication HMAC.

The service authentication HMAC.

Gets the session nonce.

The session nonce.

Fires when the authentication stage changes.

Aborts an authentication.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN. An error message to log. This method does not return a value.

Finishes an authentication with a companion device.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN. The authentication device HMAC. The session HMAC. When this method completes, it returns the status of the operation finishing.

Gets info on the authentication stage.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN. When this method completes, it returns info on the authentication stage.

Shows a message above the lock screen or within the companion device sign in option tile.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN. The name of device to display as part of the notification message (set using the message parameter). The message to show. This method does not return a value.

Start an authentication with a companion device.

SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN. The Id of the device to authenticate with. The service authentication nonce. When this method completes, it returns the results of the authentication.

Represents standard error messages.

SecondaryAuthenticationFactorAuthenticationMessage is deprecated and might not work on all platforms. For more info, see MSDN.

Turn on Bluetooth to use **device name** to sign in.

The authentication process was cancelled. Try again.

Instruct the user to center their hand over the companion device.

Could not connect to companion device. Try again.

See **device name** for sign-in instructions.

The companion device is unavailable. Use another sign-in option.

Your enterprise prevents sign in with **device name**. Use another sign-in option.

Tap **device name** again.

Rest your finger on **device name** to sign in.

Invalid message.

Looking for **device name**...

Plug **device name** into a USB port to sign in.

Instruct the user to move their hand closer to the companion device.

Instruct the user to move their hand farther from the companion device.

Turn on NFC to use **device name** to sign in.

Instruct the user to move their hand above the companion device.

Ready to sign in with **device name**.

The companion device failed to recognize the user.

Something went wrong. Use another sign-in option, and then set up **device name** again.

Say your Spoken Passphrase into **device name**.

Swipe your finger on **device name** to sign in.

Swipe up or press space bar to sign in with **device name**.

Tap **device name** to sign in.

Tap **device name** to the NFC reader to sign in.

The authentication process exceeded the time limit. Try again.

Try again.

Couldn’t sign in with **device name**. Use another sign-in option.

Use another sign-in option first, then you can use **device name** to sign in.

Connect to a Wi-Fi network to use **device name** to sign in.

Represents the results of authentication with a companion device.

SecondaryAuthenticationFactorAuthenticationResult is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the authentication.

The authentication.

Gets the status of the authentication.

The status of the authentication.

Represents the authentication scenario.

SecondaryAuthenticationFactorAuthenticationScenario is deprecated and might not work on all platforms. For more info, see MSDN.

Credential prompt.

Sign in.

Gets the stage of the companion device authentication.

SecondaryAuthenticationFactorAuthenticationStage is deprecated and might not work on all platforms. For more info, see MSDN.

**Deprecated.** Checking for device presence.

CheckingDevicePresence is deprecated and might not work on all platforms. For more info, see MSDN.

Collecting credential.

Credential authenticated.

Credential collected

Authentication not started.

Ready for lock.

Stopping authentication.

Suspending authentication.

Waiting for user confirmation.

Provides information about the SecondaryAuthenticationFactorAuthenticationStageChanged event.

SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets info on the authentication stage.

Info on the authentication stage.

Provides information about the stage of a companion device authentication.

SecondaryAuthenticationFactorAuthenticationStageInfo is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the device Id.

The device Id.

Gets the authentication scenario (sign in versus credential prompt).

The authentication scenario.

Gets the stage of the authentication.

The stage of the authentication.

Represents the status of an authentication operation using a companion device.

SecondaryAuthenticationFactorAuthenticationStatus is deprecated and might not work on all platforms. For more info, see MSDN.

Companion device framework disabled by policy.

Authentication failed.

Not a valid authentication stage.

Authentication started.

Unknown companion device.

Represents the capabilities of the companion device.

SecondaryAuthenticationFactorDeviceCapabilities is deprecated and might not work on all platforms. For more info, see MSDN.

The device supports close range data transmission.

Set this flag if the companion device can confirm user intent to authenticate.

The device supports HMacSha256.

No capabilities.

Set this flag if the companion device supports secure storage and can protect auth key and device key from unauthorized access. In order to make sure your key storage meets the security bar, contact cdfonboardmicrosoft.com.

Set this flag if the companion device stores the auth key and device keys.

**Deprecated.** Set this flag if the companion device supports securely confirming the user's identity and presence. In order to make sure your user presence check meets the security bar, contact cdfonboardmicrosoft.com.

SupportSecureUserPresenceCheck is deprecated and might not work on all platforms. For more info, see MSDN.

Set this flag if the companion device transmits auth keys and devices key over an encrypted channel.

Represents the search scope when finding companion devices.

SecondaryAuthenticationFactorDeviceFindScope is deprecated and might not work on all platforms. For more info, see MSDN.

All users.

User.

**Deprecated.** Contains values that describe the presence of a companion device (such as a wearable device).

SecondaryAuthenticationFactorDevicePresence is deprecated and might not work on all platforms. For more info, see MSDN.

The device is not detected by the system.

The device is detected by the system.

**Deprecated.** Contains values that describe the type of connection that the system uses to monitor the presence of a companion device (such as a wearable device).

SecondaryAuthenticationFactorDevicePresenceMonitoringMode is deprecated and might not work on all platforms. For more info, see MSDN.

The system uses an app that corresponds to the companion device to monitor its presence.

The system uses classing Bluetooth protocol to monitor the presence of the companion device.

Device presence monitoring is not supported.

**Deprecated.** Contains values that describe the status of the registration of a companion device for presence monitoring.

SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus is deprecated and might not work on all platforms. For more info, see MSDN.

Presence monitoring registration was prevented by a policy setting on the device.

The device was registered for presence monitoring successfully.

Presence monitoring is not supported on this device.

Represents the status of finishing authentication with a companion device.

SecondaryAuthenticationFactorFinishAuthenticationStatus is deprecated and might not work on all platforms. For more info, see MSDN.

The operation completed.

The operation failed.

The nonce expired.

Contains properties that provide information about a companion device.

SecondaryAuthenticationFactorInfo is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the device configuration data.

The device configuration data.

Gets the device friendly name.

The device friendly name.

Gets the device Id.

The device Id.

Gets the device model number.

The device model number.

**Deprecated.** Checks whether the companion device supports some kind of user authentication function.

**True** if the device supports authentication, otherwise **false**.

**Deprecated.** Gets the presence monitoring mode of the companion device (the mechanism by which the main device checks the presence of the companion device).

A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode.

**Deprecated.** Manually assigns a presence state to a device.

UpdateDevicePresenceAsync is deprecated and might not work on all platforms. For more info, see MSDN. A SecondaryAuthenticationFactorDevicePresence value indicating the device's presence state. An asynchronous action for the operation.

Contains methods for registering companion devices.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN.

Aborts registering the companion device.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. An error message to log. This method does not return a value.

Returns info on found registered devices.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. The scope of devices to find. When this method completes, it returns device info for the found registered devices.

Finishes registering a companion device.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. Configuration data for the device. This data is capped at 4KB. This method does not return a value.

**Deprecated.** Checks whether the main device is able to monitor for the presence of companion devices.

IsDevicePresenceMonitoringSupported is deprecated and might not work on all platforms. For more info, see MSDN. A value of **true** if the device can monitor companion devices, otherwise **false**.

**Deprecated.** Registers a companion device for presence monitoring by the main device.

RegisterDevicePresenceMonitoringAsync is deprecated and might not work on all platforms. For more info, see MSDN. The unique identifier for the companion device. The device instance path string. A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used. An asynchronous operation with the status of the registration.

**Deprecated.** Registers a companion device for presence monitoring by the main device. Includes additional information about the companion device.

RegisterDevicePresenceMonitoringWithNewDeviceAsync is deprecated and might not work on all platforms. For more info, see MSDN. The unique identifier for the companion device. The device instance path string. A SecondaryAuthenticationFactorDevicePresenceMonitoringMode value describing the monitoring mode type that will be used. The friendly name of the device. The model number of the device. The device configuration data. This data is capped at 4KB. An asynchronous operation with the status of the registration.

Starts registering a companion device.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. The Id of the device. The device capabilities. The device friendly name. The device model number. The device key. The mutual authentication key. An asynchronous operation with a registration result instance.

Unregisters a companion device.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. The Id of the device to unregister. This method does not return a value.

**Deprecated.** Unregisters a companion device from presence monitoring.

UnregisterDevicePresenceMonitoringAsync is deprecated and might not work on all platforms. For more info, see MSDN. The unique identifier for the device. This method does not return a value.

Updates the configuration data of a companion device.

SecondaryAuthenticationFactorRegistration is deprecated and might not work on all platforms. For more info, see MSDN. The Id of the device to update. The updated configuration data. This data is capped at 4KB. This method does not return a value.

Provides information about the result of a companion device registration.

SecondaryAuthenticationFactorRegistrationResult is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the registration class instance for the intended companion device.

A SecondaryAuthenticationFactorRegistration instance handling the registration for a companion device.

Gets the status of the registration attempt.

A SecondaryAuthenticationFactorRegistrationStatus value describing the result of the registration attempt.

Represents the status of a companion device registration.

SecondaryAuthenticationFactorRegistrationStatus is deprecated and might not work on all platforms. For more info, see MSDN.

Registration cancelled by the user.

Registration is disabled by policy.

Registration failed.

PIN setup is required before registration can occur.

Registration started.

Provides the ability to control when to show or hide the credential prompt user interface. This includes the user interface for the app to collect user consent to access data stored in Live. The user must see the user interface in order for the app to obtain any user data, if not app will see an error when they try to obtain user data.

Never show the UI, even if an error occurs.

Show the UI only if an error occurred.

Always show the UI. If a default username exists, the username is automatically inserted into the appropriate field.

Provides an app with the ability to start the authentication request to get JavaScript Object Notation (JSON) tokens to use with your service or request tickets that can be used to get data that the user has consented to for your app using the Live ConnectAPI.

Creates an instance of the OnlineIdAuthenticator.

Returns the ID of the application as a GUID.

The ID of the application.

Returns the ID of a user who has been successfully authenticated for your app.

The ID of a user who has been successfully authenticated for your app.

Indicates whether a user can sign out of the app, and whether to show the sign out link in the app.

**True** if the user can sign out and the sign out link should be shown in the app, otherwise **false**.

Starts the async authentication request with multiple OnlineIdServiceTicketRequests and provides the ability to control the user experience by setting the CredentialPromptType to get the tickets. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request.

A collection of requests. The type of credentials. An object representing the authentication operation.

Starts the asynchronous authentication request with one OnlineIdServiceTicketRequest by showing the credential prompt if needed to collect credentials or consent and get the ticket. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request.

A request object that provides the ability for an app to specify the service and policy used to authenticate a Live user to obtain identity properties and tickets. An object representing the authentication operation.

Allows users to sign out of your app.

An object that contains additional information about the why the user signed out.

Contains the ticket that is obtained after the user authenticates to this app or has provided consent to access user data stored in Live.

If there was an error in obtaining the ticket, then the error code is captured here.

The error code number.

Represents the OnlineIdServiceTicketRequest for which the ticket was obtained.

Provides the ability for an app to specify the service and policy that is used to authenticate a Live user to obtain identity properties and tickets.

The ticket.

A string that represents the ticket.

Provides the ability for an app to specify the service and policy that is used to authenticate a Live user to obtain identity properties and tickets.

Creates an instance of the OnlineIdServiceTicketRequest class.

The service for the request.

Creates an instance of the OnlineIdServiceTicketRequest class.

The service for the request. The policy for the request.

The policy used to authenticate users. Supported values are JWT, which returns data using the JSON format. For apps that are requesting user consent to access stored in Live, app developer must pass a policy of DELEGATION.

A string that represents the policy.

Identifies the service your app uses. The service name must match the DNS name you supplied when registering your app on http://go.microsoft.com/fwlink/p/?linkid=241860. Tickets are issued only for this service. For apps that are requesting user consent to access stored in Live, you must pass the offers to which your app needs access. The available list of offers can be found at our Scopes and Permissions page. Check out our REST APIs topic to learn more.

A string that represents the service.

This class handles an app's attempts to acquire the local user id on a device, for use with the System Ticket feature (see Remarks).

Gets an instance of OnlineIdSystemAuthenticatorForUser that corresponds to the user currently logged in to the device.

The OnlineIdSystemAuthenticatorForUser corresponding to the local user.

Gets an instance of OnlineIdSystemAuthenticatorForUser that corresponds to the specified user.

The local Windows user. A OnlineIdSystemAuthenticatorForUser corresponding to the user.

Represents the authentication info for a single user entity on a single device (system).

The unique id value of the calling application. Windows desktop applications that are to use the System Ticket feature must set this value explicitly before calling getTicketAsync.

The id of the calling application.

Gets the corresponding Windows user for this OnlineIdSystemAuthenticatorForUser.

The Windows user for this OnlineIdSystemAuthenticatorForUser.

Attempts to retrieve the system ticket for the device.

The OnlineIdServiceTicketRequest representing the specifications for authenticating this user account. An asynchronous task containing the system ticket result.

Identifies the local device (system) on which the user account in question exists.

A unique string identifier for the local system of this OnlineIdSystemIdentity.

The unique identifier for this local system.

Provides additional information about the device.

The OnlineIdServiceTicket corresponding to this device.

Represents the result of a call to retrieve a system ticket.

Represents the Windows Runtime error associated with a failed attempt to retrieve the system ticket.

The Windows Runtime error code.

The OnlineIdSystemIdentity object corresponding to the device whose system ticket was retrieved.

The identity of the device.

Gets the status of the system ticket call.

The status of the system ticket call.

Represents the status of a call to retrieve the system ticket.

An unexpected error prevented the retrieval of the system ticket.

A network error prevented the retrieval of the system ticket.

The call to retrieve the system ticket was successful.

Allows users to sign out of your app.

Gets or sets a handler that is called when the operation completes.

A method or function that is called when the operation completes.

Gets the error code should the operation fail.

The structure that contains the error code.

Gets a unique identifier that represents the operation.

The operation's unique ID as defined in the package manifest.

Gets the current status of the operation.

One of the enumeration values that indicates the status.

Requests the cancellation of the operation.

Requests that work associated with the operation should terminate.

Returns the results of the operation. For this class, there are no results to return if the operation succeeds.

Asynchronously gets the user's identity and corresponding tickets and properties.

Gets or sets a handler that's called when the operation completes.

The method or function that is called when the operation completes.

Gets the error code should the operation fail.

The structure that contains the error code.

Gets a unique identifier that represents the operation.

The operation's unique ID as defined in the package manifest.

Gets the current status of the operation.

One of the enumeration values that indicates the status.

Requests the cancellation of the operation.

Requests that work associated with the operation should terminate.

Returns a UserIdentity object that contains information about the user.

An object containing information about the user's identity.

Contains the ID, tickets, and other information associated with a user.

Contains the first name of the user. This value is available only to Microsoft application partners.

The user's first name.

Gets the user's unique Microsoft account identifier. This value is available only to Microsoft application partners.

The user's unique Microsoft account identifier.

Indicates if the user is part of a beta program. This value is available only to Microsoft application partners.

True if the user is part of a beta program; false otherwise.

Indicates if the user is on a PC that they have confirmed as their PC. This value is available only to Microsoft application partners.

True if the user is on a confirmed PC; false otherwise.

Contains the user's last name. This value is available only to Microsoft application partners.

The user's last name.

Gets an obfuscated customer ID specific to the calling application. This ID allows your application to identify the user across sessions but cannot be used to share data between separate applications since each application will receive a distinct SafeCustomerId value for the same Microsoft account.

An obfuscated customer ID specific to the calling application.

The sign in name of the user. This value is available only to Microsoft application partners.

The name of the user.

Contains an array of tickets that identify the user. If your app uses the JWT policy, only one ticket is returned. This value is only available to Microsoft application partners.

An array of tickets that identify the user.

Gets the type of key used for token binding.

Any existing key type.

ECDsaP256.

RSA-2048.

Starts the authentication operation. You can call the methods of this class multiple times in a single application or across multiple applications at the same time. The Web authentication broker sample in the Samples gallery is an example of how to use the WebAuthenticationBroker class for single sign on (SSO) connections.

Starts the authentication operation with one input.

The starting URI of the web service. This URI must be a secure address of https://.

Starts the authentication operation with two inputs.

The starting URI of the web service. This URI must be a secure address of https://. The callback URI that indicates the completion of the web authentication. The broker matches this URI against every URI that it is about to navigate to. The broker never navigates to this URI, instead the broker returns the control back to the application when the user clicks a link or a web server redirection is made.

Starts the authentication operation with four inputs.

The starting URI of the web service. This URI must be a secure address of https://. The callback URI that indicates the completion of the web authentication. The broker matches this URI against every URI that it is about to navigate to. The broker never navigates to this URI, instead the broker returns the control back to the application when the user clicks a link or a web server redirection is made. Continuation data to be passed as part of the authentication operation. The options for the authentication operation.

Starts the asynchronous authentication operation with two inputs. You can call this method multiple times in a single application or across multiple applications at the same time.

The options for the authentication operation. The starting URI of the web service. This URI must be a secure address of https://. The way to query the status and get the results of the authentication operation. If you are getting an invalid parameter error, the most common cause is that you are not using HTTPS for the *requestUri* parameter.

Starts the asynchronous authentication operation with three inputs. You can call this method multiple times in a single application or across multiple applications at the same time.

The options for the authentication operation. The starting URI of the web service. This URI must be a secure address of https://. The callback URI that indicates the completion of the web authentication. The broker matches this URI against every URI that it is about to navigate to. The broker never navigates to this URI, instead the broker returns the control back to the application when the user clicks a link or a web server redirection is made. The way to query the status and get the results of the authentication operation. If you are getting an invalid parameter error, the most common cause is that you are not using HTTPS for the *requestUri* parameter.

Starts the asynchronous authentication operation silently (no UI will be shown) with one input. You can call this method multiple times in a single application or across multiple applications at the same time.

The starting URI of the web service. This URI must be a secure address of https://. The way to query the status and get the results of the authentication operation. If you are getting an invalid parameter error, the most common cause is that you are not using HTTPS for the requestUri parameter.

Starts the asynchronous authentication operation silently (no UI will be shown) with two inputs. You can call this method multiple times in a single application or across multiple applications at the same time.

The starting URI of the web service. This URI must be a secure address of https://. The options for the authentication operation. The way to query the status and get the results of the authentication operation. If you are getting an invalid parameter error, the most common cause is that you are not using HTTPS for the requestUri parameter.

Gets the current application callback URI.

The URI of the current application.

Contains the options available to the asynchronous operation.

No options are requested.

Tells the web authentication broker to not render any UI. This option will throw an exception if used with AuthenticateAndContinue; AuthenticateSilentlyAsync, which includes this option implicitly, should be used instead.

Tells the web authentication broker to render the webpage in an app container that supports privateNetworkClientServer, enterpriseAuthentication, and sharedUserCertificate capabilities. Note the application that uses this flag must have these capabilities as well.

Tells the web authentication broker to return the body of the HTTP POST in the ResponseData property. For use with single sign-on (SSO) only.

Tells the web authentication broker to return the window title string of the webpage in the ResponseData property.

Indicates the result of the authentication operation.

Contains the protocol data when the operation successfully completes.

The returned data.

Returns the HTTP error code when ResponseStatus is equal to WebAuthenticationStatus.ErrorHttp. This is only available if there is an error.

The specific HTTP error, for example 400.

Contains the status of the asynchronous operation when it completes.

One of the enumerations.

Contains the status of the authentication operation.

The operation failed because a specific HTTP error was returned, for example 404.

The operation succeeded, and the response data is available.

The operation was canceled by the user.

This class represents the result of an account retrieval operation.

Gets the list of retrieved web accounts (if the operation was successful).

An **IVectorView ** of **WebAccount ** objects.

Gets the error, if one occurred, during the web account retrieval operation.

The provider error.

Gets the status of the web account retrieval operation.

A value indicating the result status.

Contains values that describe the result of a web account enumeration operation (see the **FindAllAccountsAsync ** method).

This application is not authenticated to enumerating the list of accounts. Developers must whitelist their apps with the identity provider before they can try to enumerate accounts

The identity provider does not support the account enumeration. For now only inbox providers like MSA and AAD support this operation

There was an error with the identity provider. Get the **ProviderError ** property of the **FindAllAccountsResult ** object for more information.

The enumeration was successful.

Contains information about an event involving a WebAccount.

Gets the WebAccount involved in the event.

The web account involved in the event.

Allows an app to monitor specific web accounts and raises events when those web accounts change.

Fires when a monitored WebAccount's picture changes.

Fires when the default sign in account changes.

Fires when a monitored WebAccount is removed.

Fires when a monitored WebAccount is updated.

Contains core methods for obtaining tokens from web account providers.

Creates a web account monitor to watch given accounts.

The web accounts to monitor. A web account monitor watching the given accounts.

Asynchronously attempts to find a web account provider.

The web account provider for the web account. The identifier of the web account. An asynchronous find operation. On successful completion, contains a WebAccount object representing the found web account.

Asynchronously attempts to find a web account provider.

The Id of the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Asynchronously attempts to find a web account provider.

The Id of the web account provider to find. The authority of the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Asynchronously attempts to find a web account provider.

The Id of the web account provider to find. The authority of the web account provider to find. The user associated with the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Enumerates all of the accounts that have been added by a user for a particular ID provider.

The ID provider that owns the accounts to be retrieved. An asynchronous find operation. On successful completion, contains a FindAllAccountsResult object representing the result of the account retrieval.

Enumerates all of the accounts that have been added by a user for a particular ID provider.

The ID provider that owns the accounts to be retrieved. The ID of the client application. An asynchronous find operation. On successful completion, contains a FindAllAccountsResult object representing the result of the account retrieval.

Asynchronously attempts to find a web account provider for device-wide authentication.

The Id of the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Asynchronously attempts to find a web account provider for device-wide authentication.

The Id of the web account provider to find. The authority of the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Asynchronously attempts to find a web account provider for device-wide authentication.

The Id of the web account provider to find. The authority of the web account provider to find. The user associated with the web account provider to find. An asynchronous find operation. On successful completion, contains a WebAccountProvider object representing the found web account provider.

Asynchronously attempts to get a token without showing any UI. The user will never be prompted to enter their credentials.

The web token request. An asynchronous request operation. On successful completion, contains a WebTokenRequestResult object representing the result of the web token request.

Asynchronously attempts to get a token without showing any UI. The user will never be prompted to enter their credentials.

The web token request. The web account. An asynchronous request operation. On successful completion, contains a WebTokenRequestResult object representing the result of the web token request.

Asynchronously requests a token from a web account provider. If necessary, the user is prompted to enter their credentials.

The web token request. An asynchronous request operation. On successful completion, contains a WebTokenRequestResult object representing the result of the web token request.

Asynchronously requests a token from a web account provider. If necessary, the user is prompted to enter their credentials.

The web token request. The web account for the request. An asynchronous request operation. On successful completion, contains a WebTokenRequestResult object representing the result of the web token request.

Represents an error from a web account provider.

Initializes a new instance of the WebProviderError class.

The error code. The error message.

Gets the error code.

The error code.

Gets the error message.

The error message.

Gets the error properties.

The error properties.

Represents a request to an online identity provider for an authentication token.

Initializes a new instance of the WebTokenRequest class with one input.

The web account provider the request is for.

Initializes a new instance of the WebTokenRequest class with two inputs.

The web account provider the request is for. The scope of the request.

Initializes a new instance of the WebTokenRequest class with three inputs.

The web account provider the request is for. The scope of the request. The client ID.

Initializes a new instance of the WebTokenRequest class with four inputs.

The web account provider the request is for. The scope of the request. The client ID. The request prompt type.

Gets the app properties of the request.

The app properties of the request.

Gets the Id of the client making the request.

The Id of the client making the request.

Gets and sets a correlation Id, a unique identifier used for tracking authentication-related requests.

The correlation Id for this request.

Gets the prompt type of the request.

The prompt type of the request.

Gets the properties of the request.

The properties of the request.

Gets the scope of the request.

The scope of the request.

Gets the web account provider for the request.

The web account provider for the request.

Represents the prompt type of a web token request.

The default request type.

A request with forced authentication. This will require the user to enter their credentials, regardless of whether they are already logged in.

Represents the results of a web token request to an identity provider.

Gets the response data from the web token provider.

The response from the web token provider.

Gets the error returned by the web provider, if any.

The error returned by the web provider.

Gets the status of the request.

The status of the request.

Invalidates the current cached WebTokenRequestResult. See Remarks for proper usage.

This method does not return an object or value.

Represents the status of a web token request.

The account provider was not available.

The account associated with the request has switched. This status occurs when you attempt to use one web account, but the user indicates they wish to use a different web account instead.

There was a provider error. For information on how to handle this error, consult the provider's documentation.

The request was successful.

The request was cancelled by the user.

User interaction is required to complete the request. This option is only applicable to requests made with GetTokenSilentlyAsync. If this status is returned, repeat the request with RequestTokenAsync.

Represents the response from a web account provider to a web token request.

Initializes a new instance of the WebTokenResponse class.

Initializes a new instance of the WebTokenResponse class with one input.

The token.

Initializes a new instance of the WebTokenResponse class with two inputs.

The token. The WebAccount.

Initializes a new instance of the WebTokenResponse class with three inputs.

The token. The WebAccount. The web provider error.

Gets the properties of the response

The properties of the response.

Gets the error returned by the provider, if any.

The error returned by the provider.

Gets the authentication token.

The authentication token.

Gets the web account for the request.

The web account for the request.

Defines methods for web account provider operations that report success or failure.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Defines properties for web account provider operations.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Defines methods for silent web account provider operations.

Informs the activating app a token could not be obtained silently and that user interaction is required to continue the operation.

Informs the activating app a token could not be obtained silently and that user interaction is required to continue the operation.

The error that has occurred.

Defines properties for web account provider token objects.

Gets the web account provider operation.

The web account provider operation.

Defines properties for web account provider token objects that are retrieved in the context of a specific user.

Gets the user for this token objects set.

The user for this token objects set.

Defines properties for web account provider token operations.

Gets or sets the cache expiration time.

The cache expiration time.

Gets the web provider token request.

The web provider token request.

Gets the web provider token responses.

The web provider token responses.

Defines methods for web account provider UI report operations.

Informs the activating app that the user has cancelled the operation.

Represents the client view for a web account. Use this to control what information about an account from a provider is available to the client.

Creates a new instance of the WebAccountClientView class.

The client view type. The callback URI that indicates the completion of the operation.

Creates a new instance of the WebAccountClientView class.

The client view type. The callback URI that indicates the completion of the operation. The account pairwise Id.

Gets the account pairwise Id.

The account pairwise Id.

Gets the app callback Uri.

The app callback Uri.

Gets the type of web account client view.

The web account client view type.

Represents the levels of information about a web account shown to the client.

Shows the Id and properties.

Shows only the Id.

Provides methods for managing web accounts.

Adds a new web account asynchronously with three inputs.

The Id for the web account. The user name for the web account. Properties for the web account. When this method completes, it returns the new web account.

Adds a new web account asynchronously with four inputs.

The Id for the web account. The user name for the web account. Properties for the web account. The scope of the web account. When this method completes, it returns the new web account.

Adds a new web account asynchronously with five inputs.

The Id for the web account. The user name for the web account. Properties for the web account. The scope of the web account. The per-user web account Id. When this method completes, it returns the new web account.

Adds a new web account. This process is tracked as belonging to a specified user (for use with multi-user-aware apps).

The user for which an account must be authenticated. The Id for the web account. The user name for the web account. Properties for the web account. An asynchronous operation with the new web account.

Adds a new web account. This process is tracked as belonging to a specified user (for use with multi-user-aware apps).

The user for which an account must be authenticated. The Id for the web account. The user name for the web account. Properties for the web account. The scope of the web account. An asynchronous operation with the new web account.

Adds a new web account. This process is tracked as belonging to a specified user (for use with multi-user-aware apps).

The user for which an account must be authenticated. The Id for the web account. The user name for the web account. Properties for the web account. The scope of the web account. The web account Id for this particular user. An asynchronous operation with the new web account.

Clears the link between per-user and per-app web accounts.

The per-app web account to clear. This method does not return a value.

Clears the view for a web account.

The web account to clear the view for. The callback Uri that indicates the completion of the operation. The broker matches this Uri against every Uri that it is about to navigate to. The broker never navigates to this Uri, instead the broker returns the control back to the application when the user clicks a link or a web server redirection is made. This method does not return a value.

Clears a web account picture asynchronously.

The web account to clear the picture from. This method does not return a value.

Deletes a web account asynchronously.

The WebAccount to delete. This method does not return a value.

Finds all provider web accounts asynchronously.

When this method completes, it returns all provider web accounts.

Finds all provider web accounts associated with a given user asynchronously (for use with multi-user-aware apps).

The user associated with the accounts. When this method completes, it returns all provider web accounts for the user.

Gets a per-user web account from a per-app web account.

The per-app web account. When this method completes, it returns the per-user web account linked to the given per-app account.

Gets the scope of the web account.

The web account to get scope for. The scope of the web account.

Gets the views for a web account asynchronously.

The web account to get views for. When this method completes, it returns the views for the web account.

Clears the web account manager's token cache for a specific web account.

The web account for which tokens will be cleared. This method does not return a value.

Clears the web account manager's token cache for all web accounts.

This method does not return a value.

Pulls cookies asynchronously. Use this to enable single sign-on in an app after a user has entered their credentials into a web browser.

The Uri to pull cookies from. The caller's package family name. This method does not return a value.

Pushes cookies asynchronously. Use this to enable single sign-on for a web account in a browser after the user has entered their credentials into the app.

The Uri to push the cookies to. The cookies to push. This method does not return a value.

Creates a per-app to per-user account link.

The per-app web account. The web account Id of the per-user web account to link. This method does not return a value.

Sets the scope of a web account asynchronously.

The web account to set scope for. The scope to set. This method does not return a value.

Sets the view for a web account asynchronously.

The web account to set the view for. The view to set. This method does not return a value.

Sets the picture of a web account asynchronously.

The web account to set the picture for. The picture to set. This method does not return a value.

Updates the properties of a web account asynchronously.

The web account to update. The username to update. The properties to update. This method does not return a value.

Represents an add account operation.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Informs the activating app that the operation completed successfully.

Represents a delete account operation.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Gets the web account to delete.

The web account to delete.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Represents a get token silently operation.

Gets or sets the cache expiration time.

The cache expiration time.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Gets the web provider token request.

The web provider token request.

Gets the web provider token responses.

The web provider token responses.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Informs the activating app that user interaction is required to continue the operation.

Informs the activating app that an error has occurred and user interaction is required to continue the operation.

The error that has occurred.

Represents a manage account operation.

Gets the kind of web provider operation.

The kind of web account provider operation.

Gets the web account to manage.

The web account to manage.

Informs the activating application that the operation completed successfully.

Represents different operations a web account provider can perform. Use this to determine what operation to perform when the provider is activated. Providers must ignore unknown operations.

Add a web account.

Delete a web account.

Get an authentication token without showing any UI.

Manage a web account.

Request an authentication token.

Retrieve cookies.

Sign out a web account.

Represents a request token operation.

Gets or sets the cache expiration time.

The cache expiration time.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Gets the web provider token request.

The web provider token request.

Gets the web provider token responses.

The web provider token responses.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Informs the activating app that the user cancelled the operation.

Represents a retrieve cookies operation made by a web account provider.

Gets the app callback Uri.

The app callback Uri.

Gets the context of the retrieve cookies operation.

The context of the retrieve cookies operation.

Gets the cookies.

The cookies to retrieve.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Gets or sets the Uri to retrieve cookies from.

The Uri to retrieve cookies from.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Represents a sign out account operation made by a web account provider.

Gets the app callback Uri.

The app callback Uri.

Gets the client Id.

The client Id.

Gets the kind of web account provider operation.

The kind of web account provider operation.

Gets the web account to sign out.

The web account to sign out.

Informs the activating app that the operation completed successfully.

Informs the activating app that the operation encountered an error.

The type of error encountered.

Provides information about the trigger that started the web account provider task.

Gets the web account provider operation.

The web account provider operation.

Gets the user that issued this web account provider trigger (for use with multi-user-aware apps).

The user for this trigger.

Represents the scope of a web account.

Scope that hides the account from PC settings. Use this scope if you do not want the user's login to persist. For these accounts, only per-app tokens should be retained.

Scope for single-sign-on accounts that appear in PC settings. This is the default scope.

Represents web account selection options. Use this to support the use of multiple web accounts in an app, where user might choose to log in with an existing account or add a new account.

The user selected the default account.

The user selected to add a new account.

Represents a request for a token from a client to a provider.

Gets the app callback Uri.

The app callback Uri.

Gets the package family name of the calling application.

A string representing the package family name.

Gets the process name of the calling application.

A string representing the process name.

Gets the web token request made by the client.

The web token request made by the client.

Gets the web accounts for the request.

The web accounts for the request.

Gets the web account selection options.

The web account selection options.

Determines if the calling application fulfills a given SSO capability.

The name of the capability to check for. An asynchronous operation with a boolean value. **True** if the application supports the given capability, otherwise **False**.

Gets a token binding key for the app asynchronously.

The type of key to get. The target Uri. When this method completes, it returns a cryptographic key.

Gets an app token binding key Id.

The type of token binding key. The target Uri for the key. When this method completes, it returns the token binding key Id.

Represents a web provider token response.

Creates a new instance of the WebProviderTokenResponse class.

The web token response from the client.

Gets the response from the provider to the client.

The response from the provider to the client.

Creates an AppCapability object for the app's user and the current process.

Accesses the stored capability.

The stored capability as a string property.

The user under which the AppCapability is created.

The user property.

Raised when there is a change to access status.

Checks access for the object’s stored capability and user.

Returns an AppCapabilityAccessStatus (can be UserPromptRequired).

Creates an AppCapability object.

The string property of CapabilityName. Returns the created instance.

Creates an AppCapability object for the specified process and user.

The user property for which the object was created. The string property of CapabilityName. The Process ID. Returns the created instance.

Requests access for the object’s stored capability and user.

Returns an AppCapabilityAccessStatus enum.

Requests access to multiple capabilities simultaneously.

The capability name strings. Returns a read-only Dictionary with string capabilities as keys to AppCapabilityAccessStatus enums.

Requests access to multiple capabilities simultaneously.

The user property for which the object was created. The capability name strings. Returns a read-only Dictionary with string capabilities as keys to AppCapabilityAccessStatus enums.

Provides data for the AccessChanged event.

Describes an application’s access to a single capability.

State: Allowed.

State: Denied by System.

State: Denied by User.

State: Not Declared by App.

State: User Prompt Required

Enables a class to represent an account from a web account provider.

Gets the connected state of the web account.

The connected state of the web account.

Gets the username for the web account.

The username for the web account.

Gets the web authentication provider for the account.

The web authentication provider for the account.

Represents a key credential, an RSA, 2048-bit, asymmetric key that represents a user's identity for an application.

Gets the name of the key credential.

The name of the key credential.

Gets an attestation for a key credential. Call this method after provisioning a key credential for the current user and application.

When this method completes, it returns a key credential attestation result.

Prompts the user to cryptographcally sign data using their key credential.

The data to cryptographically sign. When this method completes, it returns a key credential operation result.

Gets the public portion of the asymmetric KeyCredential.

The public portion of the asymmetric key credential.

Gets the public portion of the asymmetric KeyCredential.

The blob type of the public key to retrieve. The public portion of the asymmetric key credential.

Represents the results of the KeyCredential.GetAttestationAsync method.

Gets the attestation information for the KeyCredential.

The attestation information for the KeyCredential.

Gets the chain of certificates used to verify the attestation.

The chain of certificates used to verify the attestation.

Gets the status of the key credential attestation.

The status of the key credential attestation.

Represents key credential attestation statuses.

The operation was not supported.

The operation was successful.

The operation temporarily failed.

The operation encountered an unknown error.

Represents the options for creating key credentials.

Fail if a key credential already exists.

Replace any existing key credentials.

Contains methods for basic management of key credentials.

Deletes a previously provisioned user identity key for the current user and application.

The name of the key to delete. This method does not return a value.

Determines if the current device and user is capable of provisioning a key credential.

When this method completes, it returns true if the current device and user is capable of provisioning a key credential. Otherwise, it returns false.

Retrieves a key credential for the current user and application.

The name of the key credential to open. When this method completes, it returns the results of the key credential retrieval.

Renews an attestation for a key credential.

This method does not return a value.

Creates a new key credential for the current user and application.

The name of the key credential to create. Options for the creation operation. When this method completes, it returns the results of the key credential creation.

Represents the result of a key credential operation.

Gets the result of the key credential operation.

The result of the key credential operation.

Gets the status of the key credential.

Gets the status of the key credential.

Represents the result of a key credential retrieval.

Gets the key credential.

The key credential.

Gets the status of the key credential.

The status of the key credential.

Represents the status of a key credential request.

The credential already exists.

The credential could not be found.

The security device was locked.

The operation was successful.

An unknown error occurred.

The request was cancelled by the user.

The user prefers to enter a password.

Represents the password credential store.

Creates and initializes a new, empty instance of the PasswordCredential object.

Creates and initializes a new instance of the PasswordCredential object that contains the provided credential data.

The resource for which the credentials are used. The user name that must be present in the credentials. This value must not be null or empty, otherwise an exception will be thrown. The password for the created credentials. This value must not be null or empty, otherwise an exception will be thrown.

Gets or sets the password string of the credential. This value must not be null or empty, otherwise an exception will be thrown. You must call **RetrievePassword ** first to set the initial value of this property.

The password string of the credential.

This API is intended for internal use only should not be used in your code.

This API is intended for internal use only and should not be used in your code.

Gets or sets the resource of the credential.

The resource of the credential.

Gets or sets the user name of the credential. This value must not be null or empty, otherwise an exception will be thrown.

The user name of the credential.

Populates the password for the credential. After the operation returns successfully, you can get the password from the Password property.

Represents the password credential property store. This class and its members are reserved for internal use and are not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

Reserved for internal use.

This method is reserved for internal use and is not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

This method is reserved for internal use and is not intended to be used in your code.

Reserved.

This method is reserved for internal use and is not intended to be used in your code.

Reserved. Reserved.

This method is reserved for internal use and is not intended to be used in your code.

Reserved.

This method is reserved for internal use and is not intended to be used in your code.

Reserved.

Represents a Credential Locker of credentials. The contents of the locker are specific to the app or service. Apps and services don't have access to credentials associated with other apps or services.

Creates and initializes a new instance of the PasswordVault object.

Adds a credential to the Credential Locker.

The credential to be added.

Searches the Credential Locker for credentials matching the resource specified.

The resource to be searched for. If a match does not exist, an exception will throw. When this method returns, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of credential objects that match the search criteria.

Searches the Credential Locker for credentials that match the user name specified.

The user name to be searched for. If a match does not exist, an exception will throw. When this method returns, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) of credential objects that match the search criteria.

Removes a credential from the Credential Locker.

The credential to be removed.

Reads a credential from the Credential Locker.

The resource for which the credential is used. The user name that must be present in the credential. The returned credential that contains all the data.

Retrieves all of the credentials stored in the Credential Locker.

When this method returns, contains an [IVectorView](https://docs.microsoft.com/previous-versions/br224594(v=vs.85)) output of credential objects that match the search criteria. This output is a snapshot and not dynamic. If the results are used for updating or deleting credentials, those changes won't be reflected in the previous output.

Identifies an account from a web account provider.

Creates an instance of the WebAccount class.

The web account provider associated with the web account. The user name of the web account. The state of the web account.

Gets the Id of the web account.

The Id of the WebAccount.

Gets the properties of the web account.

The properties of the WebAccount.

Gets the connected state of the web account.

The connected state of the web account.

Gets the username for the web account.

The username for the web account.

Gets the web authentication provider for the account.

The web authentication provider for the account.

Gets the web account's picture asynchronously.

The desired size of the web account picture. When this method completes, it returns the web account's picture.

Signs the web account out asynchronously. This clears all cached tokens associated with the account, and tells the provider to invalidate any tokens associated with the account for this app.

This method does not return a value.

Signs the web account out asynchronously. This clears all cached tokens associated with the account, and tells the provider to invalidate any tokens associated with the account for this app.

The Id of the client. This method does not return a value.

Represents the sizes of a web account picture.

1080x1080

208x208

424x424

64x64

Represents a web account authentication provider.

Creates an instance of the WebAccountProvider class.

The web account provider id. The display name for the web account provider. The Uri of the icon image to display for the web account provider.

Gets the authority of the web account provider. Use authority to disambiguate between a single provider with multiple identities (such as a Microsoft account versus Azure Active Directory).

The authority of the web account provider.

Gets the display name for the web account provider.

The display name for the web account provider.

Gets the display purpose of the web account provider.

The display purpose of the web account provider.

Gets the Uri of the icon image to display for the web account provider.

The Uri of the icon image to display for the web account provider.

Gets the web account provider id.

The web account provider id.

Gets the value describing whether the given ID provider supports system-wide authentication tokens.

**True** if the WebAccountProvider allows system-wide authentication tokens. Otherwise **False**.

Gets the user associated with the provider.

The user associated with the provider.

Describes the state of a WebAccount object.

The account is connected.

The account was unable to connect.

The account is currently not connected.

Identifies which authentication protocol to use.

The authentication protocol is basic. Credentials are returned to the caller as plaintext.

The authentication protocol is for remote access using the Credential Security Support Provider (CredSSP) protocol.

The authentication protocol is anything other than the previous ones. Credentials are returned to the caller as plaintext.

The authentication protocol is digest. Credentials are returned to the caller as plaintext.

The authentication protocol is Kerberos. Credentials are transformed before being returned to the caller.

The authentication protocol is negotiate, including negotiate extensions. Credentials are transformed before being returned to the caller.

The authentication protocol is NTLM. Credentials are transformed before being returned to the caller.

Creates an asynchronous object that displays a dialog box of credentials to the user and collects the user's response.

Constructor used to initiate asynchronous prompting operations using two inputs.

The target name to display. The message to display in the dialog box. The credential and options from the user.

Constructor used to initiate asynchronous prompting operations using three inputs.

The target name to display. The message to display in the dialog box. The caption to display in the dialog box. The credential and options from the user.

Displays a dialog box to the user and collects credentials from the user.

The options on displaying and collecting the credential box. The credential and options from the user.

Controls the appearance and behavior of a credential prompt.

Creates and initializes a new, empty instance of the CredentialPickerOptions object.

Gets or sets the option of whether the dialog box is displayed.

Gets or sets the option of always displaying the dialog box. The default value is False.

Gets or sets the authentication protocol.

Name of the authentication protocol to use for credential authentication. The default value is Negotiate.

Gets or sets whether the caller wants to save the credentials.

Gets or sets whether the caller wants to save the credentials. The default value is False.

Gets or sets the caption text that is displayed to the user.

Text that appears in the message header of the dialog box. The default value is the caller's app name.

Gets or sets the option on saving credentials.

The option specifies the initial state of the dialog's "Save Credential" check box. The default value is clear (unchecked). This property is ignored if the caller specifies **Hidden** in the CredentialSaveOption enumeration.

Gets or sets whether the authentication protocol is custom rather than a standard authentication protocol.

The authentication protocol is custom rather than a standard authentication protocol. The default value is none.

Gets or sets the error code.

If nonzero, represents a Win32 ERROR_* status value that identifies the error information to be formatted and displayed in the dialog box. The default value is ERROR_SUCCESS if no error occurred.

Gets or sets the body of text that displays to the user.

Text that appears in the message body of the dialog box. The default value is "Enter credentials" or localized equivalent.

Gets or sets whether to fill dialog box fields with previous credentials.

Determines whether dialog box fields are filled with previous credentials. The default value is not to prepopulate the fields.

Gets or sets the name of the target computer.

Name of the target computer. The default value is the caller's computer.

Describes the results of the dialog box operation.

Gets the opaque credential.

A byte buffer that contains the opaque credential. If the credential is not available, a valid, but empty IBuffer object is returned.

Gets the domain name portion of the unpacked credential.

The domain name of the credential. If the domain name is not available, an empty string is returned.

Gets the password portion of the unpacked credential.

The password of the credential. If the password is not available, an empty string is returned.

Gets the status of the credential save operation.

Indicates whether the credential was successfully saved by the credential manager. This value is always False if the caller specified the CallerSavesCredential property.

Gets the state of the "Save Credentials" check box.

Indicates the state of the dialog box "Save" check box. If no check box was displayed, the value is "None."

Gets the user name of the unpacked credential.

The user name of the credential used. If the user name is not available, an empty string is returned.

Gets the value of the error code.

The value of the error code. If the operation status indicates a failure, this property contains the extended error information. If the operation status is anything except failure, the value is zero.

Identifies the state of the dialog box option on whether to save credentials.

The "Save credentials?" dialog box is not displayed at all.

The "Save credentials?" dialog box is selected, indicating that the user wants their credentials saved.

The "Save credentials?" dialog box is not selected, indicating that the user doesn't want their credentials saved.

Describes the result of a verification operation.

The verification operation was canceled.

The biometric verifier device is performing an operation and is unavailable.

There is no biometric verifier device available.

Group policy has disabled the biometric verifier device.

A biometric verifier device is not configured for this user.

After 10 attempts, the original verification request and all subsequent attempts at the same verification were not verified.

The fingerprint was verified.

Checks for availability of a verification device (such as a Microsoft Passport PIN, Windows Hello biometric, or fingerprint reader) and performs a verification.

Checks to see whether a verifier device, such as a Microsoft Passport PIN, Windows Hello, or fingerprint reader, is available.

A UserConsentVerifierAvailability value that describes the result of the availability check operation.

Performs a verification using a device such as Microsoft Passport PIN, Windows Hello, or a fingerprint reader.

A message to display to the user for this biometric verification request. A UserConsentVerificationResult value that describes the result of the biometric verification.

Describes the result of a check for a biometric (fingerprint) verifier device.

A biometric verifier device is available.

The biometric verifier device is performing an operation and is unavailable.

There is no biometric verifier device available.

Group policy has disabled the biometric verifier device.

A biometric verifier device is not configured for this user.

Contains encoding formats that can be used in the ConvertStringToBinary and ConvertBinaryToString methods.

Sixteen bit Unicode Transformation Format in big-endian byte order.

Sixteen bit Unicode Transformation Format in little-endian byte order. The encoding process creates a variable length result of one or two 8-bit bytes per Unicode code point.

Eight bit Unicode Transformation Format. The process encodes each Unicode code point into one to four 8-bit bytes. Code points represented by lower numerical values are encoded using fewer bytes. In particular, the first 128 characters correspond exactly to the ASCII character set and are encoded by using a single octet.

Contains static methods that implement data management functionality common to cryptographic operations.

Compares two IBuffer objects.

Buffer to be used for comparison. Buffer to be used for comparison. **True** specifies that the buffers are equal. Two buffers are equal if each code point in one matches the corresponding code point in the other.

Converts a buffer to an encoded string.

Encoding format. Data to be encoded. A string that contains the encoded data.

Converts a string to an encoded buffer.

String to be encoded. Encoding format. Encoded buffer.

Copies a buffer to an array of bytes.

Input buffer. An array of bytes that contains the values copied from the input buffer. You must declare the array before calling this method and pass it by using the **ref** keyword. If the buffer for the *input* parameter is empty, then the *value* parameter will be returned as NULL.

Creates a buffer from an input byte array.

An array of bytes used to create the buffer. Output buffer.

Decodes a string that has been base64 encoded.

Base64 encoded input string. Output buffer that contains the decoded string.

Decodes a string that has been hexadecimal encoded.

Encoded input string. Output buffer that contains the decoded string.

Encodes a buffer to a base64 string.

Input buffer. Base64-encoded output string.

Encodes a buffer to a hexadecimal string.

Input buffer. Hexadecimal encoded output string.

Creates a buffer that contains random data.

Length, in bytes, of the buffer to create. Output buffer that contains the random data.

Creates a random number.

Integer that contains the random data.

Represents a cryptography certificate.

Create a new instance of the Certificate class using the specified certificate data.

The certificate data as an ASN.1 DER encoded certificate blob (.cer or .p7b).

Gets a collection of object identifiers (OIDs) for the enhanced key usage extension.

A collection of object identifiers (OIDs) for the enhanced key usage extension

Gets or sets the friendly name for the certificate.

The friendly name for the certificate. If the certificate does not have a friendly name set, then an empty string is returned.

Gets a value indicating whether the certificate has a private key.

True if the certificate has a private key; otherwise false.

Gets whether the certificate is per-user.

True if the certificate is per-user; otherwise, false.

Gets whether the security device is bound.

True if the security device is bound; otherwise, false.

Gets a value that indicates whether the private key associated with the certificate is strongly protected.

True if the certificate is strongly protected; otherwise false.

Gets the name of the certificate issuer.

The name of the certificate issuer.

Gets the name of the cryptographic algorithm used to create the key.

The name of the cryptographic algorithm used to create the key.

Gets the certificate's key storage provider name.

The certificate's key storage provider name.

Gets the key uses for the certificate.

The key uses for the certificate.

Gets the serial number of the certificate.

The serial number of the certificate.

Gets the signature algorithm name.

The signature algorithm name.

Gets the signature hash algorithm name.

The signature hash algorithm name.

Gets the certificate's store name.

The certificate's store name.

Gets the subject name of the certificate.

The subject name of the certificate.

Gets info on the subject alternative name.

Info on the subject alternative name.

Gets the date and time after which the certificate is valid.

The date and time after which the certificate is valid.

Gets the date and time after which the certificate is no longer valid.

The date and time after which the certificate is no longer valid.

Build a certificate chain for the specified certificates starting from the end entity certificate to the root.

The intermediate certificates to use when building the certificate chain. An asynchronous operation to retrieve the CertificateChain object that contains the entire certificate chain.

Build a certificate chain for the specified certificates starting from the end entity certificate to the root using the specified chain building parameters.

The intermediate certificates to use when building the certificate chain. The chain building paramaters to use when building the certificate chain. An asynchronous operation to retrieve the CertificateChain object that contains the entire certificate chain.

Gets the ASN.1 DER encoded certificate blob.

The ASN.1 DER encoded certificate blob.

Gets the SHA1 hash value for the certificate.

The SHA1 hash value for the certificate.

Gets the hash value for the certificate for a specified algorithm.

The hash algorithm to use for the hash value of the certificate. Only values of "SHA1" or "SHA256" are supported. To get the SHA2 hash value for the certificate, specify "SHA256". The hash value of the certificate.

Represents a certificate chain used for signature verification.

Gets the list of certificates from the certificate chain.

True to include the root certificate in the results; otherwise false. The list of certificates from the certificate chain.

Verifies whether or not the certificate chain is valid.

The result of the certificate chain verification operation.

Verifies whether or not the certificate chain is valid using the specified validation parameters.

The validation parameters to use when verifying the certificate chain. The result of the certificate chain verification operation.

Describes the policy to use when performing a certificate chain validation.

Use the base chain policy verification checks.

Check the last element of the first simple chain for a Microsoft root public key.

Use the Windows NT Authentication chain policy checks.

Use the SSL client/server chain policy verification checks.

Represents a certificate enrollment manager.

Gets the associated UserCertificateEnrollmentManager.

The associated UserCertificateEnrollmentManager.

Asynchronously creates a PKCS #10 certificate request based on properties specified in a CertificateRequestProperties object.

A CertificateRequestProperties object that contains the property values used to create the certificate request. This method returns a string that contains the base64 encoded PKCS #10 certificate request.

Asynchronously imports a certificate from a Personal Information Exchange (PFX) message.

Base64-encoded PFX message. The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. A value of the ExportOption enumeration that specifies whether the key can be exported. A value of the KeyProtectionLevel enumeration that specifies the strength of the key protection. The default is **NoConsent**. An InstallOptions enumeration value that specifies the certificate installation option. The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. This method does not return a value.

Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using the specified key storage provider.

Base64-encoded PFX message. The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. A value of the ExportOption enumeration that specifies whether the key can be exported. A value of the KeyProtectionLevel enumeration that specifies the strength of the key protection. The default is **NoConsent**. An InstallOptions enumeration value that specifies the certificate installation option. The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. The name of the key storage provider to use when importing the certificate. This method does not return a value.

Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using import parameters.

Base64-encoded PFX message. The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. The PFX import parameters. This method does not return a value.

Asynchronously Installs a certificate chain into the app container on the local computer.

The encoded certificate. The *certificate* is encoded by using Distinguished Encoding Rules (DER) as defined by the Abstract Syntax Notation One (ASN.1) standard. An InstallOptions enumeration value that specifies the certificate installation option. This method does not return a value.

Represents a certificate extension.

Creates a new certificateExtension object.

Gets or sets a boolean indicating if the certificate extension is critical.

A boolean indicating if the certificate extension is critical.

Gets or sets the object ID.

The object ID.

Gets or sets the value of the certificate extension.

The value of the certificate extension.

Encodes the string value into the value byte array.

The string value to encode.

Represents the usages of a certificate key.

Creates a new instance of the CertificateKeyUsages class.

Gets or sets if the key is for cRLSign.

True if the key is for cRLSign; otherwise, false.

Gets or sets if the key is for data encipherment.

True if the key is for data encipherment; otherwise, false.

Gets or sets if the key is for digital signature.

True if the key is for digital signature; otherwise, false.

Gets or sets if the key is for encipher only.

True if the key is for encipher only; otherwise, false.

Gets or sets if the key is for key agreement.

True if the key is for key agreement; otherwise, false.

Gets or sets if the key is for key certificate sign.

True if the key is for key certificate sign; otherwise, false.

Gets or sets if the key is for key encipherment.

True if the key is for key encipherment; otherwise, false.

Gets or sets if the key is for non-repudiation.

True if the key is for non-repudiation; otherwise, false.

Represents parameters for a query for certificates from the certificate store for an app.

Creates a new instance of a certificate query.

Gets a collection of object identifiers (OIDs) for the enhanced key usage extension to search for.

A collection of object identifiers (OIDs) for the enhanced key usage extension to search for.

Gets or sets the certificate friendly name to search for.

The certificate friendly name to search for.

Gets or sets a value that indicates whether only hardware certificates (SC or TPM) are to be returned from the query.

True if only hardware certificates (SC or TPM) are to be returned from the query; otherwise false.

Gets or sets whether to include duplicates.

True if duplicates are included; otherwise, false.

Gets or sets whether to include expired certificates.

True if expired certificates should be included; otherwise, false.

Gets or sets the name of the certificate issuer to search for.

The name of the certificate issuer to search for.

Gets or sets the store name.

The store name.

Gets or sets a certificate thumbprint to search for.

A certificate thumbprint to search for.

Represents the properties of a certificate request.

Creates and initializes a new instance of the CertificateRequestProperties.

Gets or sets the CA exchange certificate that is used to encrypt a key attestation certificate request.

The CA exchange certificate that is used to encrypt a key attestation certificate request.

Gets or sets the container name.

The container name.

Gets or sets the prefix of the container name.

The prefix of the container name.

Gets or sets the name of the elliptic curve.

The name of the elliptic curve.

Gets or sets the parameters of the elliptic curve.

The parameters of the elliptic curve.

Gets or sets a value that specifies whether the private key created for the request can be exported.

Specifies whether the key can be exported.

Gets a vector of certificate extensions.

A vector of certificate extensions.

Gets or sets the display name of the enrolled certificate.

The display name.

Gets or sets the hash algorithm used when creating the certificate request signature.

Hash algorithm.

Gets or sets the public key algorithm.

Algorithm name.

Gets or sets the level of strong key protection.

Strong key protection level.

Gets or sets the size, in bits, of the private key to be generated.

The size, in bits, of the private key.

Gets or sets the name of the key storage provider (KSP) that will be used to generate the private key.

The KSP name. The default value is "Microsoft Software Key Storage Provider".

Gets or sets the operation that can be performed by the private key created for this certificate request. The default value is **Signing**.

Private key usage.

Gets or sets the certificate used to sign the certificate request.

The certificate used to sign the certificate request.

Gets or sets the name of the smart card reader used to create the certificate request.

The name of the smart card reader used to create the certificate request.

Gets or sets the subject name.

The X.500 distinguished name (DN).

Gets the subject alternative name.

The subject alternative name.

Gets a vector of suppressed defaults.

A vector of suppressed defaults.

Gets or sets whether to use the existing key.

True if using the existing key; otherwise, false.

Represents a certificate store for an app.

Gets the name of the certificate store.

The name of the certificate store.

Adds a certificate to the certificate store.

The certificate to add to the certificate store.

Deletes a certificate from the certificate store.

The certificate to delete from the certificate store.

Represents a collection of certificate stores.

Gets the certificate store of intermediate certification authorities for an app.

The certificate store of intermediate certification authorities for an app.

Gets the certificate store of trusted root certificates for an app.

The certificate store of trusted root certificates for an app.

Get all certificates from the certificate stores.

An asynchronous operation to retrieve the list of certificates.

Get all certificates from the certificate stores that match the specified query parameters.

The certificate values to search for. An asynchronous operation to retrieve the list of certificates.

Gets a certificate store from the collection of certificate stores by name.

The name of the certificate store to return. The *storeName* parameter value cannot be "MY". The requested certificate store.

Gets a user certificate store from the collection of certificate stores by name.

The name of the user certificate store to return. The user certificate store.

Represents parameters to use when building a certificate chain.

Creates a new instance of the ChainBuildingParameters class.

Gets or sets a value that indicates whether Authority Information Access (AIA) is enabled.

True to enable Authority Information Access (AIA); otherwise false. The default is true.

Gets or sets a value indicating that the current time is to be used for the validation timestamp.

True to use the current time as the validation timestamp; otherwise false. The default is true.

Gets a collection of object identifiers (OIDs) for the enhanced key usage extension.

A collection of object identifiers (OIDs) for the enhanced key usage extension.

Gets the list of root certificates that will be trusted.

The list of root certificates that will be trusted.

Gets or sets a value indicating whether to request new URLs to use for chain building and revocation checking or to use cached URLs.

True torequest new URLs to use for chain building and revocation checking; false to use cached URLs.

Gets or sets a value indicating whether revocation checking is enabled.

True to enable revocation checking; otherwise false.

Gets or sets the time stamp used to determine whether the certificate chain was time valid.

The time stamp used to determine whether the certificate chain was time valid.

Represents values to use when verifying a certificate chain.

Creates a new instance of the ChainValidationParameters class.

Gets or sets the certificate chain policy to use when verifying the certificate chain.

The certificate chain policy to use when verifying the certificate chain.

Gets or sets the server DNS name to use for SSL policy.

The server DNS name to use for SSL policy.

Describes the result of a certificate chain verification operation.

The basic constraint extension of a certificate in the chain has not been observed.

A certificate in the chain has expired.

The certificate chain is missing one or more certificates.

A certificate in the chain has a policy that is not valid.

A certificate in the chain has a name that is not valid. The name is either not included in the permitted list or is explicitly excluded.

The signature of a certificate in the chain cannot be verified.

An unexpected error occurred while validating the certificate chain.

Unable to connect to the revocation server.

No installed or registered DLL was found to verify revocation.

A certificate in the chain has been revoked.

The certificate chain was verified.

A certificate in the chain contains an unknown extension that is marked "critical".

A certificate in the chain is not trusted.

A certificate in the chain is being used for a purpose other than one specified by its CA.

Represents a signature attached to a signed CMS message.

Creates a new instance of the CmsAttachedSignature class for the specified signed CMS message.

A signed CMS message blob.

Gets the list of certificates that are used for chain building for the signer certificate.

The list of certificates that are used for chain building for the signer certificate.

Gets the content of the signed CMS message.

The content of the signed CMS message.

Gets the list of signers that are used for creating or verifying the signature.

The list of signers that are used for creating or verifying the signature.

Signs the specified input data using the specified signer information and creates an attached signed CMS message.

The input data to be signed. The signer information used to compute the signature. The list of certificates to build the chain for the signer certificates. An asynchronous operation to retrieve the attached signed CMS message.

Verifies the signature contained in the signed CMS message.

The result of the signature verification operation.

Represents a detached signature for a signed CMS message.

Creates a new instance of the CmsDetachedSignature class for the specified signed CMS message.

A signed CMS message blob.

Gets the list of certificates that are used for chain building for the signer certificate.

The list of certificates that are used for chain building for the signer certificate.

Gets the list of signers that are used for creating or verifying the signature.

The list of signers that are used for creating or verifying the signature.

Signs the specified input data using the specified signer information and creates a detached signed CMS message.

The input data to be signed. The signer information used to compute the signature. The list of certificates to build the chain for the signer certificates. An asynchronous operation to retrieve the detached signed CMS message.

Verifies a signed CMS message against the original streaming input.

The original input stream for the signed CMS message. An asynchronous operation to retrieve the result of the signature validation operation.

Represents signer information for a signed CMS message which contains a set of properties.

Creates a new instance of the CmsSignerInfo class.

Gets or sets the signer certificate that is used to sign the message.

The signer certificate that is used to sign the message.

Gets or sets the hash algorithm that is used to sign the CMS message.

The hash algorithm that is used to sign the CMS message.

Gets the RFC3161 unauthenticated timestamp information.

The RFC3161 unauthenticated timestamp information.

Represents an RFC3161 unauthenticated timestamp attribute in a signed CMS message.

Gets the list of certificates that is used for chain building for the signing certificate.

The list of certificates that is used for chain building for the signing certificate.

Gets the certificate that is used to sign the timestamp.

The certificate that is used to sign the timestamp.

Gets the date and time of the timestamp.

The date and time of the timestamp.

Specifies the cryptographic operations that can be performed by the private key. This enumeration type is used in the KeyUsages property of a CertificateRequestProperties object.

The key can be used for decryption, signing. and key agreement.

The key can be used for decryption.

The key can be used for secret agreement encryption.

No usage is specified for the key.

The key can be used for signing.

Specifies whether a private key can be exported. This enumeration type is used in the Exportable property of a CertificateRequestProperties object.

The private key is exportable.

The private key is not exportable.

Specifies certificate installation options. This enumeration type is used by the InstallCertificateAsync and ImportPfxDataAsync methods.

Delete expired certificates.

No options are specified.

Defines several commonly used public key algorithm names. You can use this class in the KeyAlgorithmName property on the CertificateRequestProperties class.

Returns "DSA" as the key algorithm name.

The key algorithm name.

Returns "ECDH" as the key algorithm name.

The key algorithm name.

Returns "ECDH256" as the key algorithm name.

The key algorithm name.

Returns "ECDH384" as the key algorithm name.

The key algorithm name.

Returns "ECDH521" as the key algorithm name.

The key algorithm name.

Returns "ECDSA" as the key algorithm name.

The key algorithm name.

Returns "ECDSA256" as the key algorithm name.

The key algorithm name.

Returns "ECDSA384" as the key algorithm name.

The key algorithm name.

Returns "ECDSA521" as the key algorithm name.

The key algorithm name.

Returns "RSA" as the key algorithm name.

The key algorithm name.

Provides access to key attestation methods.

Decrypts a TPM key attestation credential.

Decrypts a TPM key attestation credential.

The TPM key attestation credential to decrypt. The container name of the credential. When this method completes, it returns the decrypted TPM key attestation credential.

Gets the credential ID from a TPM key attestation credential.

The TPM key attestation credential to get the credential ID from. The credential ID from the TPM key attestation credential.

Specifies the key protection level. This enumeration type is used in the KeyProtectionLevel property of a CertificateRequestProperties object.

The user is notified through a dialog box when the private key is created or used.

The user is prompted to enter a fingerprint verification for the key when the key is created or used.

The user is prompted to enter a password for the key when the key is created or used.

No strong key protection.

Specifies commonly used RSA algorithm key sizes. This enumeration type can be used in the KeySize property of a CertificateRequestProperties object.

No size is specified.

The key length is 2048 bits.

The key length is 4096 bits.

Defines several commonly used key storage provider names. You can use this class in the KeyStorageProviderName property on the CertificateRequestProperties class.

Returns "Microsoft Passport Key Storage Provider" as the provider name.

The provider name.

Returns "Microsoft Platform Crypyto Key Storage Provider" as the provider name.

The provider name.

Returns "Microsoft Smart Card Key Storage Provider" as the provider name.

The provider name.

Returns "Microsoft Software Key Storage Provider" as the provider name.

The provider name.

Represents PFX import parameters.

Creates a new instance of the PfxImportParameters class.

Gets or sets the container name prefix.

The container name prefix.

Gets or sets the export option.

The export option.

Gets or sets the friendly name.

The friendly name.

Gets or sets the install options.

The install options.

Gets or sets the key protection level.

The key protection level.

Gets or sets the key storage provider name.

The key storage provider name.

Gets or sets the reader name.

The reader name.

Describes the result of a signature verification operation.

A severe error occurred such as missing key provider information or an incorrect algorithm id.

An invalid argument was encountered while verifying the signature.

The signature was not verified.

Additional errors were encountered.

The signature was verified.

Provides properties for retrieving standard certificate store names.

Gets the name of the intermediate certificate authorities.

The name of the intermediate certificate authorities.

Gets the name of the personal certificate store.

The name of the personal certificate store.

Gets the name of the trusted root certificate authorities.

The name of the trusted root certificate authorities.

Provides info about a subject alternative name.

Creates a new instance of the SubjectAlternativeNameInfo class.

Gets the distinguished name.

The distinguished name.

Gets a vector of distinguished names.

A vector of distinguished names.

Gets the DNS name.

The DNS name.

Gets a vector of dns names.

A vector of dns names.

Gets the email name.

The email name.

Gets a vector of email names.

A vector of email names.

Gets the certificate extension.

The certificate extension.

Gets the IP address.

The IP address.

Gets the IP addresses.

The IP addresses.

Gets the principal name.

The principal name.

Gets a vector of principal names.

A vector of principal names.

Gets the URL.

The URL.

Gets a vector of URLs.

A vector of URLs.

Provides access to certificate creation, import, and enrollment methods.

Asynchronously creates a PKCS #10 certificate request based on properties specified in a CertificateRequestProperties object.

A CertificateRequestProperties object that contains the property values used to create the certificate request. An asynchronous operation to retrieve the base64 encoded PKCS #10 certificate request.

Asynchronously imports a user certificate from a Personal Information Exchange (PFX) message.

Base64-encoded PFX message. The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. A value of the ExportOption enumeration that specifies whether the key can be exported. A value of the KeyProtectionLevel enumeration that specifies the strength of the key protection. The default is **NoConsent**. An InstallOptions enumeration value that specifies the certificate installation option. The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. This method does not return a value.

Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using the specified key storage provider.

Base64-encoded PFX message. The password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. A value of the ExportOption enumeration that specifies whether the key can be exported. A value of the KeyProtectionLevel enumeration that specifies the strength of the key protection. The default is **NoConsent**. An InstallOptions enumeration value that specifies the certificate installation option. The display name of the enrolled certificate. This value overwrites the **FriendlyName** property inside the PFX message. The name of the key storage provider to use when importing the certificate. This method does not return a value.

Asynchronously imports a certificate from a Personal Information Exchange (PFX) message using the specified import parameters.

Base64-encoded PFX message. he password used to decrypt and verify the PFX packet. The password must be exactly the same as the password that was used to encrypt the packet. The import parameters. This method does not return a value.

Asynchronously installs a certificate chain into the app container on the local computer.

The encoded certificate. The *certificate* is encoded by using Distinguished Encoding Rules (DER) as defined by the Abstract Syntax Notation One (ASN.1) standard. An InstallOptions enumeration value that specifies the certificate installation option. This method does not return a value.

Represents a user certificate store.

Gets the name of the store.

The name of the store.

Requests to add a certificate to the store.

The certificate to add. When this method completes, it returns true if the certificate was successfully added; otherwise, it returns false.

Requests to delete a certificate from the store.

The certificate to delete. When this method completes, it returns true if the certificate was successfully deleted; otherwise, it returns false.

Contains static properties that enable you to retrieve algorithm names that can be used in the OpenAlgorithm method of the AsymmetricKeyAlgorithmProvider class.

Retrieves a string that contains "DSA_SHA1".

String that contains "DSA_SHA1".

Retrieves a string that contains "DSA_SHA256".

String that contains "DSA_SHA256".

Retrieves a string that contains "ECDSA_P256_SHA256".

String that contains "ECDSA_P256_SHA256".

Retrieves a string that contains "ECDSA_P384_SHA384".

String that contains "ECDSA_P384_SHA384".

Retrieves a string that contains "ECDSA_P521_SHA512".

String that contains "ECDSA_P521_SHA512".

Retrieves a string that contains "ECDSA_SHA256".

String that contains "ECDSA_SHA256".

Retrieves a string that contains "ECDSA_SHA384".

String that contains "ECDSA_SHA384".

Retrieves a string that contains "ECDSA_SHA512".

String that contains "ECDSA_SHA512".

Retrieves a string that contains "RSA_OAEP_SHA1".

String that contains "RSA_OAEP_SHA1".

Retrieves a string that contains "RSA_OAEP_SHA256".

String that contains "RSA_OAEP_SHA256".

Retrieves a string that contains "RSA_OAEP_SHA384".

String that contains "RSA_OAEP_SHA384".

Retrieves a string that contains "RSA_OAEP_SHA512".

String that contains "RSA_OAEP_SHA512".

Retrieves a string that contains "RSA_PKCS1".

String that contains "RSA_PKCS1".

Retrieves a string that contains "RSASIGN_PKCS1_SHA1".

String that contains "RSASIGN_PKCS1_SHA1".

Retrieves a string that contains "RSASIGN_PKCS1_SHA256".

String that contains "RSASIGN_PKCS1_SHA256".

Retrieves a string that contains "RSASIGN_PKCS1_SHA384".

String that contains "RSASIGN_PKCS1_SHA384".

Retrieves a string that contains "RSASIGN_PSS_SHA512".

String that contains "RSASIGN_PSS_SHA512".

Retrieves a string that contains "RSASIGN_PSS_SHA1".

String that contains "RSASIGN_PSS_SHA1".

Retrieves a string that contains "RSASIGN_PSS_SHA256".

String that contains "RSASIGN_PSS_SHA256".

Retrieves a string that contains "RSASIGN_PSS_SHA384".

String that contains "RSASIGN_PSS_SHA384".

Retrieves a string that contains "RSASIGN_PSS_SHA512".

String that contains "RSASIGN_PSS_SHA512".

Represents a provider of asymmetric (public) key algorithms. For more information, see Cryptographic keys.

Gets the name of the open asymmetric algorithm.

Algorithm name.

Creates a public/private key pair.

Size, in bits, of the key. Typical key sizes are 512, 1024, 2048, or 4096 bits. Represents the asymmetric key pair.

Creates a public/private key pair using a curve name.

The name of the curve. Represents the asymmetric key pair.

Creates a public/private key pair using curve parameters.

The curve parameters. Represents the asymmetric key pair.

Imports a public/private key pair from a buffer.

Buffer that contains the key pair to import. Represents the imported key pair.

Imports a public/private key pair from a buffer in the specified format.

Buffer that contains the key pair to import. A CryptographicPrivateKeyBlobType enumeration value that specifies information about the private key contained in the *keyBlob* buffer. The default value is **Pkcs8RawPrivateKeyInfo**. Represents the imported key pair.

Imports a public key into a buffer.

Buffer that contains the key to import. Represents the imported key.

Imports a public key into a buffer for a specified format.

Buffer that contains the key to import. A CryptographicPublicKeyBlobType enumeration value that specifies the format of the public key contained in the *keyBlob* buffer. The default value is **X509SubjectPublicKeyInfo**. Represents the imported key.

Creates an instance of the AsymmetricKeyAlgorithmProvider class and opens the specified algorithm for use.

Algorithm name. Represents a public key algorithm provider.

Represents information about a target algorithm.

The target algorithm is AES.

The target algorithm is not AES.

Encrypts, decrypts, and signs content, and verifies digital signatures.

Decrypts content that was previously encrypted by using a symmetric or asymmetric algorithm.

Cryptographic key to use for decryption. This can be an asymmetric or a symmetric key. For more information, see AsymmetricKeyAlgorithmProvider and SymmetricKeyAlgorithmProvider. Buffer that contains the encrypted data. Buffer that contains the initialization vector. If an initialization vector (IV) was used to encrypt the data, you must use the same IV to decrypt the data. For more information, see Encrypt. Decrypted data.

Decrypts and authenticates data. For more information and a complete code sample, see EncryptedAndAuthenticatedData.

Symmetric key to use. Data to be decrypted and authenticated. Nonce to be used. This must be the same nonce used by the EncryptAndAuthenticate method. Authentication tag. Authenticated data. This can be **Null**. A buffer that contains the decrypted data.If the method fails, authentication fails; if the method succeeds, the authentication succeeded as well.

Decrypts the encrypted input data using the supplied key.

The key to use to decrypt the encrypted input data. The encrypted data to decrypt. The initial vector for a symmetric key. For an asymmetric key, set this value to null. The decrypted data.

Derives a key from another key by using a key derivation function. For more information, see the KeyDerivationAlgorithmProvider and KeyDerivationParameters classes.

The symmetric or secret key used for derivation. Derivation parameters. The parameters vary depending on the type of KDF algorithm used. Requested size, in bytes, of the derived key. Buffer that contains the derived key.

Encrypts data by using a symmetric or asymmetric algorithm.

Cryptographic key to use for encryption. This can be an asymmetric or a symmetric key. For more information, see AsymmetricKeyAlgorithmProvider and SymmetricKeyAlgorithmProvider. Data to encrypt. Buffer that contains the initialization vector. This can be **null** for a symmetric algorithm and should always be **null** for an asymmetric algorithm. If an initialization vector (IV) was used to encrypt the data, you must use the same IV to decrypt the data. You can use the GenerateRandom method to create an IV that contains random data. Other IVs, such as nonce-generated vectors, require custom implementation. For more information, see Cryptographic keys. Encrypted data.

Performs authenticated encryption.

Symmetric key to use for encryption. Data to be encrypted and authenticated. Nonce to be used. A nonce is a variable that has minimal chance of repeating. For example, you can use a random value that is newly generated for each use, a time stamp, a sequence number, or some combination of these. The Microsoft GCM implementation requires a 12-byte nonce. The CCM implementation requires a 7- to 13- byte nonce. Authenticated data. This can be **Null**. The encrypted and authenticated data.If the method fails, authentication fails; if the method succeeds, the authentication succeeded as well.

Signs digital content. For more information, see MACs, hashes, and signatures.

Key used for signing. Data to be signed. The data's signature.

Computes a hash for the supplied input data, and then signs the computed hash using the specified key.

The key to use to compute and sign the hash. The raw input data to sign. The data is not hashed. An asynchronous operation to retrieve the hashed and signed data.

Signs the hashed input data using the specified key.

The key to use to sign the hash. This key must be an asymmetric key obtained from a PersistedKeyProvider or AsymmetricKeyAlgorithmProvider. The input data to sign. The data is a hashed value which can be obtained through incremental hash. The signed data.

Signs the hashed input data using the specified key.

The key to use to sign the hash. This key must be an asymmetric key obtained from a PersistedKeyProvider or AsymmetricKeyAlgorithmProvider. The input data to sign. The data is a hashed value which can be obtained through incremental hash. An asynchronous operation to retrieve the signed data.

Verifies a message signature.

Key used for verification. This must be the same key previously used to sign the message. Message to be verified. Signature previously computed over the message to be verified. **true** if the message is verified.

Verifies the signature of the specified input data against a known signature.

The key to use to retrieve the signature from the input data. This key must be an asymmetric key obtained from a PersistedKeyProvider or AsymmetricKeyAlgorithmProvider. The data to be verified. The data is a hashed value of raw data. The known signature to use to verify the signature of the input data. True if the signature is verified; otherwise false.

Represents a reusable hashing object and contains the result of a hashing operation.

Appends a binary encoded string to the data stored in the CryptographicHash object.

Data to append.

Gets hashed data from the CryptographicHash object and resets the object.

Hashed data.

Represents a symmetric key or an asymmetric key pair.

Gets the size, in bits, of the key.

Integer that contains the number of bits in the key.

Exports the key pair to a buffer.

Buffer that contains the key pair.

Exports the key pair to a buffer given a specified format.

A CryptographicPrivateKeyBlobType enumeration value that specifies the format of the key in the buffer. The default value is **Pkcs8RawPrivateKeyInfo**. Buffer that contains the key pair.

Exports a public key to a buffer.

Buffer that contains the public key.

Exports a public key to a buffer given a specified format.

A CryptographicPublicKeyBlobType enumeration value that specifies the format of the key in the buffer. The default value is **X509SubjectPublicKeyInfo**. Buffer that contains the public key.

Specifies a padding mode for asymmetric algorithm signature or encryption operations.

Do not use padding.

Use the Optimal Asymmetric Encryption Padding (OAEP) scheme.

Use the standard padding scheme for public-key cryptography based on the RSA algorithm as defined in RFC 3447.

Use the Probabilistic Signature Scheme (PSS) scheme.

Specifies the type of the private key contained in a buffer.

The key is a BCrypt full elliptic curve cryptography (ECC) private key.

Microsoft private key format defined by Cryptography API: Next Generation (CNG). For examples, see the following CNG structures:

Microsoft private key format defined by the legacy Cryptography API (CAPI). For more information, see Base Provider Key BLOBs.

The key is an RSA private key defined in the PKCS #1 standard. For more information, see the RSA Cryptography Specification in RFC 3347.

This is the default value. The private key is encoded as an ASN.1 **PrivateKeyInfo** type defined in the PKCS#8 standard. The private key information syntax is defined as follows in RFC 5208.

Specifies the type of the public key contained in a buffer.

The key is a BCrypt full elliptic curve cryptography (ECC) private key.

Microsoft public key format defined by Cryptography API: Next Generation (CNG). For examples, see the following CNG structures:

Microsoft public key format defined by the legacy Cryptography API (CAPI). For more information, see Base Provider Key BLOBs.

The key is an RSA public key defined in the PKCS #1 standard. For more information, see the RSA Cryptography Specification in RFC 3347.

This is the default value. The public key is encoded as an ASN.1 **SubjectPublicKeyInfo** type defined in RFC 5280 and RFC 3280.

Contains static properties that enable you to retrieve supported elliptic curve cryptography (ECC) algorithm names.

Gets an array of strings that represents all the curves registered on the local computer. This includes curves that were registered by the local administrator.

An array of strings that represents all the curves registered on the local computer.

Retrieves a string that contains "BRAINPOOLP160R1".

String that contains "BRAINPOOLP160R1".

Retrieves a string that contains "BRAINPOOLP160T1".

String that contains "BRAINPOOLP160T1".

Retrieves a string that contains "BRAINPOOLP192R1".

String that contains "BRAINPOOLP192R1".

Retrieves a string that contains "BRAINPOOLP192T1".

String that contains "BRAINPOOLP192T1".

Retrieves a string that contains "BRAINPOOLP224R1".

String that contains "BRAINPOOLP224R1".

Retrieves a string that contains "BRAINPOOLP224T1".

String that contains "BRAINPOOLP224T1".

Retrieves a string that contains "BRAINPOOLP256R1".

String that contains "BRAINPOOLP256R1".

Retrieves a string that contains "BRAINPOOLP256T1".

String that contains "BRAINPOOLP256T1".

Retrieves a string that contains "BRAINPOOLP320R1".

String that contains "BRAINPOOLP320R1".

Retrieves a string that contains "BRAINPOOLP320T1".

String that contains "BRAINPOOLP320T1".

Retrieves a string that contains "BRAINPOOLP384R1".

String that contains "BRAINPOOLP384R1".

Retrieves a string that contains "BRAINPOOLP384T1".

String that contains "BRAINPOOLP384T1".

Retrieves a string that contains "BRAINPOOLP512R1".

String that contains "BRAINPOOLP512R1".

Retrieves a string that contains "BRAINPOOLP512T1".

String that contains "BRAINPOOLP512T1".

Retrieves a string that contains "CURVE25519".

String that contains "CURVE25519".

Retrieves a string that contains "EC192WAPI".

String that contains "EC192WAPI".

Retrieves a string that contains "NISTP192".

String that contains "NISTP192".

Retrieves a string that contains "NISTP224".

String that contains "NISTP224".

Retrieves a string that contains "NISTP256".

String that contains "NISTP256".

Retrieves a string that contains "NISTP384".

String that contains "NISTP384".

Retrieves a string that contains "NISTP521".

String that contains "NISTP521".

Retrieves a string that contains "NUMSP256T1".

String that contains "NUMSP256T1".

Retrieves a string that contains "NUMSP384T1".

String that contains "NUMSP384T1".

Retrieves a string that contains "NUMSP512T1".

String that contains "NUMSP512T1".

Retrieves a string that contains "SECP160K1".

String that contains "SECP160K1".

Retrieves a string that contains "SECP160R1".

String that contains "SECP160R1".

Retrieves a string that contains "SECP160R2".

String that contains "SECP160R2".

Retrieves a string that contains "SECP192K1".

String that contains "SECP192K1".

Retrieves a string that contains "SECP192R1".

String that contains "SECP192R1".

Retrieves a string that contains "SECP224K1".

String that contains "SECP224K1".

Retrieves a string that contains "SECP224R1".

String that contains "SECP224R1".

Retrieves a string that contains "SecP256k1".

String that contains "SecP256k1".

Retrieves a string that contains "SecP256r1".

String that contains "SecP256r1".

Retrieves a string that contains "SecP384r1".

String that contains "SecP384r1".

Retrieves a string that contains "SecP521r1".

String that contains "SecP521r1".

Retrieves a string that contains "WTLS12".

String that contains "WTLS12".

Retrieves a string that contains "WTLS7".

String that contains "WTLS7".

Retrieves a string that contains "WTLS9".

String that contains "WTLS9".

Retrieves a string that contains "X962P192v1".

String that contains "X962P192v1".

Retrieves a string that contains "X962P192v2".

String that contains "X962P192v2".

Retrieves a string that contains "X962P192v3".

String that contains "X962P192v3".

Retrieves a string that contains "X962P239v1".

String that contains "X962P239v1".

Retrieves a string that contains "X962P239v2".

String that contains "X962P239v2".

Retrieves a string that contains "X962P239v3".

String that contains "X962P239v3".

Retrieves a string that contains "X962P256v1".

String that contains "X962P256v1".

Contains data that can be retrieved from encrypted and authenticated data. Authenticated encryption algorithms are opened by using the SymmetricKeyAlgorithmProvider class.

Gets the authentication tag.

Buffer that contains the tag.

Gets the encrypted data.

Buffer that contains the encrypted data.

Contains static properties that enable you to retrieve algorithm names that can be used in the OpenAlgorithm method of the HashAlgorithmProvider class.

Retrieves a string that contains "MD5".

String that contains "MD5".

Retrieves a string that contains "SHA1".

String that contains "SHA1".

Retrieves a string that contains "SHA256".

String that contains "SHA256".

Retrieves a string that contains "SHA384".

String that contains "SHA384".

Retrieves a string that contains "SHA512".

String that contains "SHA512".

Represents a cryptographic hash provider. For more information about hashes, see MACs, hashes, and signatures.

Gets the name of the open hash algorithm.

Algorithm name.

Gets the length, in bytes, of the hash.

Number of bytes in the hash.

Creates a reusable CryptographicHash object.

Reusable hash object.

Hashes binary data.

Data to be hashed. Hashed data.

Creates a HashAlgorithmProvider object and opens the specified algorithm for use.

Algorithm name. Represents a provider that implements hash algorithms.

Contains static properties that enable you to retrieve algorithm names that can be used in the OpenAlgorithm method of the KeyDerivationAlgorithmProvider class.

Retrieves a string that contains "CAPI_KDF_MD5".

String that contains "CAPIKDF_MD5".

Retrieves a string that contains "CAPI_KDF_SHA1".

String that contains "CAPIKDF_SHA1".

Retrieves a string that contains "CAPI_KDF_SHA256".

String that contains "CAPIKDF_SHA256".

Retrieves a string that contains "CAPI_KDF_SHA384".

String that contains "CAPIKDF_SHA384".

Retrieves a string that contains "CAPI_KDF_SHA512".

String that contains "CAPIKDF_SHA512".

Retrieves a string that contains "PBKDF2_MD5".

String that contains "PBKDF2_MD5".

Retrieves a string that contains "PBKDF2_SHA1".

String that contains "PBKDF2_SHA1".

Retrieves a string that contains "PBKDF2_SHA256".

String that contains "PBKDF2_SHA256".

Retrieves a string that contains "PBKDF2_SHA384".

String that contains "PBKDF2_SHA384".

Retrieves a string that contains "PBKDF2_SHA512".

String that contains "PBKDF2_SHA512".

Retrieves a string that contains "SP800_108_CTR_HMAC_MD5".

String that contains "SP800_108_CTR_HMAC_MD5".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA1".

String that contains "SP800_108_CTR_HMAC_SHA1".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA256".

String that contains "SP800_108_CTR_HMAC_SHA256".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA384".

String that contains "SP800_108_CTR_HMAC_SHA384".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA512".

String that contains "SP800_108_CTR_HMAC_SHA512".

Retrieves a string that contains "SP800_56A_CONCAT_MD5".

String that contains "SP800_56A_CONCAT_MD5".

Retrieves a string that contains "SP800_56A_CONCAT_SHA1".

String that contains "SP800_56A_CONCAT_SHA1".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA256".

String that contains "SP800_108_CTR_HMAC_SHA256".

Retrieves a string that contains "SP800_108_CTR_HMAC_SHA384".

String that contains "SP800_108_CTR_HMAC_SHA384".

Retrieves a string that contains "SP800_56A_CONCAT_SHA512".

String that contains "SP800_56A_CONCAT_SHA512".

Represents a key derivation algorithm provider.

Gets the name of the open key derivation function (KDF) algorithm.

Algorithm name.

Creates a KDF key.

Data used to create the key. Represents the KDF key.

Creates an instance of the KeyDerivationAlgorithmProvider class and opens the specified algorithm for use.

Represents a KDF algorithm provider. The algorithm provider.

Represents parameters used when deriving a key.

Gets or sets the Capi1KdfTargetAlgorithm.

The Capi1KdfTargetAlgorithm.

Retrieves the number of iterations used to derive the key. For more information, see BuildForPbkdf2.

Iteration count.

Gets or sets the parameters used by the key derivation algorithm.

Buffer that contains the parameters.

Creates a KeyDerivationParameters object for use in the target algorithm.

The target algorithm. Refers to the parameters used during key derivation.

Creates a KeyDerivationParameters object for use in the password-based key derivation function 2 (PBKDF2).

The salt, a random or pseudorandom value to be combined with the password in multiple iterations. A salt is used to increase entropy above what can be obtained from using a password alone. Number of iterations to be used to derive a key. Refers to the parameters used during key derivation.

Creates a KeyDerivationParameters object for use in a counter mode, hash-based message authentication code (HMAC) key derivation function.

Buffer that specifies the purpose for the derived keying material. Buffer that specifies information related to the derived keying material. For example, the context can identify the parties who are deriving the keying material and, optionally, a nonce known by the parties. Refers to the parameters used during key derivation.

Creates a KeyDerivationParameters object for use in the SP800-56A key derivation function.

Specifies the intended purpose of the derived key. Contains public information contributed by the initiator. Contains public information contributed by the responder. Contains public information known to both initiator and responder. Contains private information known to both initiator and responder, such as a shared secret. Refers to the parameters used during key derivation.

Contains static properties that enable you to retrieve algorithm names that can be used in the OpenAlgorithm method of the MacAlgorithmProvider class.

Retrieves a string that contains "AES_CMAC".

String that contains "AesCmac".

Retrieves a string that contains "HMAC_MD5".

String that contains "HMAC_MD5".

Retrieves a string that contains "HMAC_SHA1".

String that contains "HMAC_SHA1".

Retrieves a string that contains "HMAC_SHA256".

String that contains "HMAC_SHA256".

Retrieves a string that contains "HMAC_SHA384".

String that contains "HMAC_SHA384".

Retrieves a string that contains "HMAC_SHA512".

String that contains "HMAC_SHA512".

Represents a message authentication code (MAC). A MAC uses symmetric key cryptography to prevent message tampering. For more information, see MACs, hashes, and signatures.

Gets the name of the open MAC algorithm.

Algorithm name.

Gets the length, in bytes, of the message authentication code.

Number of bytes in the MAC.

Creates a CryptographicHash object that supports incremental hash operations.

Random data used to help generate the hash. You can call the GenerateRandom method to create the random data. A CryptographicHash object that supports incremental hash operations.

Creates a symmetric key that can be used to create the MAC value.

Random data used to help generate the key. You can call the GenerateRandom method to create the random data. Symmetric key.

Creates a MacAlgorithmProvider object and opens the specified algorithm for use.

Algorithm name. Represents a provider that implements MAC algorithms.

Retrieves a persisted key from a Certificate object.

Opens the persisted private key from the specified Certificate object.

The certificate that is associated with the private key. The hash algorithm for signature operations. For encryption, the hash algorithm is ignored. The padding mode for asymmetric algorithm signature or encryption operations. An asynchronous operation for retrieving a private key from the supplied Certificate object.

Opens the persisted public key from the specified Certificate object.

The certificate that contains the public key. The has algorithm for signature operations. The padding mode for asymmetric algorithm signature or encryption operations. The public key retrieved from the supplied Certificate object.

Contains static properties that enable you to retrieve algorithm names that can be used in the OpenAlgorithm method of the SymmetricKeyAlgorithmProvider class.

Retrieves a string that contains "AES_CBC".

String that contains "AES_CBC".

Retrieves a string that contains "AES_CBC_PKCS7".

String that contains "AES_CBC_PKCS7".

Retrieves a string that contains "AES_CCM".

String that contains "AES_CCM".

Retrieves a string that contains "AES_ECB".

String that contains "AES_ECB".

Retrieves a string that contains "AES_ECB_PKCS7".

String that contains "AES_ECB_PKCS7".

Retrieves a string that contains "AES_CCM".

String that contains "AES_CCM".

Retrieves a string that contains "DES_CBC".

String that contains "DES_CBC".

Retrieves a string that contains "DES_CBC_PKCS7".

String that contains "DES_CBC_PKCS7".

Retrieves a string that contains "DES_ECB".

String that contains "DES_ECB".

Retrieves a string that contains "DES_ECB_PKCS7".

String that contains "DES_ECB_PKCS7".

Retrieves a string that contains "RC2_CBC".

String that contains "RC2_CBC".

Retrieves a string that contains "RC2_CBC_PKCS7".

String that contains "RC2_CBC_PKCS7".

Retrieves a string that contains "RC2_ECB".

String that contains "RC2_ECB".

Retrieves a string that contains "RC2_ECB_PKCS7".

String that contains "RC2_ECB_PKCS7".

Retrieves a string that contains "RC4".

String that contains "RC4".

Retrieves a string that contains "3DES_CBC".

String that contains "3DES_CBC".

Retrieves a string that contains "3DES_CBC_PKCS7".

String that contains "3DES_CBC_PKCS7".

Retrieves a string that contains "3DES_ECB".

String that contains "3DES_ECB".

Retrieves a string that contains "3DES_ECB_PKCS7".

String that contains "3DES_ECB_PKCS7".

Represents a provider of symmetric key algorithms. For more information, see Cryptographic keys.

Gets the name of the open symmetric algorithm.

Algorithm name.

Gets the size, in bytes, of the cipher block for the open algorithm.

Block size.

Creates a symmetric key.

Data used to generate the key. You can call the GenerateRandom method to create random key material. Symmetric key.

Creates an instance of the SymmetricKeyAlgorithmProvider class and opens the specified algorithm for use.

Algorithm name. Represents a symmetric key algorithm provider.

Represents a cryptographic provider that can be used to asynchronously encrypt and decrypt static data or a data stream.

Constructor used for decryption operations. Use this constructor before calling the UnprotectAsync or UnprotectStreamAsync methods.

Constructor used for encryption operations. Use this constructor before calling the ProtectAsync or ProtectStreamAsync methods.

Contains the protection descriptor that determines the entity to which the data will be encrypted. For more information, see Remarks.

Asynchronously protects static data.

Data to protect. Represents an asynchronous operation.

Asynchronously protects a data stream.

Stream to be protected. Protected stream. Represents an asynchronous action.

Asynchronously decrypts static data.

Data to decrypt. Represents an asynchronous operation.

Asynchronously decrypts a data stream.

Stream to decrypt. Decrypted stream. Represents an asynchronous action.

Identifies the availability of protected data.

Data protected to this availability are accessible only after the first device unlock, and will continue to stay available thereafter.

Data are unprotected when associated with this availability, and are always accessible whether the device is locked or unlocked.

Data protected to this availability are only available when the device is unlocked.

Contains information about UserDataAvailabilityStateChangedEvent.

Returns a Deferral object that can be used to block future events delivered on the UserDataProtectionManager object that was used to register for the event. Callers can call 'Complete' method on the Deferral object to unblock future events.

The Deferral object.

Contains result status of unprotecting a buffer and if succeeded, the unprotected buffer.

Result status of unprotecting a buffer.

A value of the UserDataBufferUnprotectStatus enumeration.

Copy of the unprotected buffer, if the unprotect call succeeded.

The unprotected buffer.

Describes the unprotect state of the provided buffer.

Unprotecting the provided buffer succeeded and the result buffer is available in 'UnprotectedBuffer' member.

Unprotecting the provided buffer is not possible as the protected data is currently unavailable.

Provides static methods to instantiate UserDataProtectionManager for the current or provided user. An instance of UserDataProtectionManager provides methods to protect / unprotect files and buffers.

This event invokes listeners when the state of data availability has changed. For example, when the device locks, data protected to the 'WhileUnlocked' UserDataAvailability becomes unavailable. This state change can be listened to by subscribing to this event.

Gets the current protection information for a storage item.

Storage item to query protection from.

Allows querying whether data protected to a specified availability will continue to stay available for a reasonable duration from now.

Protects a buffer to a specified availability.

A copy of the resultant protected buffer.

Protects a storage item to the specified availability.

Returns a UserDataProtectionManager instance for the current or default user. Caller must check if the returned object is null. If a null object is returned, UserDataProtectionManager is not supported on the system.

Returns a UserDataProtectionManager instance for the specified user object. Windows.System.User.FindAllAsync() can be used to find users on the system. Caller must check if the returned object is null. If it null, UserDataProtectionManager is not supported on the system.

Unprotect a buffer that has been protected using 'ProtectBufferAsync'.

The protected buffer.

Contains information about the protection of a user data storage item.

Current availability of the storage item.

Result of protecting a storage item.

Requested protection cannot be applied as the data are currently unavailable. For example, changing availability from 'WhileUnlocked' to 'AfterFirstUnlock' is not possible while the device is locked.

The system does not support protection of the specified storage item.

Requested protection was successfully applied.

Possible results when access to protected content is requested or queried.

Access is allowed.

Access is blocked.

Consent is required for access.

Provides the app with the ability to retrieve device information from the local device.

Creates an instance of an object that allows the caller app to retrieve device information from the local device.

Gets the friendly name of the local device. This value might come from a NetBIOS computer name.

A string containing the friendly name of the local device. The value is fewer than 1024 characters long.

Returns the identifier of the local device.

The identifier of the local device. The value range is 16 bytes.

Gets the name of the operating system of the local device.

A string containing the operating system of the local device.

Gets the system firmware version of the local device.

A string containing the system firmware version of the local device.

Gets the system hardware version of the local device.

A string containing the system hardware version of the local device.

Gets the system manufacturer of the local device. Use **SystemManufacturer** only if the value of SystemSku is empty.

A string containing the system manufacturer of the local device. The value is fewer than 1024 characters long.

Gets the system product name of the local device. Use **SystemProductName** only if the value of SystemSku is empty.

A string containing the system product name of the local device. The value is fewer than 1024 characters long.

Gets the system SKU of the local device.

A string containing the system SKU of the local device.

Derives contextual insights from images or text that let the user learn more about the content, or perform an action based on it.

Gets the user associated with the current CortanaActionableInsights object.

The User associated with the current CortanaActionableInsights object.

Retrieves a CortanaActionableInsights object for the current user.

The insights for the current user.

Retrieves a CortanaActionableInsights object for the specified user.

The user. The insights for the specified user.

Asynchronously retrieves whether insights can be generated on the user's current system.

An IAsyncOperation object used to control asynchronous execution. The IAsyncOperation will contain **true** if insights can be generated. Otherwise, **false**.

Asynchronously retrieves and displays insights based on the specified text and image content.

The text and image content that defines the scope of the insights returned. Returns an IAsyncAction object that is used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Asynchronously retrieves and displays insights based on the specified text and image content and options.

The text and image content that defines the scope of the insights returned. The options that constrain the scope of the insights returned, such as metadata derived from the surrounding context of the text and image content. Returns an IAsyncAction object that is used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Asynchronously retrieves and displays insights based on the specified image content.

The image that defines the scope of the insights returned. Returns an IAsyncAction object that is used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Asynchronously retrieves and displays insights based on the specified image content and options.

The image that defines the scope of the insights returned. The options that constrain the scope of the insights returned. Returns an IAsyncAction object that is used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Asynchronously retrieves and displays insights based on the specified text content.

The text that defines the scope of the insights returned. Returns an IAsyncAction object that is used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Asynchronously retrieves and displays insights based on the specified text content and options.

The text that defines the scope of the insights returned. The options that constrain the scope of the insights returned. Returns an IAsyncAction object used to control asynchronous execution. If the system does not support showing insights, the method has no effect. An app can check for this case using the IsAvailableAsync method.

Specifies options for refining the insights retrieved through the CortanaActionableInsights methods.

Creates a CortanaActionableInsightsOptions object.

A URI that identifies where the specified text or image content originated.

The web link address. This value can be null.

Text from the surrounding context of the content supplied to CortanaActionableInsights for showing insights.

The textual context surrounding the content (maximum length of 3000 characters). This value can be null.

Specifies the Cortana permissions available to a CortanaPermissionManager object.

CortanaPermission is deprecated and might not work on all platforms. For more info, see MSDN.

Cortana can access the user's web browsing history.

Cortana can access the user's calendar.

Cortana can access the user's call history.

Cortana can access the user's contacts.

Cortana can send email.

Cortana can access input personalization settings.

Cortana can access the user's location.

Cortana can send text messages.

Cortana can access the microphone.

Cortana personalization settings are exposed.

Cortana can make phone calls.

Specifies the possible results from setting permissions using the CortanaPermissionsManager.

CortanaPermissionsChangeResult is deprecated and might not work on all platforms. For more info, see MSDN.

Changes to settings are not permitted.

Setting all permissions succeeded.

Setting one or more permissions failed.

Provides access to the users Cortana authorization settings.

CortanaPermissionsManager is deprecated and might not work on all platforms. For more info, see MSDN.

Asynchronously retreives whether the specified permissions are granted.

ICortanaPermissionsManager is deprecated and might not work on all platforms. For more info, see MSDN. The collection of permissions of interest. **true** if permission is granted. Otherwise, **false**.

Retrieves the Cortana permissions for the current user.

ICortanaPermissionsManagerStatics is deprecated and might not work on all platforms. For more info, see MSDN.

Asynchronously grants the specified set of Cortana permissions.

ICortanaPermissionsManager is deprecated and might not work on all platforms. For more info, see MSDN. The collection of permissions to grant. The result of the permission operation.

Retrieves whether Cortana is supported.

ICortanaPermissionsManager is deprecated and might not work on all platforms. For more info, see MSDN. **true** if Cortana is supported. Otherwise, **false**.

Asynchronously revokes the specified set of Cortana permissions.

ICortanaPermissionsManager is deprecated and might not work on all platforms. For more info, see MSDN. The collection of permissions to revoke. The result of the permission operation.

Represents a stop, start, or intermediate waypoint that a route must pass through.

Creates an instance of the EnhancedWayPoint class.

The coordinates of a geographic location. The type of waypoint.

Gets the type of waypoint.

The type of waypoint.

Gets the coordinates of a geographic location.

The coordinates of a geographic location.

Represents a potential issue along a route leg.

Gets the type of potential issue along a route leg.

The type of potential issue along a route leg.

Gets the severity of a potential issue along a route leg.

The severity of a potential issue along a route leg.

Specifies the type of potential issue along a route leg.

There is a traffic accident.

The route has left one administrative division and entered another.

There is an alert.

The road is closed or blocked.

Check a time table. This usually refers to a ferry or auto rail time table.

The traffic is slow.

There is construction along the route. This value is used for any type of construction and not just construction that has specific start and end dates.

The route has left one country and entered another.

There is a disabled vehicle.

A gate blocks the road and access is required to continue along the route.

Get off the transit at this location.

Get on the transit at this location.

A U-turn is illegal at this location.

There is mass transit incident.

A miscellaneous warning is available for this location.

There is no incident at this location.

There is no warning at this location.

There is a warning at this location that cannot be classified as any other type of warning.

There is additional traffic incident information.

There are other traffic incidents at this location.

There are scheduled events in the area.

The road being travelled on is private.

The turn may be restricted.

There are road closures at this location.

There is a road hazard.

There is construction along the route that has specific start and end dates.

A seasonal closure occurs at this location.

A toll is required at this location to continue along the route.

The road is a toll road.

The entrance to a toll zone.

The exit of a toll zone.

The warning is about traffic flow.

There is a transit line change but a change of vehicle is not required.

The road is unpaved.

There is construction along the route that does not have any specific start and end dates.

There is significant weather at this location.

Specifies the severity of a potential issue along a route leg.

The issue has a low impact.

The issue has a minor level impact.

The issue has a moderate level of impact.

The issue has no impact.

The issue has a high level of impact.

Represents an address.

Gets or sets the building floor of an address.

The building floor of an address.

Gets or sets the building name of an address.

The building name of an address.

Gets or sets the building room of an address.

The building room of an address.

Gets or sets the building wing of an address.

The building wing of an address.

Gets or sets the continent of an address.

The continent of an address.

Gets or sets the country of an address.

The country of an address.

Gets or sets the country code of an address.

The country code of an address.

Gets or sets the district of an address.

The district of an address.

Gets the complete address in string format.

The complete address in string format.

Gets or sets the neighborhood of an address.

The neighborhood of an address.

Gets or sets the postal code of an address.

The postal code of an address.

Gets or sets the region (for example, the state or province) of an address.

The region (for example, the state or province) of an address.

Gets or sets the code for the region (for example, the state or province) of an address.

The code for the region (for example, the state or province) of an address.

Gets or sets the street of an address.

The street of an address.

Gets or sets the street number of an address.

The street number of an address.

Gets or sets the town or city of an address.

The town or city of an address.

Represents a geographic location.

Gets the address of a geographic location.

The address of a geographic location.

Gets the description of a geographic location.

The description of a geographic location.

Gets the display name of a geographic location.

The display name of a geographic location.

Gets the coordinates of a geographic location.

The coordinates of a geographic location.

Indicates the desired accuracy to use when converting latitude and longitude coordinates to a physical location like a city or address.

Leverage the underlying REST API call to get richer and more accurate results.

Leverage the maps disk cache to get accurate info up to the city level.

Provides methods to convert addresses to geographic locations (geocoding) and to convert geographic locations to addresses (reverse geocoding).

Converts the specified address to a collection of geographic locations (geocoding), using the specified reference point as a query hint.

The query for which you want to get locations. A reference point that provides a query hint. When this method completes successfully, it returns a list of locations contained in the MapLocationFinderResult.

Converts the specified address to a collection of geographic locations (geocoding), using the specified reference point as a query hint. The list contains no more than the specified maximum number of results.

The query for which you want to get locations. A reference point that provides a query hint. The maximum number of locations to get. When this method completes successfully, it returns a list of locations contained in the MapLocationFinderResult.

Converts a geographic location to a collection of addresses (reverse geocoding).

The point for which you want to get locations. When this method completes successfully, it returns a list of locations contained in the MapLocationFinderResult.

Converts a geopoint to a collection of addresses with the desired accuracy (reverse geocoding).

The point for which you want to get locations. The desired accuracy for which you want to get locations. When this method completes successfully, it returns a list of locations contained in the MapLocationFinderResult.

Returns the result of a MapLocationFinder query.

Gets the list of locations found by a MapLocationFinder query.

The list of locations found by a MapLocationFinder query. This property returns a collection of MapLocation objects.

Gets the status of a MapLocationFinder query.

The status of a MapLocationFinder query.

Returns the status of a MapLocationFinder query. This enumeration provides values for the Status property of a MapLocationFinderResult.

The specified point cannot be converted to a location. For example, the point is in an ocean or a desert.

The query encountered an internal error.

The query provided credentials that are not valid.

The query encountered a network failure.

The query is not supported.

Query search operation was successful. Check result size before accessing results.

The query returned an unknown error.

Displays the UI that lets users download maps for offline use, or update maps that were previously downloaded.

Displays the UI that lets users download maps for offline use.

Displays the UI that lets users update maps that were previously downloaded for offline use.

Provides additional information about a maneuver. This enumeration provides values for the ManeuverNotices property of a MapRouteManeuver.

There is no additional information.

The maneuver includes a toll road.

The maneuver includes an unpaved road.

Represents a path to be traveled between two or more waypoints.

Gets the bounding box that contains the route.

The bounding box that contains the route.

Gets the estimated time required to traverse the route without traffic.

The estimated time required to traverse the route without traffic.

Gets the estimated time required to traverse the route.

The estimated time required to traverse the route.

Gets a value that indicates the route has been modified from the "best" route to avoid blocked roads.

**true** if the route has been modified to avoid blocked roads; otherwise, **false**.

Gets a value that indicates whether the MapRoute is based on scenic roads.

**true** if the MapRoute is based on scenic roads; otherwise, **false**.

Gets a value indicating whether the MapRoute is based on traffic.

**true** if the MapRoute is based on traffic; otherwise, **false**.

Gets the list of legs associated with the route.

The list of legs associated with the route. This property returns a collection of MapRouteLeg objects.

Gets the length of the route in meters.

The length of the route in meters.

Gets the path of the route.

The path of the route.

Gets the level of traffic congestion along a map route.

The level of traffic congestion along a map route.

Gets a value that indicates if any restrictions have been violated by the route.

The MapRouteRestrictions that have been violated by the route.

Represents advanced routing options.

Initializes a new instance of the MapRouteDrivingOptions class.

Gets or sets the date and time of the departure on a route.

The date and time of departure on a route.

Gets or sets the preferred start direction of the route from the current location in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The preferred start direction of the route from the current location in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

Gets or sets a value that indicates the maximum number of alternative routes that are to be provided, if available.

The maximum number of alternative routes that are to be provided, if available.

Gets or sets the optimization applied to the route(s).

The MapRouteOptimization applied to the route(s).

Gets or sets the restriction applied to the route(s).

The MapRouteRestriction applied to the route(s).

Gets a route.

Gets a driving route for the specified start and end coordinates.

The starting point of the driving route. The ending point of the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified start and end coordinates (using MapRouteDrivingOptions ).

The starting point of the driving route. The ending point of the driving route. The advanced routing options to be applied to this route. When this method completes successfully, it returns one or more driving routes contained in the MapRouteFinderResult.

Gets a driving route for the specified start and end coordinates (using optimizations).

The starting point of the driving route. The ending point of the driving route. The optimizations to apply when calculating the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified start and end coordinates (using optimizations and restrictions).

The starting point of the driving route. The ending point of the driving route. The optimizations to apply when calculating the driving route. The restrictions to apply when calculating the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified start and end coordinates (using optimizations, restrictions, and heading).

The starting point of the driving route. The ending point of the driving route. The optimizations to apply when calculating the driving route. The restrictions to apply when calculating the driving route. The preferred start direction from the current location for the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints (using optimizations).

A collection of stop, start, or intermediate waypoint that a route must pass through. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints (using optimizations).

A collection of stop, start, or intermediate waypoint that a route must pass through. The advanced routing options to be applied to this route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints (using optimizations).

The start and end coordinates and optional waypoints of the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints.

The start and end coordinates and optional waypoints of the driving route. The optimizations to apply when calculating the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints (using optimizations and restrictions).

The start and end coordinates and optional waypoints of the driving route. The optimizations to apply when calculating the driving route. The restrictions to apply when calculating the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a driving route for the specified waypoints (using optimizations, restrictions, and heading).

The start and end coordinates and optional waypoints of the driving route. The optimizations to apply when calculating the driving route. The restrictions to apply when calculating the driving route. The preferred start direction from the current location for the driving route. When this method completes successfully, it returns a driving route contained in the MapRouteFinderResult.

Gets a walking route using the specified start and end coordinates.

The starting point of the walking route. The ending point of the walking route. When this method completes successfully, it returns a walking route contained in the MapRouteFinderResult.

Gets a walking route using the specified waypoints.

The start and end coordinates and optional waypoints of the walking route. When this method completes successfully, it returns a walking route contained in the MapRouteFinderResult.

Returns the result of a MapRouteFinder query.

Gets alternate routes between the same start and end points (if available).

Alternate routes, of type MapRoute, between the same start and end points (if available); otherwise, **null**.

Gets the route found by a MapRouteFinder query.

The route found by a MapRouteFinder query.

Gets the status of a MapRouteFinder query.

The status of a MapRouteFinder query.

Returns the status of a MapRouteFinder query. This enumeration provides values for the Status property of a MapRouteFinderResult.

The specified ending point is not valid in a route. For example, the point is in an ocean or a desert.

The query provided credentials that are not valid.

The query encountered a network failure.

The query did not find a pedestrian route.

The query did not find a route.

The query did not find a route with the specified options.

The query is not supported.

The specified starting point is not valid in a route. For example, the point is in an ocean or a desert.

The query was successful.

The query returned an unknown error.

Represents the set of actions (maneuvers) required to travel between two waypoints along a route.

Gets the bounding box that contains the route leg.

The bounding box that contains the route leg.

Gets the estimated time required to traverse the route without traffic.

The estimated time required to traverse the route without traffic.

Gets the estimated time required to traverse the route leg.

The estimated time required to traverse the route leg.

Gets the length of the route leg in meters.

The length of the route leg in meters.

Gets the list of maneuvers associated with the route leg.

The list of maneuvers associated with the route leg. This property returns a collection of MapRouteManeuver objects.

Gets the path of the route leg.

The path of the route leg.

Gets the level of traffic congestion along a map route leg.

The level of traffic congestion along a map route leg.

Represents actions to be taken along the path of a route leg.

Gets a value that indicates the heading at the end of the maneuver in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The heading at the end of the maneuver in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

Gets the exit number of route maneuver.

The exit number of route maneuver.

Gets the instruction text associated with the maneuver.

The instruction text associated with the maneuver.

Gets the type of the maneuver.

The type of the maneuver.

Gets the distance in meters to the start of the next maneuver.

The distance in meters to the start of the next maneuver.

Gets additional information associated with the maneuver.

Additional information associated with the maneuver.

Gets a value that indicates the heading at the start of the maneuver in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The heading at the start of the maneuver in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

Gets the location where the maneuver starts.

The location where the maneuver starts.

Gets the street name specified in InstructionText, if available.

The street name specified in InstructionText, if available.

Gets a list of potential issues along a route leg.

A list of potential issues along a route leg.

Describes the various types of maneuvers that can occur in a route. This enumeration provides values for the Kind property of a MapRouteManeuver.

The end of the route.

Continue on the freeway on the left.

Continue on the freeway on the right.

Enter the freeway on the left.

Enter the freeway on the right.

Leave the freeway on the left.

Leave the freeway on the right.

Go straight.

The maneuver is not defined.

The start of the route.

A stopover on the route.

The route has resumed after a stopover.

Take the ferry.

Enter the traffic circle on the left.

Enter the traffic circle on the right.

Make a hard left turn.

Make a hard right turn.

Keep left.

Keep right.

Turn left.

Make a gentle left turn.

Make a gentle right turn.

Turn right.

Make a U-turn to the left.

Make a U-turn to the right.

Specifies the optimizations applied to a route. This enumeration provides values for certain parameters of some overloads of the GetDrivingRouteAsync and GetDrivingRouteFromWaypointsAsync methods.

Optimize the route by minimizing the distance.

Optimize the route to include the most scenic roads.

Optimize the route by minimizing the time.

Optimize the route by minimizing the time with traffic.

Specifies the restrictions applied to a route. This enumeration provides values for certain parameters of some overloads of the GetDrivingRouteAsync and GetDrivingRouteFromWaypointsAsync methods.

Avoid dirt roads.

Avoid ferries.

Avoid highways.

Avoid motorail train services.

No restrictions are applied to the route.

Avoid toll roads.

Avoid tunnels.

Communicates with the online map services.

Gets the data provider for the mapping services.

The data provider for the mapping services.

Gets or sets an object that specifies whether to use offline or online map data.

An object that specifies whether to use offline or online map data.

Gets or sets the application ID and the authentication token required for use of the online mapping services.

The application ID and the authentication token required for use of the online mapping services.

Gets the three digit country code used by the Map service, based on the ISO 3166-1 alpha-3 codes.

The three digit country code used by the Map service, based on the ISO 3166-1 alpha-3 codes.

Specifies whether to use online or offline map data.

Use online map data.

Use offline map data.

Displays a map location and information that describes that location in a light-dismissible window which closes automatically when the user clicks outside of the window.

Gets the address associated with the PlaceInfo.

The address associated with the PlaceInfo.

Gets the display name associated with the PlaceInfo.

The display name associated with the PlaceInfo.

Gets the geographical shape associated with the PlaceInfo.

The geographical shape associated with the PlaceInfo.

Gets the identifier associated with the PlaceInfo.

Gets the identifier associated with the PlaceInfo.

Gets a value that indicates whether your app can show a light-dismissible window that contains a map location and related information given the current context.

**true** if your app can show a light-dismissible window that contains a map location and related information given the current context; otherwise, **false**.

Creates a PlaceInfo instance.

The geographic map location that you want to show in a light-dismissible window. A PlaceInfo instance that describes the location.

Creates a PlaceInfo instance.

The geographic map location that you want to show in a light-dismissible window. The optional information that describes this location. This information will appear in the light-dismissible window. A PlaceInfo instance that describes the location.

Creates a PlaceInfo instance by using an address.

The address of the location that you want to appear in the placecard.

Creates a PlaceInfo instance by using an address and a display name.

The address of the location that you want to appear in the placecard. The name that you want to appear as a label in the placecard.

Creates a PlaceInfo instance.

The identifier of the location. A PlaceInfo instance that describes the location.

Creates a PlaceInfo instance.

The identifier of the location. The geographic map location that you want to show in a light-dismissible window. The optional information that describes this location. This information will appear in the light-dismissible window. A PlaceInfo instance that describes the location.

Creates a PlaceInfo instance.

The geographic map location that you want to show in a light-dismissible window. A PlaceInfo instance that describes the location.

Shows in a pop-up window, the map location and related information that is described in the PlaceInfo.

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the Rect of the button so the light-dismissible window displays around the button, not overlapping it.

Shows in a light-dismissible window, the map location and related information that is described in the PlaceInfo.

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the Rect of the button so the light-dismissible window displays around the button, not overlapping it. The preferred placement of the light-dismissible window relative to the rectangle.

Represents the information about a map location that your app can show in a light-dismissible window within your app.

Creates a PlaceInfoCreateOptions instance.

Gets the address associated with the PlaceInfoCreateOptions.

The address associated with the PlaceInfoCreateOptions.

Gets the display name associated with the PlaceInfoCreateOptions.

The display name associated with the PlaceInfoCreateOptions.

Specifies the level of traffic congestion along a map route or route leg.

The level of traffic congestion is heavy.

The level of traffic congestion is light.

The level of traffic congestion is medium.

The level of traffic congestion is mild.

The level of traffic congestion is unknown.

Specifies the type of waypoint.

A start or stop waypoint of a route or route leg.

An intermediate waypoint that a route must pass through.

Represents the map data for a particular geographical region. The data can be downloaded and used offline.

Gets the display name of a geographic location for the offline map package.

Gets the display name of a geographic location for the offline map package.

Gets the surrounding or containing region of the offline map package (for example: USA).

The surrounding or containing region of the offline map package (for example: USA).

Gets the estimated size in bytes of the offline map package.

The estimated size in bytes of the offline map package.

Gets the status of a map package (For example, whether the package is downloaded to your local system or not).

The status of a map package.

Occurs when the status of an OfflineMapPackageQueryResult changes.

Starts an asynchronous operation to find a map package that contains map data for specified geographical location.

The geographical location that you want to locate a map package for. An OfflineMapPackageQueryResult that contains the result of the query.

Starts an asynchronous operation to find a map package that contains map data for specified four-sided geographic area.

A specified four-sided geographic area that defines the area that you want to locate a map package for. An OfflineMapPackageQueryResult that contains the result of the query.

Starts an asynchronous operation to find a map package that contains map data for specified geographic area.

The geographic area that defines the area that you want to locate a map package for. An OfflineMapPackageQueryResult that contains the result of the query.

Starts an asynchronous operation to request the download of a map package to your local system.

An OfflineMapPackageStartDownloadResult that contains the result of the operation.

Represents the result of a query for map packages.

Gets the map packages returned by a call to the FindPackagesAsync, FindPackagesInBoundingBoxAsync, and FindPackagesInGeocircleAsync methods.

The map packages returned by a call to the FindPackagesAsync, FindPackagesInBoundingBoxAsync, and FindPackagesInGeocircleAsync methods.

Gets the success or failure of the query to find map packages.

The status of the query.

Specifies the status of a OfflineMapPackageQueryResult.

The credentials used to perform this query are invalid.

There was a network failure that prevented the query from being completed successfully.

The query completed successfully.

The query returned an unknown error.

Represents the result of an asynchronous request to queue the download of a map package onto the local system.

Gets the status of an asynchronous request to download a map package onto the local system.

The status of an asynchronous request to download a map package onto the local system.

Specifies the status of an OfflineMapPackageStartDownloadResult.

The ``<uap4:Capability Name="offlineMapsManagement" />`` has not been added to the package manifest.

The credentials used to complete this operation are invalid.

The operation completed successfully.

The operation returned an unknown error.

Specifies the status of a OfflineMapPackage.

The map package is being deleted from the local system.

The map package is downloaded to the local system.

The map packaging is currently downloading to the local system.

The map package is not downloaded to the local system.

AppDataPaths returns paths to commonly used application folders based on the KNOWNFOLDERID naming pattern.

Gets the path to the app's cookies.

The full path to the app's cookies. This is the same folder that is used by the Windows Internet API.

Gets the path to the desktop folder.

The full path to the desktop folder.

Gets a path to the documents folder.

The full path to the documents folder.

Gets a path to the favorites folder.

The full path to the favorites folder.

Gets a path to the history folder.

The full path to the history folder. This is the same folder that is used by the Windows Internet API.

Gets the path to the internet cache folder.

The full path to the internet cache folder. This is the same folder that is used by the Windows Internet API.

Gets the local application data folder.

The string value of the path to the local app data folder.

Gets the program data folder.

The string value of the path to the program data folder.

Gets the roaming application data folder.

The string value of the path to the roaming app data folder.

Gets the paths to a user's various app data folders. Use this method in single user apps.

The app data paths associated with the user.

Gets the paths to a user's various app data folders. Use this method in multi-user apps.

The user to retreive the paths for. The app data paths associated with the user.

Provides access to the application data store. Application data consists of files and settings that are either local, roaming, or temporary.

Provides access to the app data store associated with the app's app package.

The app data store.

Gets the folder in the local app data store where you can save files that are not included in backup and restore.

The folder in the local app data store where you can save files that are not included in backup and restore.

Gets the root folder in the local app data store. This folder is backed up to the cloud.

The file system folder that contains the files.

Gets the application settings container in the local app data store.

The application settings container.

Gets the root folder in the roaming app data store.

The file system folder that contains the files.

Gets the application settings container in the roaming app data store.

The application settings container.

Gets the maximum size of the data that can be synchronized to the cloud from the roaming app data store.

The maximum size of the data, in KB.

Gets the root folder in the shared app data store.

The file system folder that contains files.

Gets the root folder in the temporary app data store.

The file system folder that contains the files.

Gets the version number of the application data in the app data store.

The version number of the application data.

Occurs when roaming application data is synchronized.

Removes all application data from the local, roaming, and temporary app data stores.

An object that is used to manage the asynchronous clear operation.

Removes all application data from the specified app data store.

One of the enumeration values. An object that is used to manage the asynchronous clear operation.

Clears the files and subfolders from the specified subfolder of the shared storage folder for the publisher of the current app.

The subfolder of the shared storage folder for the publisher of the current app from which to clear the files and subfolders. Represents an asynchronous action that does not return a result and does not have progress notifications. You can use this value to get the results of the operation, or to specify a method to run when the operation completes - for example, to repopulate the shared storage folder with new data.

Static method that returns the ApplicationData for a User.

The User for which the ApplicationData is returned. When this method completes, it returns the requested ApplicationData object.

Gets the specified subfolder of the shared storage folder for the publisher of the current app.

The subfolder to get from the shared storage folder for the publisher of the current app. The specified subfolder.

Sets the version number of the application data in the app data store.

The new version number. The set version event handler. An object that is used to manage the asynchronous set version operation.

Sends a DataChanged event to all registered event handlers.

Represents related app settings that must be serialized and deserialized atomically.

Creates and initializes a new, initially empty, instance of the object.

Gets the number of related application settings.

The number of related settings.

Occurs when the map changes.

Removes all application settings previously inserted into the composite value object, returning the object to its empty state.

Retrieves an iterator to enumerate the settings in the composite value.

The iterator.

Returns a read-only snapshot of the contents of the composite value.

The view of the composite value.

Determines whether there is an application setting with the specified key.

The key. True if the key is found; otherwise false.

Creates or replaces an application setting.

The key of the setting to insert or replace. The setting value. True if an item with the specified key is an existing item and was replaced; otherwise, false.

Retrieves the specified application setting.

The key of the setting. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes the value with the specified key.

The key of the value to remove.

Represents a container for app settings. The methods and properties of this class support creating, deleting, enumerating, and traversing the container hierarchy.

Gets the child application settings containers of this application settings container.

The application settings containers.

Gets the type (local or roaming) of the app data store that is associated with the current settings container.

One of the enumeration values.

Gets the name of the current settings container.

The name of the settings container.

Gets an object that represents the settings in this settings container.

The settings map object.

Creates or opens the specified settings container in the current settings container.

The name of the container. One of the enumeration values. The settings container.

Deletes the specified settings container, its subcontainers, and all application settings in the hierarchy.

The name of the settings container.

Provides access to the settings in a settings container. The ApplicationDataContainer.Values property returns an object that can be cast to this type.

Gets the number of related application settings.

The number of related settings.

Occurs when the map changes.

Removes all related application settings.

Retrieves an iterator to enumerate the settings in the settings container.

The iterator.

Returns a read-only snapshot of the contents of the settings container.

The view of the settings container.

Determines whether there is an application setting with the specified key.

The key. True if the key is found; otherwise false.

Inserts or replaces an application setting.

The key of the setting to insert or replace. The setting value. True if an item with the specified key is an existing item and was replaced; otherwise, false.

Retrieves the specified application setting.

The key of the setting. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes the specified application setting.

The key of the setting.

Specifies options for creating application data containers or returning existing containers. This enumeration is used by the ApplicationDataContainer.CreateContainer method.

Always returns the specified container. Creates the container if it does not exist.

Returns the specified container only if it already exists. Raises an exception of type **System.Exception** if the specified container does not exist.

Specifies the type of an application data store.

The data resides in the local application data store.

The data resides in the local cache for the application data store.

The data resides in the roaming application data store.

The data resides in the temporary application data store.

Represents a method that handles the request to set the version of the application data in the application data store.

The set version request.

Lets apps manage real-time updates to files.

Initiates updates for the specified file. This method contacts the app that provided the file to perform the updates.

The file to update. When this method completes, it returns a FileUpdateStatus enum value that describes the status of the updates to the file.

Lets apps defer real-time updates for a specified file.

The file to defer updates for.

Specifies what to do if a file or folder with the specified name already exists in the current folder when you create a new file or folder.

Raise an exception of type **System.Exception** if the file or folder already exists.

Automatically append a number to the base of the specified name if the file or folder already exists.

Return the existing item if the file or folder already exists.

Replace the existing item if the file or folder already exists.

Creates files and folders inside the Downloads folder.

Creates a new file inside the Downloads folder.

The desired name of the file to create. When this method completes, it returns the new file as a StorageFile object.

Creates a new file in the Downloads folder, and specifies what to do if a file with the same name already exists in the Downloads folder.

The desired name of the file to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing file in the current folder. When this method completes, it returns the new file as a StorageFile object.

Creates a new file inside the Downloads folder of a specific User.

The User for which the file is created. The desired name of the file to create. When this method completes, it returns the new file as a StorageFile object.

Creates a new file in the Downloads folder of a specific User, and specifies what to do if a file with the same name already exists in the Downloads folder.

The User for which the file is created. The desired name of the file to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing file in the current folder. When this method completes, it returns the new file as a StorageFile object.

Creates a new subfolder in the Downloads folder.

The desired name of the subfolder to create. When this method completes, it returns the new subfolder as a StorageFolder.

Creates a new subfolder in the Downloads folder, and specifies what to do if a subfolder with the same name already exists in the Downloads folder.

The desired name of the subfolder to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing subfolder in the Downloads folder. When this method completes, it returns the new subfolder as a StorageFolder.

Creates a new subfolder inside the Downloads folder of a specific User.

The User for which the folder is created. The desired name of the subfolder to create. When this method completes, it returns the new subfolder as a StorageFolder.

Creates a new subfolder in the Downloads folder of a specific User, and specifies what to do if a subfolder with the same name already exists in the Downloads folder.

The User for which the folder is created. The desired name of the subfolder to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing subfolder in the Downloads folder. When this method completes, it returns the new subfolder as a StorageFolder.

Specifies whether to access a file in read-only mode or in read/write mode.

Access the file stream in read-only mode.

Access the file stream in read/write mode.

Describes the attributes of a file or folder.

The item is archived.

The item is a directory.

The item is locally incomplete. Windows only.

The item is normal. That is, the item doesn't have any of the other values in the enumeration.

The item is read-only.

The item is a temporary file.

Provides helper methods for reading and writing files that are represented by objects of type IStorageFile.

Appends lines of text to the specified file.

The file that the lines are appended to. The list of text strings to append as lines. No object or value is returned when this method completes.

Appends lines of text to the specified file using the specified character encoding.

The file that the lines are appended to. The list of text strings to append as lines. The character encoding of the file. No object or value is returned when this method completes.

Appends text to the specified file.

The file that the text is appended to. The text to append. No object or value is returned when this method completes.

Appends text to the specified file using the specified character encoding.

The file that the text is appended to. The text to append. The character encoding of the file. No object or value is returned when this method completes.

Reads the contents of the specified file and returns a buffer.

The file to read. When this method completes, it returns an object (type IBuffer ) that represents the contents of the file.

Reads the contents of the specified file and returns lines of text.

The file to read. When this method completes successfully, it returns the contents of the file as a list (type IVector ) of lines of text. Each line of text in the list is represented by a String object.

Reads the contents of the specified file using the specified character encoding and returns lines of text.

The file to read. The character encoding to use. When this method completes successfully, it returns the contents of the file as a list (type IVector ) of lines of text. Each line of text in the list is represented by a String object.

Reads the contents of the specified file and returns text.

The file to read. When this method completes successfully, it returns the contents of the file as a text string.

Reads the contents of the specified file using the specified character encoding and returns text.

The file to read. The character encoding to use. When this method completes successfully, it returns the contents of the file as a text string.

Writes data from a buffer to the specified file.

The file that the buffer of data is written to. The buffer that contains the data to write. No object or value is returned when this method completes.

Writes an array of bytes of data to the specified file.

The file that the byte is written to. The array of bytes to write. No object or value is returned when this method completes.

Writes lines of text to the specified file.

The file that the lines are written to. The list of text strings to write as lines. No object or value is returned when this method completes.

Writes lines of text to the specified file using the specified character encoding.

The file that the lines are written to. The list of text strings to write as lines. The character encoding of the file. No object or value is returned when this method completes.

Writes text to the specified file.

The file that the text is written to. The text to write. No object or value is returned when this method completes.

Writes text to the specified file using the specified character encoding.

The file that the text is written to. The text to write. The character encoding of the file. No object or value is returned when this method completes.

Represents a file. Provides information about the file and its contents, and ways to manipulate them.

Gets the MIME type of the contents of the file.

The MIME type of the file contents.

Gets the type (file name extension) of the file.

The file name extension of the file.

Replaces the specified file with a copy of the current file.

The file to replace. No object or value is returned when this method completes.

Creates a copy of the file in the specified folder.

The destination folder where the copy is created. When this method completes, it returns a StorageFile that represents the copy.

Creates a copy of the file in the specified folder, using the desired name.

The destination folder where the copy is created. The desired name of the copy. When this method completes, it returns a StorageFile that represents the copy.

Creates a copy of the file in the specified folder, using the desired name. This method also specifies what to do if an existing file in the specified folder has the same name.

The destination folder where the copy is created. The desired name of the copy. An enum value that determines how Windows responds if the *desiredNewName* is the same as the name of an existing file in the destination folder. When this method completes, it returns a StorageFile that represents the copy.

Moves the current file to the location of the specified file and replaces the specified file in that location.

The file to replace. No object or value is returned by this method.

Moves the current file to the specified folder.

The destination folder where the file is moved. No object or value is returned by this method.

Moves the current file to the specified folder and renames the file according to the desired name.

The destination folder where the file is moved. The desired name of the file after it is moved. No object or value is returned by this method.

Moves the current file to the specified folder and renames the file according to the desired name. This method also specifies what to do if a file with the same name already exists in the specified folder.

The destination folder where the file is moved. The desired name of the file after it is moved. An enum value that determines how Windows responds if the *desiredNewName* is the same as the name of an existing file in the destination folder. No object or value is returned by this method.

Opens a random-access stream over the file.

The type of access to allow. When this method completes, it returns the random-access stream (type [IRandomAccessStream](https://docs.microsoft.com/previous-versions/hh438400(v=vs.85))).

Opens a transacted, random-access stream for writing to the file.

When this method completes, it returns a StorageStreamTransaction that contains the random-access stream and methods that can be used to complete transactions.

Represents a file. Provides information about the file and its contents, and ways to manipulate them.

Opens a random-access stream over the file.

One of the enumeration values that specifies the type of access to allow. A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns an IRandomAccessStream that contains the requested random-access stream.

Opens a random-access stream to the file that can be used for transacted-write operations with the specified options.

A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns a StorageStreamTransaction containing the random-access stream and methods that can be used to complete transactions.

Provides access to the IsAvailable property.

Indicates if the file is local, is cached locally, or can be downloaded.

**True** if the file is local, is cached locally, or can be downloaded. Otherwise, **false**.

Manipulates folders and their contents, and provides information about them.

Creates a new file in the current folder.

The desired name of the file to create. When this method completes, it returns the new file as a StorageFile.

Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

The desired name of the file to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing file in the current folder. When this method completes, it returns the new file as a StorageFile.

Creates a new folder in the current folder.

The desired name of the folder to create. When this method completes, it returns the new folder as a StorageFolder.

Creates a new folder in the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

The desired name of the folder to create. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing folder in the current folder. When this method completes, it returns the new folder as a StorageFolder.

Gets the specified file from the current folder.

The name (or path relative to the current folder) of the file to retrieve. When this method completes successfully, it returns a StorageFile that represents the file.

Gets the files from the current folder.

When this method completes successfully, it returns a list of the files (type IVectorView ) in the folder. Each file in the list is represented by a StorageFile object.

Gets the specified folder from the current folder.

The name of the child folder to retrieve. When this method completes successfully, it returns a StorageFolder that represents the child folder.

Gets the folders in the current folder.

When this method completes successfully, it returns a list of the files (type IVectorView ). Each folder in the list is represented by a StorageFolder.

Gets the specified item from the IStorageFolder.

The name of the item to retrieve. When this method completes successfully, it returns the file or folder (type IStorageItem ).

Gets the items from the current folder.

When this method completes successfully, it returns a list of the files and folders (type IVectorView ). The files and folders in the list are represented by objects of type IStorageItem.

Manipulates folders and their contents, and provides information about them.

Try to get a single file or sub-folder from the current folder by using the name of the item.

The name (or path relative to the current folder) of the file or sub-folder to try to retrieve. When this method completes successfully, it returns the file or folder (type IStorageItem ).

Manipulates storage items (files and folders) and their contents, and provides information about them.

Gets the attributes of a storage item.

The file or folder attributes.

Gets the date and time when the current item was created.

The date and time when the current item was created.

Gets the name of the item including the file name extension if there is one.

The name of the item including the file name extension if there is one.

Gets the full file-system path of the item, if the item has a path.

The full path of the item, if the item has a path in the user's file-system.

Deletes the current item.

No object or value is returned by this method when it completes.

Deletes the current item, optionally deleting it permanently.

A value that indicates whether to delete the item permanently. No object or value is returned by this method when it completes.

Gets the basic properties of the current item (like a file or folder).

When this method completes successfully, it returns the basic properties of the current item as a BasicProperties object.

Determines whether the current IStorageItem matches the specified StorageItemTypes value.

The value to match against. True if the IStorageItem matches the specified value; otherwise false.

Renames the current item.

The desired, new name of the item. No object or value is returned by this method when it completes.

Renames the current item. This method also specifies what to do if an existing item in the current item's location has the same name.

The desired, new name of the current item. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing item in the current item's location. No object or value is returned by this method when it completes.

Manipulates storage items (files and folders) and their contents, and provides information about them.

Gets the parent folder of the current storage item.

When this method completes, it returns the parent folder as a StorageFolder.

Indicates whether the current item is the same as the specified item.

The IStorageItem object that represents a storage item to compare against. Returns **true** if the current storage item is the same as the specified storage item; otherwise **false**.

Provides access to common and content properties on items (like files and folders).

Gets the user-friendly name of the item.

Gets the user-friendly name of the item.

Gets the user-friendly type of the item.

The user-friendly type of the item.

Gets an identifier for the current item. This ID is unique for the query result or StorageFolder that contains the item and can be used to distinguish between items that have the same name.

The identifier for the item within the query result or StorageFolder.

Gets an object that provides access to the content-related properties of the item.

The object that provides access to the content-related properties of the item.

Retrieves an adjusted thumbnail image for the item, determined by the purpose of the thumbnail.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Retrieves an adjusted thumbnail image for the item, determined by the purpose of the thumbnail and the requested size.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Retrieves an adjusted thumbnail image for the item, determined by the purpose of the thumbnail, the requested size, and the specified options.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Provides access to methods that get a scaled image as a thumbnail.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail and the requested size.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail, the requested size, and the specified options

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Provides access to common and content properties on storage items from a particular provider.

Gets the StorageProvider object that contains info about the service that stores the current storage item.

The StorageProvider object that contains info about the service that stores the current storage item. The item may be stored by the local file system or by a remote service like Microsoft OneDrive.

Represents a sequential-access output stream that indicates a request for the data stream of a StorageFile that was created by calling CreateStreamedFileAsync or ReplaceWithStreamedFileAsync.

Indicates that the data can't be streamed and releases system resources that are exposed by the current stream indicating that the data request is complete.

The enum value that indicates why the data stream can't be accessed.

Provides values that identify storage folders.

All app modifications folder.

App Captures folder.

Camera Roll folder.

Current app modifications folder.

Documents library folder.

HomeGroup folder.

The folder of media server (Digital Living Network Alliance (DLNA)) devices.

Music library folder.

Objects 3D folder.

Pictures library folder.

Playlists folder.

Recorded calls folder.

Removable devices folder.

Saved pictures folder.

Screenshots folder.

Videos library folder.

Provides access to common locations that contain user content. This includes content from a user's local libraries (such as Documents, Pictures, Music, and Videos), HomeGroup, removable devices, and media server devices.

Gets the App Captures folder.

The App Captures folder.

Gets the Camera Roll folder.

The Camera Roll folder.

Gets the Documents library. The Documents library is not intended for general use.

The Documents library.

Gets the HomeGroup folder.

The HomeGroup folder.

Gets the folder of media server (Digital Living Network Alliance (DLNA)) devices.

The folder of media server (Digital Living Network Alliance (DLNA)) devices.

Gets the Music library.

The Music library.

Gets the Objects 3D folder.

The Objects 3D folder.

Gets the Pictures library.

The Pictures library.

Gets the play lists folder.

The play lists folder.

Gets the recorded calls folder.

The recorded calls folder.

Gets the removable devices folder.

The removable devices folder.

Gets the Saved Pictures folder.

The Saved Pictures folder.

Gets the Videos library.

The Videos library.

Static method that returns a specified known folder for a User.

The User for which the folder is returned. Use `null` for the current user. In context of this API, current user refers to the user context of the process from where the API call is made. The ID of the folder to be returned. When this method completes, it returns the requested StorageFolder object.

Provides values that identify storage libraries.

Documents library.

Music library.

Pictures library.

Videos library.

Specifies what to do if a file or folder with the specified name already exists in the current folder when you copy, move, or rename a file or folder.

Raise an exception of type **System.Exception** if the file or folder already exists.

Automatically append a number to the base of the specified name if the file or folder already exists.

Replace the existing item if the file or folder already exists.

Provides helper methods for reading and writing a file using the absolute path or Uniform Resource Identifier (URI) of the file.

Appends lines of text to the file at the specified path or Uniform Resource Identifier (URI).

The path or Uniform Resource Identifier (URI) of the file that the lines are appended to. The list of text strings to append as lines. No object or value is returned when this method completes.

Appends lines of text to the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding.

The path of the file that the lines are appended to. The list of text strings to append as lines. The character encoding of the file. No object or value is returned when this method completes.

Appends text to the file at the specified path or Uniform Resource Identifier (URI).

The path of the file that the text is appended to. The text to append. No object or value is returned when this method completes.

Appends text to the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding.

The path of the file that the text is appended to. The text to append. The character encoding of the file. No object or value is returned when this method completes.

Reads the contents of the file at the specified path or Uniform Resource Identifier (URI) and returns a buffer.

The path of the file to read. When this method completes, it returns an object (type IBuffer ) that represents the contents of the file.

Reads the contents of the file at the specified path or Uniform Resource Identifier (URI) and returns lines of text.

The path of the file to read. When this method completes successfully, it returns the contents of the file as a list (type IVector ) of lines of text. Each line of text in the list is represented by a String object.

Reads the contents of the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding and returns lines of text.

The path of the file to read. The character encoding of the file. When this method completes successfully, it returns the contents of the file as a list (type IVector ) of lines of text. Each line of text in the list is represented by a String object.

Reads the contents of the file at the specified path or Uniform Resource Identifier (URI) and returns text.

The path of the file to read. When this method completes successfully, it returns the contents of the file as a text string.

Reads the contents of the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding and returns text.

The path of the file to read. The character encoding of the file. When this method completes successfully, it returns the contents of the file as a text string.

Writes data from a buffer to the file at the specified path or Uniform Resource Identifier (URI).

The path of the file that the data is written to. The buffer that contains the data to write. No object or value is returned when this method completes.

Writes a single byte of data to the file at the specified path or Uniform Resource Identifier (URI).

The path of the file that the byte is written to. An array of bytes to write. No object or value is returned when this method completes.

Writes lines of text to the file at the specified path or Uniform Resource Identifier (URI).

The path of the file that the lines are written to. The list of text strings to append as lines. No object or value is returned when this method completes.

Writes lines of text to the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding.

The path of the file that the lines are appended to. The list of text strings to append as lines. The character encoding of the file. No object or value is returned when this method completes.

Writes text to the file at the specified path or Uniform Resource Identifier (URI).

The path of the file that the text is written to. The text to write. No object or value is returned when this method completes.

Writes text to the file at the specified path or Uniform Resource Identifier (URI) using the specified character encoding.

The path of the file that the text is written to. The text to write. The character encoding of the file. No object or value is returned when this method completes.

Manages a delayed set version operation.

Notifies the system that the app has set the version of the application data in its app data store.

Provides data when an app sets the version of the application data in its app data store.

Gets the current version.

The current version.

Gets the requested version.

The requested version.

Requests that the set version request be delayed.

The set version deferral.

Specifies whether a deleted item is moved to the Recycle Bin or permanently deleted.

Specifies the default behavior.

Permanently deletes the item. The item is not moved to the Recycle Bin.

Represents a file. Provides information about the file and its content, and ways to manipulate them.

Gets the attributes of a file.

The file attributes.

Gets the MIME type of the contents of the file.

The MIME type of the file contents.

Gets the date and time when the current file was created.

The date and time when the current file was created.

Gets a user-friendly name for the file.

The user-friendly name for the file.

Gets a user-friendly description of the type of the file.

The user-friendly description of the type of the file.

Gets the type (file name extension) of the file.

The file name extension of the file.

Gets an identifier for the file. This ID is unique for the query result or StorageFolder that contains the file and can be used to distinguish between items that have the same name.

The identifier for the file.

Indicates if the file is local, is cached locally, or can be downloaded.

**True** if the file is local, is cached locally, or can be downloaded. Otherwise, **false**.

Gets the name of the file including the file name extension.

The name of the file including the file name extension.

Gets the full file-system path of the current file, if the file has a path.

The full path of the file, if the file has a path in the user's file-system.

Gets an object that provides access to the content-related properties of the file.

The object that provides access to the content-related properties of the file.

Gets the StorageProvider object that contains info about the service that stores the current file.

The StorageProvider object that contains info about the service that stores the current file. The file may be stored by the local file system or by a remote service like Microsoft OneDrive.

Replaces the specified file with a copy of the current file.

The file to replace. No object or value is returned when this method completes.

Creates a copy of the file in the specified folder.

The destination folder where the copy of the file is created. When this method completes, it returns a StorageFile that represents the copy of the file created in the *destinationFolder*.

Creates a copy of the file in the specified folder and renames the copy.

The destination folder where the copy of the file is created. The new name for the copy of the file created in the *destinationFolder*. When this method completes, it returns a StorageFile that represents the copy of the file created in the *destinationFolder*.

Creates a copy of the file in the specified folder and renames the copy. This method also specifies what to do if a file with the same name already exists in the destination folder.

The destination folder where the copy of the file is created. The new name for the copy of the file created in the *destinationFolder*. One of the enumeration values that determines how to handle the collision if a file with the specified *desiredNewName* already exists in the destination folder. When this method completes, it returns a StorageFile that represents the copy of the file created in the *destinationFolder*.

Creates a StorageFile to represent the specified stream of data. This method lets the app produce the data on-demand by specifying a function to be invoked when the StorageFile that represents the stream is first accessed.

The user-friendly name of the StorageFile to create, including a file type extension. The function that should be invoked when the StorageFile that is returned is first accessed. This function should produce the data stream represented by the returned StorageFile and lets the app produce data on-demand instead of writing the contents of the file at creation time. The thumbnail image for the StorageFile to create. When this method completes, it returns a StorageFile object that represents the new stream of data.

Creates a StorageFile to represent a stream of data from the specified Uniform Resource Identifier (URI) resource. This method lets the app download the data on-demand when the StorageFile that represents the stream is first accessed.

The user-friendly name of the StorageFile to create, including a file type extension. The Uniform Resource Identifier (URI) of the resource used to create the StorageFile. The thumbnail image for the StorageFile to create. When this method completes, it returns a StorageFile object that represents the Uniform Resource Identifier (URI) resource.

Deletes the current file.

No object or value is returned by this method when it completes.

Deletes the current file, optionally deleting the item permanently.

A value that indicates whether to delete the item permanently. No object or value is returned by this method when it completes.

Gets the basic properties of the current file.

When this method completes successfully, it returns the basic properties of the current file as a BasicProperties object.

Gets a StorageFile object to represent the specified Uniform Resource Identifier (URI) app resource. For examples of sample URIs see Load images and assets tailored for scale, theme, high contrast, and others.

The Uniform Resource Identifier (URI) of the app resource to get a StorageFile to represent. When this method completes, it returns a StorageFile object that represents the Uniform Resource Identifier (URI) resource.

Gets a StorageFile object to represent the file at the specified path.

The path of the file to get a StorageFile to represent. When this method completes, it returns the file as a StorageFile.

Gets the parent folder of the current file.

When this method completes, it returns the parent folder as a StorageFolder.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail and the requested size.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail, the requested size, and the specified options

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Retrieves an adjusted thumbnail image for the file, determined by the purpose of the thumbnail.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the file.

Retrieves an adjusted thumbnail image for the file, determined by the purpose of the thumbnail and the requested size.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the file.

Retrieves an adjusted thumbnail image for the file, determined by the purpose of the thumbnail, the requested size, and the specified options.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the file.

Indicates whether the current file is equal to the specified file.

The IStorageItem object that represents a file to compare against. Returns true if the current file is equal to the specified file; otherwise false.

Determines whether the current StorageFile matches the specified StorageItemTypes value.

The value to match against. True if the StorageFile matches the specified value; otherwise false.

Moves the current file to the location of the specified file and replaces the specified file in that location.

The file to replace. No object or value is returned by this method.

Moves the current file to the specified folder.

The destination folder where the file is moved. No object or value is returned by this method.

Moves the current file to the specified folder and renames the file according to the desired name.

The destination folder where the file is moved. The desired name of the file after it is moved. No object or value is returned by this method.

Moves the current file to the specified folder and renames the file according to the desired name. This method also specifies what to do if a file with the same name already exists in the specified folder.

The destination folder where the file is moved. The desired name of the file after it is moved. An enum value that determines how Windows responds if the *desiredNewName* is the same as the name of an existing file in the destination folder. No object or value is returned by this method.

Opens a random-access stream with the specified options over the specified file.

One of the enumeration values that specifies the type of access to allow. When this method completes, it returns an IRandomAccessStream that contains the requested random-access stream.

Opens a random-access stream with the specified options over the specified file.

One of the enumeration values that specifies the type of access to allow. A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns an IRandomAccessStream that contains the requested random-access stream.

Opens a random-access stream over the current file for reading file contents.

When this method completes, it returns the random-access stream (type IRandomAccessStreamWithContentType ).

Opens a sequential-access stream over the current file for reading file contents.

When this method completes, it returns the sequential-access stream (type IInputStream ).

Opens a random-access stream to the file that can be used for transacted-write operations.

When this method completes, it returns a StorageStreamTransaction that contains the random-access stream and methods that can be used to complete transactions.

Opens a random-access stream to the file that can be used for transacted-write operations with the specified options.

A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns a StorageStreamTransaction that contains the random-access stream and methods that can be used to complete transactions.

Renames the current file.

The desired, new name of the current item. No object or value is returned by this method when it completes.

Renames the current file. This method also specifies what to do if an existing item in the current file's location has the same name.

The desired, new name of the current file. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing item in the current file's location. No object or value is returned by this method when it completes.

Replaces the contents of the file referred to by the specified IStorageFile object with a new data stream. This method lets the app produce the data on-demand by specifying a function to be invoked when the StorageFile that represents the stream is first accessed.

The file (type IStorageFile ) that the new data stream should be written to. The function that should be invoked when the StorageFile that is returned is first accessed. This function should produce the data stream represented by the returned StorageFile and lets the app produce data on-demand instead of writing the contents of the file at creation time. The thumbnail image for the StorageFile to create. When this method completes, it returns a StorageFile object that represents the new data stream. Subsequently, this StorageFile object should be used to access file content instead of the file (type IStorageFile ) that was specified to be replace.

Replaces the contents of the file referred to by the specified IStorageFile object with a new data stream of the specified Uniform Resource Identifier (URI). This method lets the app download the data on-demand when the StorageFile that represents the stream is first accessed.

The file that the created StorageFile will provide a stream of. The Uniform Resource Identifier (URI) of the resource used to create the StorageFile. The thumbnail image for the StorageFile to create. When this method completes, it returns a StorageFile object that represents the streamed file. Subsequently, this StorageFile object should be used to access file content instead of the file (type IStorageFile ) that was specified to be replace.

Manages folders and their contents and provides information about them.

Gets the attributes of the current folder.

The attributes of the current folder.

Gets the date and time that the current folder was created.

The date and time that the current folder was created as type DateTime.

Gets the user-friendly name of the current folder.

The user-friendly name of the current folder.

Gets the user-friendly description of the type of the folder; for example, `JPEG image`.

The user-friendly description of the type of the folder; for example, `JPEG image`.

Gets an identifier for the current folder. This ID is unique for the query result or StorageFolder that contains the current folder or file group, and can be used to distinguish between items that have the same name.

The identifier for the current folder or file group within a query result or StorageFolder.

Gets the name of the current folder.

The name of the current folder.

Gets the full path of the current folder in the file system, if the path is available.

The full path of the current folder in the file system, if the path is available.

Gets an object that provides access to the content-related properties of the current folder.

The object that provides access to the content-related properties of the folder.

Gets the StorageProvider object that contains info about the service that stores the current folder.

The StorageProvider object that contains info about the service that stores the current folder. The folder may be stored by the local file system or by a remote service like Microsoft OneDrive.

Indicates whether the current folder supports the specified QueryOptions.

The QueryOptions to check. True if the folder or file group supports the specified QueryOptions; otherwise false.

Creates a new file with the specified name in the current folder.

The name of the new file to create in the current folder. When this method completes, it returns a StorageFile that represents the new file.

Creates a new file in the current folder. This method also specifies what to do if a file with the same name already exists in the current folder.

The name of the new file to create in the current folder. One of the enumeration values that determines how to handle the collision if a file with the specified *desiredName* already exists in the current folder. When this method completes, it returns a StorageFile that represents the new file.

Gets a query result object that contains the files in the current folder.

A query result object. Call the GetFilesAsync method of the query result to get the flat list of files. This method returns a list of type **IReadOnlyList**<StorageFile >. Each file is represented by an item of type StorageFile.

Gets a query result object that contains the files in the current folder. Also gets the files from the subfolders of the current folder when the value of the *query* argument is something other than CommonFileQuery.DefaultQuery. Files are sorted based on the specified CommonFileQuery.

One of the enumeration values that specifies how to sort the files and determines whether the query is shallow or deep. A query result object. Call the GetFilesAsync method of the query result to get the flat list of files, sorted as specified by *query*. This method returns a list of type **IReadOnlyList**<StorageFile >. Each file is represented by an item of type StorageFile.

Gets a query result object that contains the files in the current folder and, optionally, in the subfolders of the current folder. The results are based on the specified QueryOptions.

The criteria that are applied to the query. A query result object that contains the files in the current folder and, optionally, in the subfolders of the current folder, filtered and sorted based on the specified QueryOptions. Call the GetFilesAsync method of the query result to get the flat list of files, sorted as specified by *queryOptions*. This method returns a list of type **IReadOnlyList**<StorageFile >. Each file is represented by an item of type StorageFile.

Creates a new subfolder with the specified name in the current folder.

The name of the new subfolder to create in the current folder. When this method completes, it returns a StorageFolder that represents the new subfolder.

Creates a new subfolder with the specified name in the current folder. This method also specifies what to do if a subfolder with the same name already exists in the current folder.

The name of the new subfolder to create in the current folder. One of the enumeration values that determines how to handle the collision if a subfolder with the specified *desiredName* already exists in the current folder. When this method completes, it returns a StorageFolder that represents the new subfolder.

Gets a query result object that contains the subfolders in the current folder.

A query result object. Call the GetFoldersAsync method of the query result to get the subfolders in the current folder. This method returns a list of type **IReadOnlyList**<StorageFolder >. Each file or folder is represented by an item of type StorageFolder.

Gets a query result object that contains the subfolders in the current folder. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, gets a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. Files are grouped into folders based on the specified value from the CommonFolderQuery enumeration.

One of the enumeration values that specifies how to group the files into folders and determines whether the query is shallow or deep. A query result object. Call the GetFoldersAsync method of the query result to get the subfolders in the current folder. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, the query result object contains a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. (Files from the current folder are not included.) The files are grouped as specified by *query*.

Gets a query result object that contains the subfolders in the current folder and, optionally, nested subfolders. The results are based on the specified QueryOptions.

The criteria that are applied to the query. A query result object. Call the GetFoldersAsync method of the query result to get the subfolders in the current folder. If you provided a CommonFolderQuery value other than CommonFolderQuery.DefaultQuery when you instantiated the QueryOptions, the query result object contains a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. (Files from the current folder are not included.) The files are grouped as specified by *queryOptions*.

Gets a query result object that contains the files and subfolders in the current folder.

A query result object. Call the GetItemsAsync method of the query result to get the files and subfolders in the current folder. This method returns a list of type **IReadOnlyList**<IStorageItem >. Each file or folder is represented by an item of type IStorageItem.

Gets a query result object that contains the files and subfolders in the current folder and, optionally, in the subfolders of the current folder. The results are based on the specified QueryOptions.

The criteria that are applied to the query. A query result object. Call the GetItemsAsync method of the query result to get the files and subfolders in the current folder and, optionally, in the subfolders of the current folder, filtered and sorted based on the specified QueryOptions. This method returns a list of type **IReadOnlyList**<IStorageItem >. Each file or folder is represented by an item of type IStorageItem.

Deletes the current folder.

No object or value is returned by this method when it completes.

Deletes the current folder. This method also specifies whether to delete the folder permanently.

One of the enumeration values that specifies whether to delete the folder permanently. No object or value is returned by this method when it completes.

Gets the basic properties of the current folder or file group.

When this method completes successfully, it returns the basic properties of the current folder or file group as a BasicProperties object.

Gets the file with the specified name from the current folder.

The name (or path relative to the current folder) of the file to get. When this method completes successfully, it returns a StorageFile that represents the specified file.

Gets the files in the current folder.

When this method completes successfully, it returns a list of the files in the current folder. The list is of type **IReadOnlyList**<StorageFile >. Each file in the list is represented by a StorageFile object.

Gets the files in the current folder. Also gets the files from the subfolders of the current folder when the value of the *query* argument is something other than CommonFileQuery.DefaultQuery. Files are sorted based on the specified value from the CommonFileQuery enumeration.

One of the enumeration values that specifies how to sort the files and determines whether the query is shallow or deep. When this method completes successfully, it returns a flat list of files, sorted as specified by *query*. The list is of type **IReadOnlyList**<StorageFile >. Each file in the list is represented by a StorageFile object.

Gets an index-based range of files from the list of all files in the current folder. Also gets the files from the subfolders of the current folder when the value of the *query* argument is something other than CommonFileQuery.DefaultQuery. Files are sorted based on the specified value from the CommonFileQuery enumeration.

One of the enumeration values that specifies how to sort the files and determines whether the query is shallow or deep. The zero-based index of the first file in the range to retrieve. The maximum number of files to retrieve. When this method completes successfully, it returns a flat list of files sorted as specified by *query*. The list is of type **IReadOnlyList**<StorageFile >. Each file in the list is represented by a StorageFile object.

Gets the subfolder with the specified name from the current folder.

The name (or path relative to the current folder) of the subfolder to get. When this method completes successfully, it returns a StorageFolder that represents the specified subfolder.

Gets the folder that has the specified absolute path in the file system.

The absolute path in the file system (not the Uri) of the folder to get. When this method completes successfully, it returns a StorageFolder that represents the specified folder.

Gets the subfolders in the current folder.

When this method completes successfully, it returns a list of the subfolders in the current folder. The list is of type **IReadOnlyList**<StorageFolder >. Each folder in the list is represented by a StorageFolder object.

Gets the subfolders in the current folder. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, gets a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. Files are grouped into folders based on the specified value from the CommonFolderQuery enumeration.

One of the enumeration values that specifies how to group the files into folders and determines whether the query is shallow or deep. When this method completes successfully, it returns a list of subfolders. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, this method returns a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. (Files from the current folder are not included.) The files are grouped as specified by *query*. The list is of type **IReadOnlyList**<StorageFolder >.

Gets an index-based range of folders from the list of all subfolders in the current folder. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, gets a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. Files are grouped into folders based on the specified value from the CommonFolderQuery enumeration.

One of the enumeration values that specifies how to group the files into folders and determines whether the query is shallow or deep. The zero-based index of the first folder in the range to retrieve. The maximum number of folders to retrieve. When this method completes successfully, it returns a list of subfolders. When the value of the *query* argument is something other than CommonFolderQuery.DefaultQuery, this method returns a list of virtual folders that represent containers for groups of files in the subfolders of the current folder. (Files from the current folder are not included.) The files are grouped as specified by *query*. The list is of type **IReadOnlyList**<StorageFolder >.

Gets the indexed state of the current folder.

When this method completes successfully, it returns an IndexedState enum value that describes the state of the folder.

Gets the file or folder with the specified name from the current folder.

The name (or path relative to the current folder) of the file or folder to get. When this method completes successfully, it returns an IStorageItem that represents the specified file or folder.

Gets the files and subfolders in the current folder.

When this method completes successfully, it returns a list of the files and folders in the current folder. The list is of type **IReadOnlyList**<IStorageItem >. Each item in the list is represented by an IStorageItem object.

Gets an index-based range of files and folders from the list of all files and subfolders in the current folder.

The zero-based index of the first item in the range to get. The maximum number of items to get. When this method completes successfully, it returns a list of the files and subfolders in the current folder. The list is of type **IReadOnlyList**<IStorageItem >. Each item in the list is represented by an IStorageItem object.

Gets the parent folder of the current folder.

When this method completes, it returns the parent folder as a StorageFolder.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail and the requested size.

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail, the requested size, and the specified options

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or **null** if there is no thumbnail image associated with the item.

Gets a thumbnail image for the current folder, sized for the specified purpose of the thumbnail.

A value from the enumeration that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image, or **null** if there is no thumbnail image associated with the folder.

Gets a thumbnail image for the current folder, sized for the specified purpose of the thumbnail and adjusted to the requested size.

A value from the enumeration that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. This method uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image, or **null** if there is no thumbnail image associated with the folder.

Gets a thumbnail image for the current folder, sized for the specified purpose of the thumbnail and adjusted to the requested size with the specified options.

A value from the enumeration that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. This method uses the *requestedSize* as a guide and tries to scale the thumbnail image without reducing the quality of the image. A value from the enumeration that specifies how to retrieve and size the image. The default value, **UseCurrentScale**, is suitable for most apps. When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image, or **null** if there is no thumbnail image associated with the folder.

Indicates whether the current folder supports the specified CommonFileQuery.

The value to test. True if the folder supports the specified CommonFileQuery; otherwise, false.

Indicates whether the current folder supports the specified CommonFolderQuery.

The value to test. True if the folder supports the specified CommonFolderQuery; otherwise, false.

Indicates whether the current folder is equal to the specified folder.

The IStorageItem object that represents the folder to compare against. Returns true if the current folder is equal to the specified folder; otherwise false.

Indicates whether the current StorageFolder matches the specified StorageItemTypes value.

The enum value that determines the object type to match against. True if the StorageFolder matches the specified StorageItemTypes value; otherwise false.

Renames the current folder.

The desired, new name for the current folder. No object or value is returned by this method when it completes.

Renames the current folder and specifies what to do if a folder with the same name already exists.

The desired, new name for the current folder. The enum value that determines how Windows responds if the *desiredName* is the same as the name of an existing item in the current folder's location. No object or value is returned by this method when it completes.

Gets the StorageLibraryChangeTracker associated with a StorageFolder.

The StorageLibraryChangeTracker associated with a StorageFolder.

Tries to get the file or folder with the specified name from the current folder. Returns **null** instead of raising a **FileNotFoundException** if the specified file or folder is not found.

The name (or path relative to the current folder) of the file or folder to get. When this method completes successfully, it returns an IStorageItem that represents the specified file or folder. If the specified file or folder is not found, this method returns **null** instead of raising an exception.

Describes whether an item that implements the IStorageItem interface is a file or a folder.

A file that is represented as a StorageFile instance.

A folder that is represented as a StorageFolder instance.

A storage item that is neither a file nor a folder.

Lets you add and remove folders from a library like Music or Videos and lets you get a list of folders included in the library.

Returns the StorageLibraryChangeTracker associated with the storage library.

The StorageLibraryChangeTracker associated with the storage library.

Gets the folders in the current library.

The folders in the current storage library.

Get the default save folder for the current library.

The default save folder for the current library.

Occurs when the list of folders in the current library changes.

Determines if there are suggestions for adding existing folders with content to the StorageLibrary.

**True** if there are folder suggestions; **False** otherwise

Gets the specified library.

A KnownLibraryId value that identifies the library to retrieve, like Music or Videos. When this method completes successfully, it returns the library (type StorageLibrary ).

Gets the specified library for a User.

The User for which the library is retrieved. A KnownLibraryId value that identifies the library to retrieve, like Music or Videos. When this method completes successfully, it returns the library (type StorageLibrary ).

Prompts the user to select a folder, and then adds the folder to the library.

When this method completes, it returns the folder that the user picked and added as a StorageFolder. If the user cancels the operation and doesn't pick a folder, the method returns **null**.

Prompts the user to confirm removal of the specified folder from the current library, and then removes the folder.

The folder to remove. Returns true if the folder was removed; otherwise false.

Represents a change to an item in a storage library such as the documents, music, or video library.

Gets a StorageLibraryChangeType value that indicates the type of change represented by the object.

A StorageLibraryChangeType value that indicates the type of change represented by the object.

Gets the full path of the file or folder in the storage library that changed.

The full path of the file or folder in the storage library that changed.

Gets the full path of the item in a storage library before it was moved or renamed.

The full path of the file or folder in the storage library before it was moved or renamed.

Gets the storage item that has changed.

When this method completes successfully, it returns an IStorageItem that specifies the item that has changed.

Indicates whether the current StorageFolder matches the specified StorageItemTypes value.

The enum value that determines the object type to match against. True if the StorageFolder matches the specified StorageItemTypes value; otherwise false.

Enables the calling app to read through the changes to items in a storage library.

Tells the system that all of the changes described in the StorageLibraryChange objects returned by the call to ReadBatchAsync have been addressed by the app.

An object that is used to manage the asynchronous accept change operation.

Asynchronously gets a list of StorageLibraryChange objects.

A list of StorageLibraryChange objects.

Provides APIs that you can use to manage change tracking for any library in the system such as documents, music, or videos.

Enables change tracking for the storage library.

Retrieves an StorageLibraryChangeReader that enables the app to iterate through the list of changes and mark changes as accepted.

The returned change reader.

Resets change tracking for the storage library, deleting existing change tracking data.

Describes the type of change that occurred to the storage library item.

The change tracking information associated with the item was lost. Call Reset to reestablish continuity with the storage library.

The contents of the item changed.

The contents have been replaced.

The item was created.

The item was deleted.

The encryption applied to this item has changed.

The item was changed from one where the content can be indexed to one where the content can't be indexed, or vice versa. Content indexing permits rapid searching of data by building a database of selected content.

The item was moved into a library

The item was moved or renamed.

The item was moved out of a library.

Provides options to use when opening a file.

Only allow the file to be read.

Allows both readers and writers to coexist.

No options are specified.

Contains info about the service that stores files and folders. Files and folders may be stored either by the local file system or by a remote service like Microsoft OneDrive.

Gets a user-friendly name for the current provider of files and folders.

The user-friendly name for the provider. This name is localized to the current system locale.

Gets an identifier for the current provider of files and folders.

The identifier for the provider.

Determines if a property is supported by a cloud storage provider.

The name of the property. E.g., "System.Photo.DateTaken" or "System.Music.Artist" **True** if the property is supported by the cloud storage provider; **False** otherwise

Represents a write transaction for a random-access stream.

Gets the random-access stream used in the transaction.

The random-access stream.

Releases system resources that are exposed by the stream, indicating that the data request is complete.

Save the stream to the underlying file.

No object or value is returned by this method.

Represents a sequential-access output stream that indicates a request for the data stream of a StorageFile that was created by calling CreateStreamedFileAsync or ReplaceWithStreamedFileAsync.

Releases system resources that are exposed by the current stream indicating that the data request is complete.

Indicates that the data can't be streamed and releases system resources that are exposed by the current stream indicating that the data request is complete.

The enum value that indicates why the data stream can't be accessed.

Flushes the data in the current stream.

When this method completes, it returns true if the data was flushed successfully or false if the flush operation failed.

Writes data from a buffer to the current stream.

The buffer that contains the data to write. When this method completes, it returns the number of bytes (type UInt32 ) that were written to the stream. If the app specifies a function to monitor progress, that function receives the number of bytes (type UInt32 ) written so far.

Represents the method that will stream data into a StorageFile when that file is first accessed.

The request for the streamed data in the StorageFile that was created by the CreateStreamedFileAsync or ReplaceWithStreamedFileAsync method.

Indicates the reason that data could not be streamed.

The data could not be accessed.

Streaming the data failed.

Streaming the data failed to complete.

A helper object that provides indexing names for Windows audio file properties.

Gets the name of the System.Audio.EncodingBitrate property (one of the Windows audio file properties ).

The name of the System.Audio.EncodingBitrate property.

Gets some commonly used system wide folder locations based on the KNOWNFOLDERID naming pattern.

Gets the path to the fonts folder.

The full path to the fonts folder.

Gets the path to the ProgramData folder on the machine.

The full path to the ProgramData folder.

Gets the path to the Public folder on the machine.

The full path to the Public folder.

Gets the path to the Public Desktop folder on the machine.

The full path to the Public Desktop folder.

Gets the path to the Public Documents folder on the machine.

The full path to the Public Documents folder.

Gets the path to the Public Downloads folder on the machine.

The full path to the Public Downloads folder.

Gets the path to the Public Music folder on the machine.

The full path to the Public Music folder.

Gets the path to the Public Pictures folder on the machine.

The full path to the Public Pictures folder.

Gets the path to the Public Videos folder on the machine.

The full path to the Public Videos folder.

Gets the path to the Windows system folder.

The full path to the Windows system folder.

Gets the path to the System folder for a machine using an ARM operating system.

The full path to the System folder within an ARM operating system.

Gets the path to the System folder regardless of the operating system architecture (x64, x86, ARM).

The full path to the System folder.

Gets the path to the 64-bit Windows system folder.

The full path to the 64-bit Windows system folder.

Gets the path to the 32-bit Windows system folder.

The full path to the 32-bit Windows system folder.

Gets a path to the user profiles for the computer.

The full path to the user profiles.

Gets a path to the Windows directory.

The full path to the Windows directory.

Gets the paths to various system data folders.

The app data paths associated with the system data.

A helper object that provides indexing names for GPS file properties.

Gets the name of the property (one of the GPS file properties.

The name of the file property.

Gets the name of the property (one of the GPS file properties.

The name of the file property.

A helper object that provides indexing names for Windows image file properties.

Gets the name of the System.Image.HorizontalSize property (one of the Windows image file properties.

The name of the System.Image.HorizontalSize file property.

Gets the name of the System.Image.VerticalSize property (one of the Windows image file properties ).

The name of the System.Image.VerticalSize file property.

A helper object that provides indexing names for Windows media file properties.

Gets the name of the System.Media.Duration property (one of the Windows media file properties.

The name of the System.Media.Duration file property.

Gets the name of the System.Media.Producer property (one of the Windows media file properties.

The name of the System.Media.Producer file property.

Gets the name of the System.Media.Publisher property (one of the Windows media file properties.

The name of the System.Media.Publisher file property.

Gets the name of the System.Media.SubTitle property (one of the Windows media file properties.

The name of the System.Media.SubTitle file property.

Gets the name of the System.Media.Writer property (one of the Windows media file properties.

The name of the System.Media.Writer file property.

Gets the name of the System.Media.Year property (one of the Windows media file properties.

The name of the System.Media.Year file property.

A helper object that provides indexing names for Windows music file properties.

Gets the name of the System.Music.AlbumArtist property (one of the Windows music file properties.

The name of the System.Music.AlbumArtist file property.

Gets the name of the System.Music.AlbumTitle property (one of the Windows music file properties.

The name of the System.Music.AlbumTitle file property.

Gets the name of the System.Music.Artist property (one of the Windows music file properties.

The name of the System.Music.Artist file property.

Gets the name of the System.Music.Composer property (one of the Windows music file properties.

The name of the System.Music.Composer file property.

Gets the name of the System.Music.Conductor property (one of the Windows music file properties.

The name of the System.Music.Conductor file property.

Gets the name of the System.Music.DisplayArtist property (one of the Windows music file properties.

The name of the System.Music.DisplayArtist file property.

Gets the name of the System.Music.Genre property (one of the Windows music file properties.

The name of the System.Music.Genre file property.

Gets the name of the System.Music.TrackNumber property (one of the Windows music file properties.

The name of the System.Music.TrackNumber file property.

A helper object that provides indexing names for Windows photo file properties.

Gets the name of the System.Photo.CameraManufacturer property (one of the Windows photo file properties.

The name of the System.Photo.CameraManufacturer file property.

Gets the name of the System.Photo.CameraModel property (one of the Windows photo file properties.

The name of the System.Photo.CameraModel file property.

Gets the name of the System.Photo.DateTaken property (one of the Windows photo file properties.

The name of the System.Photo.DateTaken file property.

Gets the name of the System.Photo.Orientation property (one of the Windows photo file properties.

The name of the System.Photo.Orientation file property.

Gets the name of the System.Photo.PeopleNames property (one of the Windows photo file properties.

The name of the System.Photo.PeopleNames file property.

Provides string values for indexing names of common Windows file properties such as System.Title, and also references helper objects that provide indexing names for properties of specific file types (for example video files).

Gets an object that provides the indexing names of Windows file properties for **System.Audio**.

A helper object that provides names for Windows file properties for **System.Audio**.

Gets the name of the System.Author property (one of the Windows file properties.

The name of the System.Author file property.

Gets the name of the System.Comment property (one of the Windows file properties.

The name of the System.Comment file property.

Gets an object that provides the indexing names of Windows system file properties for **System.GPS**.

A helper object that provides names for GPS-related file properties.

Gets an object that provides the indexing names of Windows file properties for **System.Image**.

A helper object that provides names for Windows file properties for **System.Image**.

Gets the name of the System.ItemNameDisplay property (one of the Windows file properties.

The name of the System.ItemNameDisplay file property.

Gets the name of the System.Keywords property (one of the Windows file properties.

The name of the System.Keywords file property.

Gets an object that provides the indexing names of system media file properties such as System.Media.Duration.

A helper object that provides names for system media file properties.

Gets an object that provides the indexing names of Windows file properties for **System.Music**.

A helper object that provides names for Windows file properties for **System.Music**.

Gets an object that provides the indexing names of Windows file properties for **System.Photo**.

A helper object that provides names for Windows file properties for **System.Photo**.

Gets the name of the System.Rating property (one of the Windows file properties.

The name of the System.Rating file property.

Gets the name of the System.Title property (one of the Windows file properties.

The name of the System.Title file property.

Gets an object that provides the indexing names of Windows file properties for **System.Video**.

A helper object that provides names for Windows file properties for **System.Video**.

A helper object that provides indexing names for video file properties.

Gets the name of the System.Video.Director property (one of the Windows video file properties.

The name of the System.Video.Director file property.

Gets the name of the System.Video.FrameHeight property (one of the Windows video file properties.

The name of the System.Video.FrameHeight file property.

Gets the name of the System.Video.FrameWidth property (one of the Windows video file properties.

The name of the System.Video.FrameWidth file property.

Gets the name of the System.Video.Orientation property (one of the Windows video file properties.

The name of the System.Video.Orientation file property.

Gets the name of the System.Video.TotalBitrate property (one of the Windows video file properties.

The name of the System.Video.TotalBitrate file property.

Returns full paths for common user data folders. User data folders are based on the KNOWNFOLDERID naming pattern.

Gets the path to a user's Camera Roll folder.

The full path to the user's Camera Roll folder.

Gets the path to a user's Cookies app data folder.

The full path to the user's Cookies app data folder.

Gets the path to a user's Desktop folder.

The full path to the user's Desktop folder.

Gets the path to a user's Documents folder.

The full path to the user's Documents folder.

Gets the path to a user's Downloads folder.

The full path to the user's Downloads folder.

Gets the path to a user's Favorites folder.

The full path to the user's Favorites folder.

Gets the path to a user's History folder.

The full path to the user's History folder.

Gets the path to a user's Temporary Internet Files folder.

The full path to the user's Temporary Internet Files folder.

Gets the path to a user's Local app data folder.

The full path to the user's Local app data folder.

Gets the path to a user's LocalLow app data folder.

The full path to the user's LocalLow app data folder.

Gets the path to a user's Music folder.

The full path to the user's Music folder.

Gets the path to a user's Pictures folder.

The full path to the user's Pictures folder.

Gets the path to a user's profile on the machine.

The full path to the user's profile folder.

Gets the path to a user's Recent Items folder.

The full path to the user's Recent Items folder.

Gets the path to a user's Roaming app data folder.

The full path to the user's Roaming app data folder.

Gets the path to a user's Saved Pictures folder.

The full path to the user's Saved Pictures folder.

Gets the path to a user's Screenshots folder.

The full path to the user's Screenshots folder.

Gets the path to a user's Common Templates folder.

The full path to the user's Common Templates folder.

Gets the path to a user's Videos folder.

The full path to the user's Videos folder.

Gets the paths to a user's various data folders. Use this method for single user machines.

The data folders associated with the user.

Gets the paths to a user's various data folders. Use this method for multi-user machines.

The user to retreive the paths for. The data folders associated with the user.

Describes the behavior to use when the app accesses an item in a list.

When the app accesses the item, the user is prevented from entering information.

When the app accesses the item, it is retrieved from a fast location like the local file system.

Default.

When the app accesses the item in the StorageItemMostRecentlyUsedList, Windows preserves the item's current position in the most recently used (MRU) and does not update the access time of the item.

When the app accesses the item, the app retrieves a cached, read-only version of the file. This version of the file might not be the most recent.

Represents a list entry that contains the identifier and metadata for a StorageFile or StorageFolder object in a list.

Optional app-specified metadata associated with the StorageFile or StorageFolder in the list.

The identifier of the StorageFile or StorageFolder in the list.

A list of the entries that are in your app's most recently used list (MRU) (obtained from the static StorageApplicationPermissions.MostRecentlyUsedList property) and in your app's future-access list (obtained from the static StorageApplicationPermissions.FutureAccessList property).

Gets the number of storage items in the access list or most recently used (MRU) list.

The number of entries.

Retrieves the first storage item from the access list or most recently used (MRU) list.

The first item.

Retrieves the storage item at the specified index in the access list or most recently used (MRU) list.

The The storage item.

Retrieves the storage items that start at the specified index in the access list or most recently used (MRU) list.

The zero-based index of the start of the items in the collection to retrieve. The items in the collection that start at *startIndex*. The number of items retrieved.

Retrieves the index of the specified storage item in the access list or most recently used (MRU) list.

The storage item. The zero-based index of the storage item. True if the specified storage item exists in the list; otherwise false.

Represents a list of storage items that the app has stored for efficient future access.

Gets an object for retrieving storage items from the access list.

The object for retrieving storage items.

Gets the maximum number of storage items that the access list can contain.

The maximum number of storage items.

Adds a new storage item to the access list.

The storage item to add. A token that the app can use later to retrieve the storage item.

Adds a new storage item and accompanying metadata to the access list.

The storage item to add. Optional metadata to associate with the storage item. A token that the app can use later to retrieve the storage item.

Adds a new storage item to the access list, or replaces the specified item if it already exists in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace.

Adds a new storage item and accompanying metadata to the access list, or replaces the specified item if it already exists in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace. Optional metadata to associate with the storage item.

Determines whether the app has access to the specified storage item in the access list.

The storage item to check for access. True if the app can access the storage item; otherwise false.

Removes all storage items from the access list.

Determines whether the access list contains the specified storage item.

The token of the storage item to look for. True if the access list contains the specified storage item; false otherwise.

Retrieves the specified StorageFile from the list.

The token of the StorageFile to retrieve. When this method completes successfully, it returns the StorageFile that is associated with the specified *token*.

Retrieves the specified StorageFile from the list using the specified options.

The token of the StorageFile to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the StorageFile that is associated with the specified *token*.

Retrieves the specified StorageFolder from the list.

The token of the StorageFolder to retrieve. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified StorageFolder from the list using the specified options.

The token of the StorageFolder to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the list.

The token of the item to retrieve. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the list using the specified options.

The token of the item to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Removes the specified storage item from the access list.

The token of the storage item to remove.

Provides data about an ItemRemoved event.

Gets information about the StorageFile or StorageFolder that was removed from the StorageItemMostRecentlyUsedList.

A structure that contains information about the StorageFile or StorageFolder that was removed.

Describes the extent of the visibility of a storage item added to the most recently used (MRU) list.

The storage item is visible in the most recently used (MRU) list for the app and the system.

The storage item is visible in the most recently used (MRU) list for the app only.

Provides static properties for you to get your app's most recently used list (MRU) (use StorageApplicationPermissions.MostRecentlyUsedList ) and future-access list (use StorageApplicationPermissions.FutureAccessList.

Gets an object that represents a list that an app maintains so that the app can store files and/or locations (like folders) and easily access these items in the future.

The future-access list object.

Gets an object that represents a list that an app can use to track the files and/or locations (like folders) that the app has accessed most recently.

The most recently used (MRU) list object.

Gets an object that represents a list that an app maintains so that the app can store files and/or locations (like folders) and easily access these items in the future. This method returns an object that is scoped to the specified user. Use this method for multi-user applications.

The user for which to create the future-access list object. The future-access list object.

Gets an object that an app can use to track the files and/or locations (like folders) that the app has accessed most recently. This method returns an object that is scoped to the specified user. Use this method for multi-user applications.

The user for which to create the most recently used (MRU) list object. The most recently used (MRU) list object.

Represents your app's future-access list (obtained from the static StorageApplicationPermissions.FutureAccessList property). By picking files and folders, your user grants your app permission to access items that might not be accessible otherwise. If you add these items to your future-access list then you'll retain that permission when your app wants to access those items again later. Items are stored in the future-access list as StorageFile and StorageFolder objects.

Gets an object for retrieving storage items from the access list.

The object for retrieving storage items.

Gets the maximum number of storage items that the access list can contain.

The maximum number of storage items.

Adds a new storage item to the access list.

The storage item to add. A token that the app can use later to retrieve the storage item.

Adds a new storage item and accompanying metadata to the access list.

The storage item to add. Optional metadata to associate with the storage item. A token that the app can use later to retrieve the storage item.

Adds a new storage item to the access list, or replaces the specified item if it already exists in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace.

Adds a new storage item and accompanying metadata to the access list, or replaces the specified item if it already exists in the list.

A token that the app can use later to retrieve this storage item. The storage item to add or replace. Optional metadata to associate with the storage item.

Determines whether the app has access to the specified storage item in the access list.

The storage item to check for access. True if the app can access the storage item; otherwise false.

Removes all storage items from the access list.

Determines whether the access list contains the specified storage item.

The token of the storage item to look for. True if the access list contains the specified storage item; false otherwise.

Retrieves the specified StorageFile from the list.

The token of the StorageFile to retrieve. When this method completes successfully, it returns the StorageFile that is associated with the specified *token*.

Retrieves the StorageFile from the list using the specified options.

The token of the StorageFile to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the StorageFile that is associated with the specified *token*.

Retrieves the specified StorageFolder from the list.

The token of the StorageFolder to retrieve. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified StorageFolder from the list using the specified options.

The token of the StorageFolder to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the most recently used (MRU) list.

The token of the item to retrieve. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the list using the specified options.

The token of the item to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Removes the specified storage item from the access list.

The token of the storage item to remove.

Represents your app's most recently used list (MRU) (obtained from the static StorageApplicationPermissions.MostRecentlyUsedList property). You use your MRU to track items (files and/or folders) that the user has accessed most recently. Items are stored in the MRU as StorageFile and StorageFolder objects.

Gets an object for retrieving storage items from the most recently used (MRU) list.

The object for retrieving storage items.

Gets the maximum number of storage items that the most recently used (MRU) list can contain.

The maximum number of storage items.

Fires when a storage item is removed from the most recently used (MRU) list.

Adds a new storage item to the most recently used (MRU) list.

The storage item to add. A token that the app can use later to retrieve the storage item.

Adds a new storage item and accompanying metadata to the most recently used (MRU) list.

The storage item to add. Optional metadata to associate with the storage item. A token that the app can use later to retrieve the storage item.

Adds a new storage item and accompanying metadata to the most recently used (MRU) list, specifying the extent of its visibility in the list.

The storage item to add. Optional metadata to associate with the storage item. The extent of the visibility of the storage item in the list. A token that the app can use later to retrieve the storage item.

Adds a new storage item to the most recently used (MRU) list, or replaces the specified item if it already exists in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace.

Adds a new storage item and accompanying metadata to the most recently used (MRU) list, or replaces the specified item if it already exists in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace. Optional metadata to associate with the storage item.

Adds a new storage item and accompanying metadata to the most recently used (MRU) list, or replaces the specified item if it already exists in the list. Also specifies the extent of its visibility in the list.

The token associated with the new storage item. If the access list already contains a storage item that has this token, the new item replaces the existing one. The storage item to add or replace. Optional metadata to associate with the storage item. The extent of the visibility of the storage item in the list.

Determines whether the app has access to the specified storage item in the most recently used (MRU) list.

The storage item to check for access. True if the app can access the storage item; otherwise false.

Removes all storage items from the most recently used (MRU) list.

Determines whether the most recently used (MRU) list contains the specified storage item.

The token of the storage item to look for. True if the most recently used (MRU) list contains the specified storage item; false otherwise.

Retrieves the specified storageFile from the most recently used (MRU) list.

The token of the storageFile to retrieve. When this method completes successfully, it returns the storageFile that is associated with the specified *token*.

Retrieves the specified storageFile from the most recently used (MRU) list using the specified options.

The token of the storageFile to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the storageFile that is associated with the specified *token*.

Retrieves the specified StorageFolder from the most recently used (MRU) list.

The token of the StorageFolder to retrieve. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified StorageFolder from the most recently used (MRU) list using the specified options.

The token of the StorageFolder to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the StorageFolder that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the most recently used (MRU) list.

The token of the item to retrieve. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Retrieves the specified item (like a file or folder) from the most recently used (MRU) list using the specified options.

The token of the item to retrieve. The enum value that describes the behavior to use when the app accesses the item. When this method completes successfully, it returns the item (type IStorageItem ) that is associated with the specified *token*.

Removes the specified storage item from the most recently used (MRU) list.

The token of the storage item to remove.

Provides synchronous access to the properties exposed off StorageFile and lets an app perform asynchronous file operations such as copy, delete, move, and rename.

Gets the attributes of a file.

The file attributes.

Gets an object that contains the basic properties information of the file.

The basic properties object.

Gets a string that describes the contents of the file.

The content type string.

Gets the date that the file was created.

The file creation date.

Gets the user-friendly name of the StorageFile.

The user-friendly name of the StorageFile.

Gets the display type of the StorageFile.

The display type.

Gets an object that provides access to the document properties of the StorageFile, such as the title, author name, and so on.

The document properties.

Gets the file type.

The file type.

Gets the identifier that uniquely identifies the StorageFile relative to other items in the same folder.

The folder-relative identifier.

Gets the image properties of the StorageFile, such as the title, rating, date that the image was taken,

The image properties.

Indicates if the current file has been downloaded or can be downloaded.

**True** if the file has been downloaded or can be downloaded. Otherwise, **false**.

Gets the music properties associated with the StorageFile, such as the album name, artist name, bit rate, and so on.

The music properties.

Gets the name of the StorageFile.

The name.

Gets the path of the StorageFile.

The path.

Gets an object for retrieving the properties of the StorageFile.

An object for retrieving StorageFile properties.

Gets the StorageProvider object that contains info about the service that stores the current file.

The StorageProvider object that contains info about the service that stores the current file. The file may be stored by the local file system or by a remote service like Microsoft OneDrive.

Gets the thumbnail associated with the StorageFile.

The thumbnail.

Gets an object that provides access to the video properties of the StorageFile, such as the duration, rating, date released, and so on.

The video properties.

Occurs when one or more of the StorageFile 's properties is updated.

Fires when the StorageFile 's thumbnail is updated or a better quality thumbnail is available.

Replaces the specified StorageFile with a copy of the current file.

The StorageFile to be replaced. No object or value is returned when this method completes.

Creates a copy of the StorageFile and stores it in the specified StorageFolder.

The folder in which to store the copied file. When this method completes successfully, it returns the copy as a StorageFile object.

Creates a copy of the StorageFile, gives it the specified file name, and stores it in the specified StorageFolder.

The folder in which to store the copied file. The name of the new copy. When this method completes successfully, it returns the copy as a StorageFile object.

Creates a copy of the StorageFile, gives it the specified file name, and stores it in the specified StorageFolder. The method also specifies what to do if a file with the same name already exists in the specified folder.

The folder in which to store the copied file. The name of the new copy. A value that indicates what to do if the file name already exists in the destination folder. When this method completes successfully, it returns the copy as a StorageFile object.

Deletes a file.

No object or value is returned when this method completes.

Deletes a file, optionally moving the deleted file to the recycle bin.

A value that specifies whether the deleted file is moved to the recycle bin. No object or value is returned when this method completes.

Retrieves the basic properties of the StorageFile.

When this method completes successfully, it returns a BasicProperties object.

Gets the parent folder of the current file.

When this method completes, it returns the parent folder as a StorageFolder.

Retrieves the thumbnail that is associated with the StorageFile.

The thumbnail mode to retrieve. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Retrieves the thumbnail that is associated with the StorageFile, scaling it to the specified size.

The thumbnail mode to retrieve. The requested size in pixels of thumbnail to retrieve. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Retrieves the thumbnail that is associated with the StorageFile, based on the specified options.

The thumbnail mode to retrieve. The requested size in pixels of thumbnail to retrieve. The thumbnail retrieval options. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Indicates whether the current file is the same as the specified storage item.

The IStorageItem object that represents a storage item to compare against. Returns **true** if the current storage item is the same as the specified storage item; otherwise **false**.

Determines whether the loaded StorageFile is the specified type.

The type of item to check against. True if the loaded StorageFile is the specified type; otherwise false.

Moves the current StorageFile from its location and uses it to replace the specified StorageFile.

The StorageFile to be replaced. An object for managing the asynchronous move and replace operation.

Moves the StorageFile to the specified StorageFolder.

The destination folder. No object or value is returned when this method completes.

Moves the StorageFile to the specified folder, and gives the file the specified file name.

The destination folder. The new file name. No object or value is returned when this method completes.

Moves the StorageFile to the specified folder and gives it the specified file name. The method also specifies what to do if a file with the same name already exists in the specified folder.

The destination folder. The new file name. A value that indicates what to do if the file name already exists in the destination folder. No object or value is returned when this method completes.

Opens a random-access stream with the specified options over the specified file.

One of the enumeration values that specifies the type of access to allow. When this method completes, it returns an IRandomAccessStream that contains the requested random-access stream.

Opens a random-access stream with the specified options over the specified file.

One of the enumeration values that specifies the type of access to allow. A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns an IRandomAccessStream that contains the requested random-access stream.

Opens a read-only, random-access stream over the StorageFile.

When this method completes successfully, it returns a read-only, random-access stream (type IRandomAccessStreamWithContentType ).

Opens a read-only, sequential-access stream over the StorageFile.

When this method completes successfully, it returns a read-only, sequential-access stream (type IInputStream ).

Opens a random-access stream to the file that can be used for transacted-write operations.

When this method completes, it returns a StorageStreamTransaction that contains the random-access stream and methods that can be used to complete transactions.

Opens a random-access stream to the file that can be used for transacted-write operations with the specified options.

A bitwise combination of the enumeration values that specify options for opening the stream. When this method completes, it returns a StorageStreamTransaction that contains the random-access stream and methods that can be used to complete transactions.

Renames the StorageFile.

The new name. No object or value is returned when this method completes.

Renames the StorageFile, and specifies what to do if a file with the same name already exists in the current folder.

The new name. A value that indicates what to do if the file name already exists in the current folder. No object or value is returned when this method completes.

Used to load information about files and folders from the results of a query and to bind these file system items to JavaScript [ListView](https://docs.microsoft.com/previous-versions/windows/apps/br211837(v=win.10)) or XAML ListView and GridView controls. After information is loaded, an app can then access that information quickly using synchronous operations.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result.

The result of a query of files and folders on the system. A value that indicates the type of thumbnail view to retrieve for the StorageFile and StorageFolder.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result and that specifies the requested size for thumbnails that are retrieved for the objects.

The result of a query of files and folders on the system. A value that indicates the type of thumbnail view to retrieve for the StorageFile and StorageFolder. The requested minimum size, in pixels, of the StorageFile and StorageFolder thumbnails.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, and that specifies the requested size and options for thumbnails that are retrieved for the objects.

The result of a query of files and folders on the system. A value that indicates the type of thumbnail view to retrieve for the StorageFile and StorageFolder. The requested minimum size, in pixels, of the StorageFile and StorageFolder thumbnails. The thumbnail retrieval options.

Creates a new FileInformationFactory object that retrieves information about the StorageFile and StorageFolder objects in the specified query result, specifies the requested size and options for thumbnails that are retrieved for the objects, and indicates whether to delay loading information.

The result of a query of files and folders on the system. A value that indicates the type of thumbnail view to retrieve for the StorageFile and StorageFolder. The requested minimum size, in pixels, of the StorageFile and StorageFolder thumbnails. The thumbnail retrieval options. True to delay loading information; otherwise false. By default, this option is false and delay loading is not used.

Retrieves a collection of FileInformation objects that contain information about all StorageFile objects in a collection.

When this method completes successfully, it returns the list (type IVectorView ) of FileInformation objects.

Retrieves a collection of FileInformation objects that contain information about a range of StorageFile objects in a collection.

The zero-based index of the first StorageFile in the range. The maximum number of StorageFile objects to retrieve information for. When this method completes successfully, it returns the list (type IVectorView ) of FileInformation objects.

Retrieves a collection of FolderInformation objects that contain information about all StorageFolder objects in a collection.

When this method completes successfully, it returns the list (type IVectorView ) of FolderInformation objects.

Retrieves a collection of FolderInformation objects that contain information about a range of StorageFolder objects in a collection.

The zero-based index of the first StorageFolder in the range. The maximum number of StorageFolder objects to retrieve information for. When this method completes successfully, it returns the list (type IVectorView ) of FolderInformation objects.

Retrieves a collection of IStorageItemInformation objects that contain information about all the items in the collection.

When this method completes successfully, it returns the list (type IVectorView ) of FileInformation and FolderInformation objects.

Retrieves a collection of IStorageItemInformation objects that contain information about a range of items in a collection.

The zero-based index of the first item in the range. The maximum number of items to retrieve information for. When this method completes successfully, it returns the list (type IVectorView ) of FileInformation and FolderInformation objects.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

The virtualized vector of IStorageItemInformation objects.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

The virtualized vector of IStorageItemInformation objects.

Gets a virtualized vector of IStorageItemInformation objects that can be bound to ListView or GridView controls in C#, C++, and VB.

The virtualized vector of IStorageItemInformation objects.

Provides synchronous access to the properties exposed off StorageFolder and lets an app perform asynchronous management operations such as copy, delete, move, and rename.

Gets the attributes of a loaded folder.

The folder attributes.

Gets an object that contains the basic properties information of the folder.

The basic properties object.

Gets the date that the folder was created.

The folder creation date.

Gets the user-friendly name of the StorageFolder.

The user-friendly name of the StorageFolder.

Gets the display type of the StorageFolder.

The display type.

Gets the document properties of the StorageFolder.

The document properties.

Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.

The folder-relative identifier.

Gets the image properties of the StorageFolder.

The image properties.

Gets the music properties associated with the StorageFolder.

The music properties.

Gets the name of the StorageFolder.

The StorageFolder name.

Gets the path of the StorageFolder.

The path.

Gets an object for retrieving the properties of the StorageFolder.

The object for retrieving StorageFolder properties.

Gets the StorageProvider object that contains info about the service that stores the current folder.

The StorageProvider object that contains info about the service that stores the current folder. The file may be stored by the local file system or by a remote service like Microsoft OneDrive.

Gets the thumbnail for the StorageFile.

The thumbnail.

Gets the video properties that are associated with the StorageFolder.

The video properties.

Occurs when one or more of the StorageFolder 's properties is updated.

Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.

Retrieves a value that indicates whether the folder supports the specified search query options.

The search query options to test. True if the folder supports the specified search query options; otherwise false.

Creates a new file in the current folder.

The name of the new file. When this method completes successfully, it returns a StorageFile that represents the new file.

Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

The name of the new file. A value that indicates what to do if the file name already exists in the current folder. When this method completes successfully, it returns a StorageFile that represents the new file.

Creates an object for performing filtered search queries for StorageFile in the current folder.

An object for managing the search queries and accessing the results.

Creates an object for performing filtered search queries for StorageFile objects in the current folder. Search results are grouped based on the specified file attribute.

A value that specifies the folder attribute to use to group the search results. An object for managing the search queries and accessing the results.

Creates an object used to perform filtered search queries for StorageFile objects in the folder. The object is initialized with the specified query options.

The initial query options. An object for managing the search queries and accessing the results.

Creates a new child folder of the current folder.

The name of the new folder. When this method completes successfully, it returns a StorageFolder that represents the new file.

Creates a new child folder of the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

The name of the new folder. A value that indicates what to do if the child folder already exists in the current folder. When this method completes successfully, it returns a StorageFolder that represents the new file.

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.

An object for managing the search queries and accessing the results.

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. Search results are grouped based on the specified folder attribute.

A value that specifies the folder attribute to use to group the search results. An object for managing the search queries and accessing the results.

Creates an object used to perform filtered search queries for child StorageFolder objects of the current folder. The object is initialized with the specified query options.

The initial query options. An object for managing the search queries and accessing the results.

Creates an object used to perform filtered search queries for items in the folder.

An object for managing the search queries and accessing the results.

Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options.

The initial query options. An object for managing the search queries and accessing the results.

Deletes the current folder.

No object or value is returned when this method completes.

Deletes the current folder, optionally moving the deleted folder to the recycle bin.

A value that specifies whether to move the deleted folder to the recycle bin. No object or value is returned when this method completes.

Retrieves the basic properties of the StorageFolder object.

When this method completes successfully, it returns a BasicProperties object.

Retrieves a file from the current folder.

The name of the file to retrieve. When this method completes successfully, it returns a StorageFile.

Retrieves all files from the current folder.

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Retrieves files from the current folder based on a common folder query.

The common file query. When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Retrieves a range of files from the current folder based on a common file query.

The common file query. The zero-based index of the first file in the range. The maximum number of files to retrieve. When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

Retrieves the specified child folder from the current folder.

The name of the child folder to retrieve. When this method completes successfully, it returns a StorageFolder that represents the specified child folder.

Retrieves all child folders from the current folder.

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Retrieves child folders from the current folder based on a common folder query.

The common folder query. When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Retrieves a range of child folders from the current folder based on a common folder query.

The common folder query. The zero-based index of the first child folder in the range. The maximum number of child folders to retrieve. When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

Retrieves the indexed state of the folder.

When this method completes successfully, it returns an IndexedState enumeration value.

Retrieves an item from the folder.

The name of the item to retrieve. When this method completes successfully, it returns the item (type IStorageItem ).

Retrieves all items from the current folder.

When this method completes successfully, it returns the list (type IVectorView ) of items.

Retrieves a range of items from the current folder.

The zero-based index of the first item in the range. The maximum number of items to retrieve. When this method completes successfully, it returns the list (type IVectorView ) of items.

Gets the parent folder of the current folder.

When this method completes, it returns the parent folder as a StorageFolder.

Retrieves the thumbnail that is associated with the StorageFolder.

The thumbnail mode to retrieve. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.

The thumbnail mode to retrieve. The requested size in pixels of thumbnail to retrieve. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.

The thumbnail mode to retrieve. The requested size in pixels of thumbnail to retrieve. The thumbnail retrieval options. When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Retrieves a value that indicates whether the current folder supports the specified common file query.

The common file query to test. True if the folder supports the specified common file query; otherwise false.

Retrieves a value that indicates whether the current folder supports the specified common folder query.

The common folder query to test. True if the folder supports the specified common folder query; otherwise false.

Indicates whether the current folder is equal to the specified folder.

The IStorageItem object that represents the folder to compare against. Returns **true** if the current folder is equal to the specified folder; otherwise **false**.

Determines whether the loaded StorageFolder is the specified type.

The type of item to check against. True if the loaded StorageFolder is the specified type; otherwise false.

Renames the StorageFolder.

The new name. No object or value is returned when this method completes.

Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

The new name. A value that indicates what to do if a folder with *desiredName* already exists. No object or value is returned when this method completes.

Try to get a specific file or sub-folder from the current folder using the name of the file or folder to get.

The name (or path relative to the current folder) of the file or sub-folder to try to retrieve. When this method completes successfully, it returns the file or folder (type IStorageItem ).

Provides synchronous access to the properties of a file or folder in the file system.

Gets an object that contains the basic properties information of the item.

The basic properties object.

Gets an object that provides access to the document properties of the item, such as the title, author name, and so on.

The document properties.

Gets an object that provides access to the image properties of the item, such as the title, rating, date that the image was taken, and so on.

The image properties.

Gets an object that provides access to the music properties of the item, such as the album name, artist name, bit rate, and so on.

The music properties.

Gets the thumbnail associated with the item.

The thumbnail.

Gets an object that provides access to the video properties of the item, such as the duration, rating, date released, and so on.

The video properties.

Occurs when one or more of the item's properties is updated.

Fires when the item's thumbnail is updated or a better quality thumbnail is available.

Identifies a compression algorithm to use when creating an instance of a compressor.

This value represents an invalid compression algorithm. It is useful primarily for error checking.

The compressor will use the LZMS compression algorithm.

The compressor will use the MSZIP compression algorithm.

This value represents an algorithm that passes data through with no compression. It is useful primarily for testing.

The compressor will use the XPRESS compression algorithm.

The compressor will use the XPRESS compression algorithm with Huffman encoding.

A compressor takes information written to a stream and compresses it using a compression algorithm.

Creates an instance of a compressor.

The stream of compressed information to be written by the compressor.

Creates an instance of a compressor.

The stream of compressed information to be written by the compressor. The compression algorithm used by the compressor to write *underlyingStream*. Size in bytes of the intermediate buffer used by the compression algorithm. A value of 0 specifies that the compression algorithm will use its default block size. Valid non-zero values for this parameter are 32Kb to 64Mb.

Closes a Compressor object and synchronously discards any information in buffers. This will close the underlying stream as well unless the Compressor.Detach method has been used to detach the stream from the object. Subsequent calls on a closed object, except for , will fail.

Detaches the underlying stream from the Compressor object so that the object can be closed using the Compressor.Close method without also closing the underlying stream.

The stream of information.

Finishes writing the compression stream.

The asynchronous operation.

Flushes the compression stream asynchronously.

The asynchronous operation.

Writes information to the compression stream asynchronously.

The buffer that contains the information to be written to the stream. The asynchronous operation.

A decompressor takes a stream compressed by a compressor and decompresses it.

This method creates an instance of a decompressor.

The stream of compressed information to be read and decompressed by the decompressor.

Closes a Decompressor object and synchronously discards any information in buffers. This will close the underlying stream as well unless the Decompressor.Detach method has been used to detach the stream from the object. Subsequent calls on a closed object, except , will fail.

Detaches the underlying stream from the Decompressor object so that the object can be closed using the Decompressor.Close method without also closing the underlying stream.

The stream of information.

Reads from the compression stream asynchronously.

The buffer that contains the information to be read from the stream. The number of bytes to read. Read options The asynchronous operation.

Provides access to the basic properties, like the size of the item or the date the item was last modified, of the item (like a file or folder).

Gets the timestamp of the last time the file was modified.

The timestamp.

Gets the most relevant date for the item.

The item's date.

Gets the size of the file in bytes.

The size of the file in bytes.

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Provides access to the document-related properties of an item (like a file or folder).

Gets the collection of the document's authors.

The name of the document author.

Gets or sets the comments associated with the document.

The comments.

Gets the collection of keywords associated with the document.

The collection of keywords.

Gets or sets the title of the document.

The document title.

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. An object for managing the asynchronous property retrieval operation.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Provides methods for setting and retrieving geographic metadata for a file.

Asynchronously retrieves a Geopoint representing the geographic metadata of a file, if present.

The file from which the geographic metadata is retrieved. An asynchronous operation that returns a Geopoint on successful completion.

Asynchronously sets the geographic metadata of a file from the provided Geopoint.

The file into which the geographic metadata is set. The Geopoint representing the geographic metadata to be set. An asynchronous action.

Asynchronously sets the geographic metadata of a file to the device's current location using the provided Geolocator object.

The file into which the geographic metadata is set. The Geolocator object that will be used to determine the device's current location. An asynchronous action.

Provides access to the image-related properties of an item (like a file or folder).

Gets or sets the manufacturer of the camera that took the photo.

The manufacturer of the camera that took the photo.

Gets or sets the model of the camera that took the photo.

The model of the camera that took the photo.

Gets or sets the date when the image was taken.

The date when the image was taken.

Gets the height of the image.

The height of the image, in pixels.

Gets the collection of keywords associated with the image.

The collection of keywords.

Gets the latitude coordinate where the photo was taken.

The latitude coordinate where the photo was taken.

Gets the longitude coordinate where the photo was taken.

The longitude coordinate where the photo was taken.

Gets the Exchangeable Image File (EXIF) orientation flag of the photo.

The photo's Exchangeable Image File (EXIF) orientation flag.

Gets the names of people who are tagged in the photo.

A list of the names of people who are tagged in the photo.

Gets or sets the rating associated with an image file.

The media file rating, as a value between 0 and 99.

Gets or sets the title of the image.

The image title.

Gets the width of the image.

The width of the image

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Saves and retrieves the properties of a storage item.

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. Pass null to retrieve all possible properties. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Saves all properties associated with the item.

An object for managing the asynchronous save operation.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Provides access to the music-related properties of an item (like a file or folder).

Gets or sets the name of the album that contains the song.

The album name.

Gets or sets the name of the album artist of the song.

The name of the song's album artist.

Gets the artists that contributed to the song.

The names of the song's artists.

Gets the bit rate of the song file.

The bit rate, in bits per second.

Gets the composers of the song.

A list of the names of the song's composers.

Gets the conductors of the song.

A list of the names of the song's conductors.

Gets the duration of the song in milliseconds.

The duration in milliseconds.

Gets the names of music genres that the song belongs to.

The collection of music genre names.

Gets the producers of the song.

A list of the names of the song's producers.

Gets or sets the publisher of the song.

The name of the song's publisher.

Gets or sets the rating associated with a music file.

The media file rating, as a value between 0 and 99.

Gets or sets the subtitle of the song.

The song's subtitle.

Gets or sets the title of the song

The song title.

Gets or sets the track number of the song on the song's album.

The track number.

Gets the songwriters.

A list of the names of the songwriters.

Gets or sets the year that the song was released.

The song's release year.

Retrieves the specified music-related Windows file properties associated with the item.

A collection that contains the names of the properties to retrieve. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Indicates the Exchangeable Image File (EXIF) orientation flag of the photo. This flag describes how to rotate the photo to display it correctly.

Flip the photo horizontally.

Flip the photo vertically.

No rotation needed. The photo can be displayed using its current orientation.

Rotate the photo 180 degrees.

Rotate the photo counter-clockwise 270 degrees.

Rotate the photo counter-clockwise 90 degrees.

Rotate the photo counter-clockwise 90 degrees and then flip it horizontally.

Rotate the photo counter-clockwise 270 degrees and then flip it horizontally.

An orientation flag is not set.

Indicates a system-defined group of file properties.

A group of basic properties that can be access through a BasicProperties object.

A group of document-related properties that can be access through a DocumentProperties object.

A group of image-related properties that can be access through a ImageProperties object.

A group of music-related properties that can be access through a MusicProperties object.

No specific, system-defined property group.

A group of video-related properties that can be access through a VideoProperties object.

Provides access to the content-related properties of an item (like a file or folder).

Retrieves the document properties of the item (like a file of folder).

When this method completes successfully, it returns a DocumentProperties object.

Retrieves the image properties of the item (like a file of folder).

When this method completes successfully, it returns an ImageProperties object.

Retrieves the music properties of the item (like a file of folder).

When this method completes successfully, it returns a MusicProperties object.

Retrieves the video properties of the item (like a file of folder).

When this method completes successfully, it returns a VideoProperties object.

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. The list of supported properties can be found on the Core properties page. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs. The return value of properties can be null.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Represents the thumbnail image associated with a system resource (like a file or folder).

Gets a value that indicates whether the thumbnail stream can be read from.

True if the thumbnail stream can be read from. Otherwise, false.

Gets a value that indicates whether the thumbnail stream can be written to.

True if the thumbnail stream can be written to. Otherwise, false.

Gets the MIME content type of the thumbnail image.

The MIME content type.

Gets the original (not scaled) height of the thumbnail image.

The original height, in pixels.

Gets the original (not scaled) width of the thumbnail image.

The original width, in pixels.

Gets the byte offset of the thumbnail stream.

The number of bytes from the start of the thumbnail stream.

Gets a value that indicates whether the thumbnail image returned was a cached version with a smaller size.

The value that indicates whether the thumbnail image returned was a cached version with a smaller size.

Gets or sets the size of the thumbnail image.

The size, in bytes, of the thumbnail image.

Gets a value that indicates if the thumbnail is an icon or an image.

The value that indicates if the thumbnail is an icon or an image.

Creates a new stream over the thumbnail that is represented by the current storageItemThumbnail object.

The new thumbnail stream. The initial, internal position of the stream is 0.

Releases system resources that are exposed by a Windows Runtime object.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Retrieves the thumbnail image data as an undecoded stream.

The position in the storage item to start reading thumbnail image data. An object for reading the thumbnail image data.

Retrieves an output stream object for writing thumbnail image data to a storage item.

The position in the storage item to start writing thumbnail image data. The output stream.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Sets the offset of the thumbnail stream to the specified value.

The number of bytes from the start of the thumbnail stream where the position of the thumbnail stream is set.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Describes the purpose of the thumbnail to determine how to adjust the thumbnail image to retrieve.

To display previews of document files.

To display previews of files (or other items) in a list.

To display previews of music files.

To display previews of picture files.

To display a preview of any single item (like a file, folder, or file group).

To display previews of video files.

Describes the behavior used to retrieve and adjust thumbnails, including the size and quality of the image and how quickly the thumbnail image is retrieved.

No options.

Scale the thumbnail to the requested size.

Retrieve a thumbnail only if it is cached or embedded in the file.

Default. Increase requested size based on the Pixels Per Inch (PPI) of the display.

Indicates whether the thumbnail is an icon or an image.

The thumbnail is an icon.

The thumbnail is an image.

Indicates how to rotate the video to display it correctly.

No rotation needed. The video can be displayed using its current orientation.

Rotate the video counter-clockwise 180 degrees.

Rotate the video counter-clockwise 270 degrees.

Rotate the video 90 degrees.

Provides access to the video-related properties of an item (like a file or folder).

Gets the sum audio and video bitrate of the video.

The video's sum audio and video bitrate.

Gets the directors of the video.

A list of the names of the video's directors.

Gets the duration of the video.

The duration.

Gets the height of the video.

The height of the video, in pixels.

Gets the collection of keywords associated with the video.

The collection of keywords.

Gets the latitude coordinate where the video was shot.

The latitude coordinate where the video was shot.

Gets the longitude coordinate where the video was shot.

The longitude coordinate where the photo was taken.

Gets a VideoOrientation value that indicates how the video should be rotated to display it correctly.

The value that indicates how the video should be rotated to display it correctly.

Gets the producers of the video.

A list of the names of the video's producers.

Gets or sets the publisher of the video.

The name of the video's publisher.

Gets or sets the rating associated with a video file.

The media file rating, as a value between 0 and 99.

Gets or sets the subtitle of the video.

The video's subtitle.

Gets or sets the title of the video.

The video's title.

Gets the width of the video.

The width of the video, in pixels.

Gets the script writers for the video.

A list of the names of the video's script writers.

Gets or sets the year that the video was shot or released.

The video's release year.

Retrieves the specified properties associated with the item.

A collection that contains the names of the properties to retrieve. When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Saves all properties associated with the item.

No object or value is returned when this method completes.

Saves the specified properties and values associated with the item.

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ). No object or value is returned when this method completes.

Represents a random-access collection of file name extensions.

Gets the number of file name extensions in the collection.

The number of file name extensions.

Appends a file name extension to the end of the collection.

The file name extension to append.

Removes all file name extensions from the collection.

Retrieves an iterator that iterates through the file name extensions in the collection.

The iterator.

Retrieves the file name extension at the specified index in the collection.

The zero-based index of the file name extension to retrieve. The file name extension at the specified index.

Retrieves the file name extensions that start at the specified index in the collection.

The zero-based index of the start of the file name extensions in the collection to retrieve. The file name extensions in the collection that start at *startIndex*. The number of items retrieved.

Retrieves an immutable view of the collection of file name extensions.

The view of the collection.

Retrieves the index of a specified file name extension in the collection.

The file name extension to find in the collection. The zero-based index of the file name extension if found. This parameter is set to zero if the file name extension is not found. True if the file name extension is found; otherwise FALSE.

Inserts a file name extension into a collection at a specified index.

Zero-based index of the location at which to insert the file name extension. The file name extension to insert.

Removes the file name extension at the specified index in the collection.

The zero-based index of the file name extension to remove.

Removes the last file name extension from the collection.

Replaces all file name extensions in the collection with the specified file name extensions.

The collection of file name extensions to put in the vector.

Sets the file name extension at the specified index of the collection.

The zero-based index of the location at which to set the file name extension. The file name extension.

Represents a UI element that lets the user choose and open files.

Creates a new instance of a FileOpenPicker.

Gets or sets the label text of the file open picker's commit button.

The label text.

Gets a set of values to be populated by the app before PickSingleFileAndContinue or PickMultipleFilesAndContinue operation that deactivates the app in order to provide context when the app is activated. (Windows Phone 8.x app)

A set of values to be populated by the app before PickSingleFileAndContinue or PickMultipleFilesAndContinue operation.

Gets the collection of file types that the file open picker displays.

A fileExtensionVector object that contains a collection of file types (file name extensions) , such as ".doc" and ".png". File name extensions are stored in this array as string objects.

Gets or sets the settings identifier associated with the state of the file open picker.

The settings identifier.

Gets or sets the initial location where the file open picker looks for files to present to the user.

The identifier of the starting location.

Gets info about the user for which the FileOpenPicker was created. Use this property for multi-user applications.

The user for which the FileOpenPicker was created.

Gets or sets the view mode that the file open picker uses to display items.

The view mode.

Creates a FileOpenPicker that is scoped to the personal directory of the specified user. Use this method for multi-user applications.

The user for which to create the FileOpenPicker. The new FileOpenPicker that was created.

**Obsolete as of Windows 10; use PickSingleFolderAsync instead.** Shows the file picker so that the user can pick multiple files, deactivating and the app and reactivating it when the operation is complete. (Windows Phone 8.x app)

Instead, use PickMultipleFilesAsync

Shows the file picker so that the user can pick multiple files. (UWP app)

When the call to this method completes successfully, it returns a filePickerSelectedFilesArray object that contains all the files that were picked by the user. Picked files in this array are represented by storageFile objects.

Shows the file picker so that the user can pick one file, potentially deactivating the app and reactivating it when the operation is complete. (Windows Phone 8.x app)

Instead, use PickSingleFileAsync

Shows the file picker so that the user can pick one file.

When the call to this method completes successfully, it returns a StorageFile object that represents the file that the user picked.

Shows the file picker so that the user can pick one file.

This argument is ignored and has no effect. When the call to this method completes successfully, it returns a StorageFile object that represents the file that the user picked.

Resumes the picking operation to retrieve the user-selected file if the user navigates away from the app after the picker operation has completed and the app is suspended.

Instead, use PickSingleFileAsync When the call to this method completes successfully, it returns a StorageFile object that represents the file that the user picked.

Represents a collection of display names mapped to the associated file types (extensions). Each element in this collection maps a display name to a corresponding collection of file name extensions. The key is a single string, the value is a list/vector of strings representing one or more extension choices.

Gets the number of items in the mapped collection of display names and associated file types.

The number of items in the mapped collection.

Removes all display names and associated file name extensions from the collection.

Retrieves an iterator that iterates through the display names and associated file types in the collection.

The iterator.

Returns an immutable view of the collection of display names and associated file types.

The view of the collection.

Determines whether the mapped collection of display names and associated file types contains the specified key.

The key. True if the key is found; otherwise, false.

Inserts or replaces an item in the mapped collection of display names and associated file types.

The key associated with the item to insert. The item to insert. **true** if an item with the specified key is an existing item and was replaced; otherwise **false**.

Returns the item at the specified key in the mapped collection of display names and associated file types.

The key to use to locate the item. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item from the mapped collection of display names and associated file types.

The key associated with the item to remove.

Represents a collection of storage files that the user has selected by using a file picker.

Gets the number of StorageFile objects in the collection.

The number of StorageFile objects in the collection.

Retrieves an iterator that iterates through the collection of StorageFile objects that represent selected files.

The iterator.

Returns the StorageFile object at the specified index in the collection.

The zero-based index of the object to retrieve. The object at the specified index.

Retrieves the StorageFile objects that start at the specified index in the collection.

The zero-based index of the start of the objects in the collection to return. The items in the collection that start at *startIndex*. The number of items returned.

Retrieves the index of a specified StorageFile object in the collection.

The object to find in the collection. The zero-based index of the object if found. Zero is returned if the object is not found. True if the object is found; otherwise false.

Represents a file picker that lets the user choose the file name, extension, and storage location for a file.

Creates a new instance of a FileSavePicker.

Gets or sets the label text of the commit button in the file picker UI.

The label text.

Gets a set of values to be populated by the app before a PickSaveFileAndContinue operation that deactivates the app in order to provide context when the app is activated. (Windows Phone 8.x app)

A set of values to be populated by the app before a PickSaveFileAndContinue operation

**Do not use this property. Use the FileTypeChoices property instead.** Gets or sets the default file name extension that the fileSavePicker gives to files to be saved.

The default file name extension.

Gets or sets an ID that specifies the enterprise that owns the file.

An ID that specifies the enterprise that owns the file.

Gets the collection of valid file types that the user can choose to assign to a file.

A FilePickerFileTypesOrderedMap object that contains a collection of valid file types (extensions) that the user can use to save a file. Each element in this collection maps a display name to a corresponding collection of file name extensions. The key is a single string, the value is a list/vector of strings representing one or more extension choices.

Gets or sets the settings identifier associated with the current FileSavePicker instance.

The settings identifier.

Gets or sets the file name that the file save picker suggests to the user.

The initial suggested file name.

Gets or sets the storageFile that the file picker suggests to the user for saving a file.

The suggested storage file object to save.

Gets or sets the location that the file save picker suggests to the user as the location to save a file.

The initial suggested location for saving a file.

Gets info about the user for which the FileSavePicker was created. Use this property for multi-user applications.

The user for which the FileSavePicker was created.

Creates a FileSavePicker that is scoped to the personal directory of the specified user. Use this method for multi-user applications.

The user for which to create the FileSavePicker. The new FileSavePicker that was created.

**Obsolete as of Windows 10; use PickSaveFileAsync instead.** Shows the file picker so that the user can save a file, deactivating and the app and reactivating it when the operation is complete. (Windows Phone 8.x app)

Instead, use PickSaveFileAsync

Shows the file picker so that the user can save a file and set the file name, extension, and location of the file to be saved. (UWP app)

When the call to this method completes successfully, it returns a storageFile object that was created to represent the saved file. The file name, extension, and location of this storageFile match those specified by the user, but the file has no content.

Represents a UI element that lets the user choose folders.

Creates a new instance of a FolderPicker.

Gets or sets the label text of the folder picker's commit button.

The label text.

Gets a set of values to be populated by the app before a PickFolderAndContinue operation that deactivates the app in order to provide context when the app is activated. (Windows Phone 8.x app)

A set of values to be populated by the app before a PickFolderAndContinue operation that deactivates the app in order to provide context when the app is activated.

Gets the collection of file types that the folder picker displays.

A FileExtensionVector object that contains a collection of file types (file name extensions) , such as ".doc" and ".png". File name extensions are stored in this array as string objects.

Gets or sets the settings identifier associated with the with the current FolderPicker instance.

The settings identifier.

Gets or sets the initial location where the folder picker looks for folders to present to the user.

The identifier of the starting location.

Gets info about the user for which the FolderPicker was created. Use this property for multi-user applications.

The user for which the FolderPicker was created.

Gets or sets the view mode that the folder picker uses to display items.

The view mode.

Creates a FolderPicker that is scoped to the personal directory of the specified user. Use this method for multi-user applications.

The user for which to create the FolderPicker. The new FolderPicker that was created.

**Obsolete as of Windows 10; use PickSingleFolderAsync instead.** Shows the file picker so that the user can pick a folder, deactivating and the app and reactivating it when the operation is complete. (Windows Phone 8.x app)

Instead, use PickSingleFolderAsync

Shows the folderPicker object so that the user can pick a folder. (UWP app)

When the call to this method completes successfully, it returns a storageFolder object that represents the folder that the user picked.

Identifies the storage location that the file picker presents to the user.

The **Computer** folder.

The Windows desktop.

The **Documents** library.

The **Downloads** folder.

The HomeGroup.

The **Music** library.

The **Objects** library.

The **Pictures** library.

An unspecified location.

The **Videos** library.

Indicates the view mode that the file picker is using to present items.

A list of items.

A set of thumbnail images.

Indicates the result of a call to the fileOpenPickerUI.addFile method.

The file was successfully added to the file picker UI.

The file was already in the file picker UI.

The file wasn't added because it is not one of the allowed file types.

The file wasn't added because the file picker UI is unavailable.  The file picker UI is only available while the user is interacting with your app.

Used to interact with the file picker if your app provides files with the File Open Picker contract.

Gets a list of file types (extensions) that the user can choose.

The list of allowed file types.

Gets an enumeration value that indicates whether the file picker currently limits selection to single files, or if multiple files can be selected.

The enumeration value that indicates the current selection mode.

Gets an identifier for the current context of the file picker.

The identifier for the current context of the file picker.

Gets or sets a title to display in the file picker UI that identifies the location that the file picker is displaying to the user.

The title to display in the file picker UI. This title should identify the location and type of files that the user can see on the app page (which is hosted by the file picker) of the app that is providing files.

Fires when the user closes the file picker.

Fires when the user removes a file from the list of files that the user has chosen if that file was added by the app that is providing files.

Adds the specified file to the list of files that the user has chosen.

A unique identifier of the file to add. The file to add to the list of files that the user has chosen. The enumeration value that indicates the result of this addFile method.

Indicates whether the specified file can be added to the list of files the user has chosen.

The file to test. True if the file can be added to the file picker UI; otherwise false.

Determines whether the specified file is in the list of files that the user has chosen.

The identifier of the file. True if the file is in the basket; otherwise false.

Removes the specified file from the list of files the user has chosen.

The identifier of the file to remove.

Provides information about a fileremoved event.

Since Windows 10, only apps can remove files, not end users so the FileRemoved event will not be raised.

Gets the identifier of the file that the user removed from the list of chosen files in the file picker. This identifier was set by the providing app when it added the files to the list of chosen files.

The identifier of the file.

Used to interact with the file picker when your app provides a save location with the File Save Picker contract.

Gets a list of file types (extensions) that can be saved to the app that is providing the save location.

The list of file types that can be saved.

Gets the full file name of the file to save, including the file type extension. The file name and extension are specified by the user.

The full file name, including the file type extension.

Gets an identifier for the current context of the file picker.

The identifier for the current context of the file picker.

Gets or sets a title to display in the file picker UI that identifies the location that the file picker is displaying to the user.

The title to display in the file picker UI. This title should identify the location and type of files that the user can see on the app page (which is hosted by the file picker) of the app that is providing files.

Fired when the user changes the file name in the file name text box or changes the extension in the file type drop-down menu.

Fires when the user commits a file to be saved in the file picker.

Tries to set the file name and extension in the file picker UI.

The file name and extension that are used to update the file name text box and file type drop-down menu in the file picker UI. The enumeration value that indicates whether the file name and extension were updated in the file picker UI.

Indicates whether the file picker currently limits selection to single files, or if multiple files can be selected.

Multiple files can be selected.

Only a single file can be selected.

Use by an app that provides files to indicate asynchronously that the app is finished responding to a closing event.

Signals that the app providing files has finished responding to a closing event.

Provides information about a closing event.

Gets a pickerClosingOperation object that is used to respond to a closing event.

The pickerClosingOperation object that is used to respond to a closing event.

Gets a value that indicates whether the file picker is closing because the user cancelled it.

True if the file picker was cancelled by the user. Otherwise, false.

Lets an app that provides files get the deadline for responding to a closing event and get a deferral so the app can respond to the event asynchronously.

Gets a dateTime object that indicates when the system will shut down the app that is providing files through the file picker without further notice.

The dateTime object that indicates when the system will shut down the app.

Gets a pickerClosingDeferral that the app providing files through the file picker can use to respond asynchronously to a closing event.

The pickerClosingDeferral that the app providing files through the file picker can use to respond asynchronously to a closing event.

Indicates the result of a call to the fileSavePickerUI.trySetFileName method.

The file name and extension were not updated because the extension wasn't one of the allowedFileTypes.

The file name and extension were updated successfully.

The file name and extension were not updated because the file picker UI wasn't available. The file picker UI is only available while the user is interacting with your app.

Lets an app that provides a save location specify the storageFile that represents the file to save and get a deferral so the app can respond asynchronously to a targetFileRequested event.

Gets or sets the IStorageFile object that is provided to represent the file to save by the app that is providing the save location.

The object that represents the file to save. The app that called the file picker in order to save will write content to this file.

Gets a targetFileRequestDeferral that the app providing the save location can use to respond asynchronously to a targetfilerequested event.

The targetFileRequestDeferral that the providing app can use asynchronously to indicate that it is finished responding to a targetfilerequested event.

Used by an app that provides a save location to indicate asynchronously that the app is finished responding to a targetfilerequested event.

Signals that the app providing the save location finished responding to a targetfilerequested event.

Provides information about a targetfilerequested event.

Gets a targetFileRequest object that is used to respond to a targetfilerequested event.

The targetFileRequest object that is used to respond to a targetfilerequested event.

Describes when Windows will request an update to a file.

An update triggers when another app accesses the locally cached copy of the file if a network connection is available.  Otherwise, other apps are denied access to the local file.

Another app may be able to access the locally cached copy of the file without triggering an update.

An update always triggers when another app accesses the locally cached copy of the file.

An update triggers when another app accesses the locally cached copy of the file if a network connection is available.  Otherwise, other apps can access the local file without triggering an update.

Indicates whether updates should be applied to the locally cached copy or the remote version of the file.

Update the locally cached copy of the file.

Update the remote version of the file.

Manages files so that they can be updated in real-time by an app that participates in the Cached File Updater contract.

Configures update policies for a local file.

The local file. A unique identifier for the local file. A value that specifies whether Windows will request updates before the local file is retrieved from an app's MostRecentlyUsedList or FutureAccessList. A value that specifies whether other apps can write to the local file and, if so, whether Windows will request updates after the local file is written. A value that specifies additional circumstances and behaviors for when Windows requests updates.

Used to interact with the file picker if your app provides file updates through the Cached File Updater contract.

Gets or sets the title to display in the top-left the file picker UI. The title identifies the location or context of the app's page (which is hosted in the file picker UI) for the user.

The title to display in the top-left of the file picker UI.

Gets an enum value that indicates the status of the file picker UI.

The UIStatus value that indicates the status of the file picker UI.

Gets the file update request currently being processed by the cached file updater.

The file update request currently being processed by the cached file updater.

Gets a value that indicates which version of the file needs to be updated: the local version or the version in the app's repository.

An enum value that indicates which version of the file needs to be updated: the local version or the version in the app's repository.

Fires when the Windows requests a file update. This event fires once for each requested update.

Fires when the calling app needs to display the file picker letterbox UI that is represented by the CachedFileUpdaterUI object.

Gets an object used to complete a file update request asynchronously.

The object that the app uses to indicate, asynchronously, that it has finished responding to a FileUpdateRequested event and that the Request is complete.

Provides information about a requested file update so that the app can complete the request.

Gets the unique identifier used to associate the local version of a file with the corresponding remote version.

The identifier that was specified by the app and is associated with the local file.

Gets a StorageFile object that represents the locally cached copy of the file to update.

The StorageFile object that represents the locally cached copy of the file to update.

Gets or sets the status of the update. This property is set in response to a FileUpdateRequested event.

An enum value that indicates the status of the update.

Gets or sets a message to the user indicating that user input is needed to complete the FileUpdateRequest.

A message to the user indicating that user input is needed to complete the FileUpdateRequest.

Gets an object used to complete an update asynchronously.

The object that the app uses to indicate, asynchronously, that it has finished responding to a FileUpdateRequested event and that the Request is complete.

Provide a new version of the local file to represent the remote file.

The new version of the local file that will represent remote file.

Use to complete an update asynchronously.

Signals that the response to a FileUpdateRequested event is finished.

Provides information about a FileUpdateRequested event.

Gets the details of the requested file update.

The details of the requested file update.

Describes the status of a file update request.

The file update was completed successfully.

The file update was completed successfully and the file has been renamed. For example, this could occur if the user chose to save their changes under a different file name because of conflicting changes made to the remote version of the file.

The remote version of the file was not updated because the storage location wasn't available. The file remains valid and subsequent updates to the file may succeed.

The file is now invalid and can't be updated now or in the future. For example, this could occur if the remote version of the file was deleted.

The file update was not fully completed and should be retried.

User input (like credentials) is needed to update the file.

Indicates when Windows will request a file update if another app retrieves the file from its MostRecentlyUsedList or FutureAccessList.

Windows will trigger a file update request just before it has been retrieved from the app's MostRecentlyUsedList or FutureAccessList.

Windows will not trigger a file update request when another app retrieves the local file.

Indicates the status of the file picker UI.

The file picker is currently showing UI and all

The file picker is not showing UI, but UI can be requested.

The file picker is not showing UI and UI can't be requested.

The file picker is currently showing UI because UI was requested by the app.

Indicates whether other apps can write to the locally cached version of the file and when Windows will request an update if another app writes to that local file.

Windows will trigger a file update request after another app writes to the local file.

Windows will trigger a file update request when another app writes to the local file.

Other apps can't write to the local file.

Specifies how to sort the files in the query results and determines whether the query is shallow or deep. Query results for deep queries include all files in all of the subfolders of the current folder, sorted according to the specified option.

A shallow list of files in the current folder, similar to the list that File Explorer provides.

A deep, flat list of files in a folder and its subfolders, sorted by System.ItemDate.

A deep, flat list of files in a folder and its subfolders, sorted by music properties.

A deep, flat list of files in a folder and its subfolders, sorted by System.ItemNameDisplay.

A deep, flat list of files in a folder and its subfolders, sorted by System.Search.Rank followed by System.DateModified.

A deep, flat list of files in a folder and its subfolders, sorted by System.Title.

Specifies how to group files into folders in the query results and determines whether the query is shallow or deep. Query results for deep queries include all files in all of the subfolders of the current folder, grouped into folders according to the specified option.

A shallow list of the folders in the current folder, similar to the view that File Explorer provides.

Group files into virtual folders by year based on the System.Music.AlbumTitle property of each file. Each folder will contain all (and only) files with identical values for System.Music.AlbumTitle.

Group files into virtual folders based on the System.Music.AlbumArtist property of each file. Each folder will contain all (and only) files with identical values for System.Music.AlbumArtist.

Group files into virtual folders based on the System.Music.Artist property of each file. Each folder will contain all (and only) files with identical values for System.Music.Artist.

Group files into virtual folders based on the System.Author property of each file. Each folder will represent one author, and contain all files whose System.Author vector contains that author. If a file lists multiple authors, it may appear in more than one of the resulting folders.

Group files into virtual folders based on the System.Music.Composer property of each file. Each folder will represent one composer, and contain all files whose System.Music.Composer vector contains that composer. If a file lists multiple composers, it may appear in more than one of the resulting folders.

Group files into virtual folders based on the System.Music.Genre property of each file. Each folder will contain all (and only) files with identical values for System.Music.Genre.

Group files into virtual folders by month based on the System.ItemDate property of each file. Each folder will contain all (and only) files that have values for System.ItemDate within the same month.

Group files into virtual folders by year based on the System.Media.Year property of each file. Each folder will contain all (and only) files that have values for System.Media.Year within the same year.

Group files into virtual folders by rating (1 star, 2 stars, and so on) based on the System.Rating property of each file. Each folder will contain all (and only) files with identical values for System.Rating.

Group files into virtual folders based on the System.Keywords property of each file. Each folder will represent one tag, and contain all files whose System.Keywords vector contains that tag. If a file lists multiple tags in its System.Keywords vector, it may appear in more than one of the resulting folders.

Group files into virtual folders by type (for example, Microsoft Word documents, text files, and so forth) based on the System.ItemTypeText property of each file.

Group files into virtual folders by year based on the System.ItemDate property of each file. Each folder will contain all (and only) files that have values for System.ItemDate within the same year.

Enables UWP apps to make private content searchable by using the system index.

Gets the version of the ContentIndexer.

The revision number.

Adds app-defined items with properties and content to the system index.

The content properties to index.

Builds a query with the specified search filter and identifies which properties to retrieve.

The Advanced Query Syntax (AQS) filter to apply. The properties to retrieve, specified by their Windows canonical property names. The query.

Builds a query with the specified search filter, sort order, and identifies which properties to retrieve.

The Advanced Query Syntax (AQS) filter. The properties to retrieve, specified by their Windows canonical property names. The sort order for the filtered results. The query.

Builds a query with the specified search filter, sort order, filter language, and identifies which properties to retrieve.

The Advanced Query Syntax (AQS) filter to apply. The properties to retrieve, specified by their Windows canonical property names. The sort order for the filtered results. The language that's used to parse Advanced Query Syntax (AQS), specified as a BCP-47 language tag. The query.

Removes all app-defined items from the ContentIndexer.

Removes the specified app-defined item from the ContentIndexer.

The identifier of the item to remove.

Removes the specified app-defined items from the ContentIndexer.

The identifier of the item to remove.

Gets an existing per-app index or creates a new one, if necessary.

The index.

Gets the per-app index with the specified name or creates a new one, if necessary.

The index name. The index.

Gets content properties based on the given content identifier.

The identifier for the content properties. The retrieved properties, based on *contentId*. When this method completes, it returns the retrieved properties as a map of key-value pairs.

Updates app content and properties in the ContentIndexer.

The content properties to update.

Represents a query for content properties in the ContentIndexer.

Gets the StorageFolder representation of the app-provided items in the ContentIndexer query.

The folder that contains app-provided content.

Runs the query on the app's indexed content properties.

When this method completes, it returns the query results, represented as a collection of IIndexableContent instances.

Runs the query on the app's indexed content properties and returns the specified number of items from the specified start index in the results collection.

The index of the first item to get from the results collection. The maximum number of items to get. When this method completes, it returns the query results, represented as a collection of IndexableContent instances.

Gets the number of items in the search results.

When this method completes, it returns the number of items in the search results.

Retrieves a collection of property sets for an app, where the property sets are key-value pairs.

When this method completes, it returns the query results as a collection of PropertyValue instances.

Runs the query on the app's indexed content properties and returns the specified number of properties from the specified start index in the results collection.

The index of the first item to get from the results collection. The maximum number of items to get. When this method completes, it returns the query results as a collection of PropertyValue instances.

Indicates the unit of time used to group files into folders if a CommonFolderQuery based on date is used to create a QueryOptions object.

The content is grouped by month.

The query options are not based on the date.

The content is grouped by year.

Indicates whether all files and subfolders of the folder being queried will be enumerated or if only the top-level files and subfolders will be enumerated.

Perform a deep enumeration of the folder contents. Windows traverses through subfolders to discover content and presents the results in a single list that combines all discovered content.

Perform a shallow enumeration of the folder being queried. Only the top-level, child files and folders of the folder being queried will be returned. This is similar to the view that Windows Explorer would provide for the folder being queried.

Represents app content and properties that can be added to the ContentIndexer.

Gets or sets the identifier for the content properties in the IIndexableContent object. Changes to the actual representation of the item in the index can be made using the ContentIndexer class.

The identifier of the content item.

Gets the content properties.

The collection of properties, represented as a Map of key-value pairs.

Gets or sets a stream that provides full-text content. Changes to the actual representation of the item in the index can be made using the ContentIndexer class.

The stream used to provide the full-text content for the item.

Specifies the type of content in the Stream.

The content type, like StorageFile.ContentType.

Represents app content and properties that can be added to the ContentIndexer.

Initializes a new instance of the IndexableContent class.

Gets or sets the identifier for the content properties in the IndexableContent object. Changes to the actual representation of the item in the index can be made using the ContentIndexer class.

The identifier of the content item.

Gets the content properties.

The collection of properties, represented as a Map of key-value pairs.

Gets or sets a Stream that provides full-text content. Changes to the actual representation of the item in the index can be made using the ContentIndexer class.

The stream used to provide the full-text content for the item.

Specifies the type of content in the Stream.

The content type, like StorageFile.ContentType.

Indicates whether a StorageFolder is included in the system index.

The folder contains indexed content.

The folder is not indexed.

Some folders in the library are indexed, but not all of them. This value is relevant only for libraries.

The indexed state is not known.

Specifies whether the query should use the system index of the file system when enumerating content in the folder being queried. The indexer can retrieve results faster but is not available in all file locations.

Access the file system directly; don't use the system index.

Use only indexed content and ignore content that has not been indexed.

Only returns the properties specified in QueryOptions.SetPropertyPrefetch for faster results.

Use the system index for content that has been indexed and use the file system directly for content that has not been indexed.

Provides methods to create search queries and retrieve files from a folder. This interface is implemented by StorageFolder objects, which can represent file system folders, libraries, or virtual folders that are automatically generated when queries are created using group-based CommonFolderQuery values like GroupByAlbum.

Verifies whether the folder supports the specified search query options (returns true or false).

The search query options to test. True if the folder supports the specified search query options; otherwise false.

Retrieves an object for enumerating the files in a storage location and subscribing to events that fire when the contents of the storage location change.

An object for enumerating files and subscribing to events.

Retrieves an object with the specified options for enumerating the storage location in a folder and subscribing to events that fire when the contents of the storage location change.

The type of folder query to perform. This parameter defaults to CommonFileQuery.DefaultQuery. An object for enumerating files and subscribing to events.

Retrieves an object with the specified options for enumerating the files in a storage location and subscribing to events that fire when the contents of the storage location change.

The options for filtering the query results. An object for enumerating files and subscribing to events.

Retrieves an object for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

An object for enumerating folders and subscribing to events.

Retrieves an object with the specified options for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

The type of folder query to perform. This parameter defaults to CommonFolderQuery.DefaultQuery. An object for enumerating folders and subscribing to events.

Retrieves an object with the specified options for enumerating folders in a storage location and subscribing to events that fire when the contents of the storage location change.

The options for filtering the query results. An object for enumerating folders and subscribing to events.

Retrieves an object for performing shallow enumerations of the files and folders in a storage location. An app can use the object to enumerate the items in a storage location and subscribe to events that fire when the contents of the storage location change.

An object for enumerating storage items and subscribing to events.

Retrieves an object with the specified options for enumerating the files and folders in a storage location and subscribing to events that fire when the contents of the storage location change.

The options for filtering the query results. An object for enumerating storage items and subscribing to events.

Retrieves a list of files based on the specified query (shallow enumeration). This returns a snapshot of the files at a point in time and does not allow you to keep track of changes through events.

The type of file query to perform. When this method completes successfully, it returns a list (type IVectorView ) of files that are represented by StorageFile objects.

Retrieves a list of files in a specified range that are based on the specified file query. This returns a snapshot of the files at a point in time and does not allow you to keep track of changes through events.

The type of file query to perform. The zero-based index of the first file in the range. This parameter defaults to 0. The maximum number of files to retrieve. Use -1 to retrieve all files. When this method completes successfully, it returns a list (type IVectorView ) of files that are represented by StorageFile objects.

Retrieves a list of folders and file groups based on a specified folder query. This returns a snapshot of the folders or file groups at a point in time and does not allow you to keep track of changes through events.

The type of folder query to perform. When this method completes successfully, it returns a list (type IVectorView ) of folders of file groups that are represented by StorageFolder objects.

Asynchronously retrieves a range of folders in this folder based on a folder query. This returns a snapshot of the folders or file groups at a point in time and does not allow you to keep track of changes through events.

The type of folder query to perform. The zero-based index of the first folder or file group in the range. This parameter defaults to 0. The maximum number of folders or file groups to retrieve. Use -1 to retrieve all folders or file groups. When this method completes successfully, it returns a list (type IVectorView ) of folders of file groups that are represented by StorageFolder objects.

Retrieves a value that indicates the indexed state of the StorageFolder location associated with the query.

When this method completes successfully, it returns a value of the IndexedState enumeration.

Retrieves a list items like files, folders, or file groups, in a specified range (shallow enumeration).

The zero-based index of the first item in the range. This parameter defaults to 0. The maximum number of items to retrieve. Use -1 to retrieve all items. When this method completes successfully, it returns a list (type IVectorView ) of items. Each item is the IStorageItem type and represents a file, folder, or file group.

Verifies whether this folder supports the specified file query (returns true or false).

The file query to test. True if the folder supports the specified file query; otherwise false.

Verifies whether this folder supports the specified folder query (returns true or false).

The folder query to test. True if the folder supports the specified folder query; otherwise false.

Provides methods to access to and manage query results.

Gets the folder originally used to create a StorageFileQueryResult, StorageFolderQueryResult, or StorageItemQueryResult object. This folder represents the scope of the query.

The original folder.

Fires when an item is added, deleted or modified in the folder being queried.

Fires when the query options are changed for a StorageFileQueryResult, StorageFolderQueryResult, or StorageItemQueryResult object.

Applies new query options to the results retrieved by the StorageFileQueryResult, StorageFolderQueryResult, or StorageItemQueryResult object.

The new query options.

Retrieves the index of the file from the query results that most closely matches the specified property value. The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.

The property value to match when searching the query results. When this method completes successfully it returns the index of the matched item in the query results.

Retrieves the query options used to create a StorageFileQueryResult, StorageFolderQueryResult, or StorageItemQueryResult object.

The query options.

Retrieves the number of items that match the query that created a StorageFileQueryResult, StorageFolderQueryResult, or StorageItemQueryResult object.

When this method completes successfully, it returns the number of items that match the query.

Specifies the parameters of a search query for enumerating the contents of storage folders.

Creates an instance of the QueryOptions class for enumerating storage items, and initializes it with the following default settings: QueryOptions.FolderDepth gets FolderDepth.Shallow and QueryOptions.IndexerOption gets IndexerOption.DoNotUseIndexer.

Creates an instance of the QueryOptions class for enumerating files and initializes it with values provided by the specified CommonFileQuery and an optional file type filter that determines which files to include in query results.

An enumeration value that specifies the search parameters to use to query files. An array of file types to be included in the query results. To include all file types, supply null, an empty array, or an array containing a single entry of "*".

Creates an instance of the QueryOptions class for enumerating subfolders and initializes it with values based on the specified CommonFolderQuery.

An enumeration value that specifies how to group the contents of the folder where the query is created into subfolders to enumerate. The subfolders that are retrieved using a CommonFolderQuery can be actual file system folders or virtual folders that represent groups of files (which are determined by the CommonFolderQuery value).

Gets or sets an application-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the UserSearchFilter to create the query's search filter.

A simple keyword, or a string that conforms to Advanced Query Syntax (AQS). For more information, see Using Advanced Query Syntax Programmatically.

Gets the unit of time used to group files into folders if the QueryOptions object was created with a CommonFolderQuery based on date. For example, if CommonFolderQuery.GroupByYear is used to create a QueryOptions object, the value of this property is DateStackOption.Year.

The unit of time user to group folder content by date.

Gets a list of file name extensions used to filter the search results. If the list is empty, the results include all file types.

The list of file types of files include in query results. The default value is an empty list (which is equivalent to a list containing only "*") that includes all file types.

Indicates whether the search query should produce a shallow view of the folder contents or a deep recursive view of all files and subfolder.

A value that indicates how deeply to query the folder. The default value is FolderDepth.Shallow. Predefined queries typically override this property and change it to FolderDepth.Deep.

Gets the name of the property used to group query results if the QueryOptions object was created using a CommonFolderQuery. For example, if CommonFolderQuery.GroupByYear is used to create a QueryOptions object, the value of this property is System.ItemDate.

The property that is being used to group files and that is specified by the CommonFolderQuery enumeration.

Gets or sets a value that specifies whether the system index or the file system is used to retrieve query results. The indexer can retrieve results faster but is not available in all file locations.

The indexer option.

Gets or sets the Internet Engineering Task Force (IETF) language tag (BCP47 standard) that identifies the language associated with the query. This determines the language-specific algorithm used by the system to break the query into individual search tokens.

The Internet Engineering Task Force (IETF) BCP47-standard language tag.

Gets the list of SortEntry structures that specify how to sort content (like files and subfolders) in query results. Use this list to customize how query results are sorted.

A SortEntryVector that contains SortEntry structures. These structures specify how to sort query results.

Gets the filter for storage provider identifiers.

The filter string.

Gets or sets a user-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the ApplicationSearchFilter to create the query's search filter.

A simple keyword or a string that conforms to Advanced Query Syntax (AQS). For more information, see Using Advanced Query Syntax Programmatically.

Initializes the current instance of the QueryOptions class with search parameters specified by a string that was created by the SaveToString method.

A string retrieved by a previous call to SaveToString.

Converts the values of a QueryOptions object to a string that can be used to initialize the values of a QueryOptions object by calling LoadFromString.

A string representing the serialized settings of a QueryOptions instance.

Specifies properties that the system should load in advance for all items in the query result set while the query is being executed (instead of retrieving them on a case-by-case basis). If many properties are specified, the query might take longer to execute, but subsequent property retrieval on query results will be faster.

A value that specifies the set of properties to retrieve in advance. A custom list of properties to retrieve in advance as an array of property names. Use the system property names to specify properties, for example System.Copyright and System.Image.ColorSpace.

Specifies the type and size of thumbnails that the system should start loading immediately when items are accessed (instead of retrieving them on a case-by-case basis). This uses more resources but makes thumbnail retrieval on query results faster.

The enumeration value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted. The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the *requestedSize* as a guide and tries to return a thumbnail image that can be scaled to the requested size without reducing the quality of the image. The enum value that describes the desired behavior to use to retrieve the thumbnail image. The specified behavior might affect the size and/or quality of the image and how quickly the thumbnail image is retrieved.

An entry in the SortOrder list the specifies a property and ordering that is used to sort query results.

True to sort content in the query results in ascending order based on the property name, or false to sort content in descending order.

The name of the property to use for sorting, like System.Author. The property must be registered on the system.

Provides access to the sorting criteria of the query results as a collection of SortEntry objects.

Gets the number of sort entries in the collection.

The number of sort entries.

Appends a sort entry to the end of the collection.

The sort entry to append to the collection.

Removes all sort entries from the collection.

Retrieves an iterator that iterates through the sort entries in the collection.

The iterator.

Retrieves the sort entry at the specified index in the collection.

The zero-based index of the sort entry to retrieve. The sort entry at the specified index.

Retrieves the sort entries that start at the specified index in the collection.

The zero-based index of the start of the sort entries in the collection to retrieve. The sort entries in the collection that start at *startIndex*. The number of items retrieved.

Retrieves an immutable view of the collection of sort entries.

The view of the collection.

Retrieves the index of a specified sort entry in the collection.

The sort entry to find in the collection. The zero-based index of the sort entry, if found. This parameter is set to zero if the sort entry is not found. True if the sort entry is found; otherwise false.

Inserts a sort entry into the collection at a specified index.

The zero-based index of the location to insert the sort entry. The sort entry to insert.

Removes the sort entry at the specified index in the collection.

The zero-based index of the sort entry to remove.

Removes the last sort entry from the collection.

Replaces all sort entries in the collection with the specified sort entries.

The collection of sort entries to put in the vector.

Sets the sort entry at the specified index of the collection.

The zero-based index of the location at which to set the sort entry. The sort entry.

Provides access to the results of a query of the files in the location that is represented by a storageFolder object. You can use storageFileQueryResult to enumerate the files in that storageFolder location.

Gets the folder that was queried to create the StorageFileQueryResult object. This folder represents the scope of the query.

The original folder.

Fires when a file is added to, deleted from, or modified in the folder being queried. This event only fires after GetFilesAsync has been called at least once.

Fires when the query options change.

Modifies query results based on new QueryOptions.

The new query options.

Retrieves the index of the file from the query results that most closely matches the specified property value (or file, if used with FileActivatedEventArgs.NeighboringFilesQuery ). The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.

The property value to match when searching the query results. The property to that is used to match this value is the property in the first SortEntry of the QueryOptions.SortOrder list. When this method completes successfully, it returns the index of the matched file in the query results or the index of the file in the FileActivatedEventArgs.NeighboringFilesQuery. In the latter case, the file is expected to be sourced from FileActivatedEventArgs.Files. If this function fails, it returns **uint.MaxValue**.

Retrieves the query options used to determine query results.

The query options.

Retrieves a list of all the files in the query result set.

When this method completes successfully, it returns a list (type IVectorView ) of files that are represented by storageFile objects.

Retrieves a list of files in a specified range.

The zero-based index of the first file to retrieve. This parameter is 0 by default. The maximum number of files to retrieve. Use -1 to retrieve all files. If the range contains fewer files than the max number, all files in the range are returned. When this method completes successfully, it returns a list (type IVectorView ) of files that are represented by storageFile objects.

Retrieves the number of files in the set of query results.

When this method completes successfully, it returns the number of files in the location that match the query.

Gets matching file properties with corresponding text ranges.

The file to query for properties. The matched properties and corresponding text ranges.

Provides access to the results of a query that lists the folder (or file groups) in the folder being queried (which is represented by a storageFolder ). You can use a storageFolderQueryResult to enumerate folders or file groups in that folder.

Gets the folder originally used to create the StorageFolderQueryResult object. This folder represents the scope of the query.

The original folder.

Fires when a file is added to, deleted from, or modified in the folder being queried. This event only fires after GetFilesAsync has been called at least once.

Fires when the query options change.

Modifies query results based on new QueryOptions.

The new query options.

Retrieves the index of the folder from the query results that most closely matches the specified property value. The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.

The property value to match when searching the query results. The property to that is used to match this value is the property in the first SortEntry of the QueryOptions.SortOrder list. When this method completes successfully it returns the index of the matched folder in the query results; otherwise it returns **uint.MaxValue**.

Retrieves the query options used to determine query results.

The query options.

Retrieves a list of all the folders (or file groups) in the result set.

When this method completes successfully, it returns a list (type IVectorView ) of folders or file groups that are represented by storageFolder objects. Each of these folder or file group can also be enumerated to retrieve its contents.

Retrieves folders (or file groups) in a specified range.

The zero-based index of the first folder to retrieve. This parameter defaults to 0. The maximum number of folders or file groups to retrieve. Use -1 to retrieve all folders. If the range contains fewer folders than the max number, all folders in the range are returned. When this method completes successfully, it returns a list (type IVectorView ) of folders or file groups that are represented by storageFolder objects.

Retrieves the number of folders (or file groups) in the set of query results.

When this method completes successfully, it returns the number of folders or file groups in the location that match the query.

Provides access to the results of a query that lists all items including files and folders (or file groups) in the folder being queried (which is represented by a storageFolder ). You can use storageItemQueryResult to enumerate the files and folders in that storageFolder.

Gets the folder originally used to create the StorageItemQueryResult object. This folder represents the scope of the query.

The original folder.

Fires when an item is added to, deleted from, or modified in the folder being queried. This event only fires after GetItemsAsync has been called at least once.

Fires when the query options change.

Modifies query results based on new QueryOptions.

The new query options.

Retrieves the index of the item from the query results that most closely matches the specified property value. The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.

The property value to match when searching the query results. The property to that is used to match this value is the property in the first SortEntry of the QueryOptions.SortOrder list. When this method completes successfully it returns the index of the matched item in the query results.

Retrieves the query options used to determine query results.

The query options.

Retrieves the number of items in the set of query results.

When this method completes successfully, it returns the number of items in the location that match the query.

Retrieves a list of all the items (files and folders) in the query results set.

When this method completes successfully, it returns a list (type IVectorView ) of items. Each item is the IStorageItem type and represents a file, folder, or file group.

Retrieves a list of items (files and folders) in a specified range.

The zero-based index of the first item to retrieve. This parameter defaults to 0. The maximum number of items to retrieve. Use -1 to retrieve all items. If the range contains fewer items than the max number, all items in the range are returned. When this method completes successfully, it returns a list (type IVectorView ) of items. Each item is the IStorageItem type and represents a file, folder, or file group.

Contains the details of a storage library change tracker.

Gets the StorageLibraryChangeTracker associated with the StorageLibraryChangeTrackerTrigger.

The StorageLibraryChangeTracker associated with the StorageLibraryChangeTrackerTrigger.

Gets the StorageFolder that has been marked as changed by the StorageLibraryChangeTrackerTrigger

The StorageFolder that has been changed.

Contains the details of a storage library content change tracker.

Gets the StorageFolder that has been changed.

The StorageFolder that has been changed.

Query for the creation/modified changes since a previous such query.

The time the previous query was made. The query result.

Specifies the language of a property, as a BCP-47 language code.

Initializes a new instance of the ValueAndLanguage class.

Gets or sets the language of the property value, specified as a BCP-47 language code.

The language of the property value, as a BCP-47 language code.

Gets or sets the property value for the current ValueAndLanguage.

The property value.

Provides a default implementation of the IBuffer interface and its related interfaces.

Initializes a new instance of the Buffer class with the specified capacity.

The maximum number of bytes that the buffer can hold.

Gets the maximum number of bytes that the buffer can hold.

The maximum number of bytes that the buffer can hold.

Gets the number of bytes currently in use in the buffer.

The number of bytes currently in use in the buffer, which is less than or equal to the capacity of the buffer.

Creates a new buffer containing a copy of a specified buffer.

The buffer to be copied. The newly created copy.

Creates a MemoryBuffer from an existing IBuffer.

The input IBuffer. The newly created MemoryBuffer.

Specifies the byte order of a stream.

The most significant byte (highest address) is stored first.

The least significant byte (lowest address) is stored first.

Reads data from an input stream.

Creates and initializes a new instance of the data reader.

The input stream.

Gets or sets the byte order of the data in the input stream.

One of the enumeration values.

Gets or sets the read options for the input stream.

One of the enumeration values.

Gets the size of the buffer that has not been read.

The size of the buffer that has not been read, in bytes.

Gets or sets the Unicode character encoding for the input stream.

One of the enumeration values.

Closes the current stream and releases system resources.

Detaches the buffer that is associated with the data reader. This is useful if you want to retain the buffer after you dispose the data reader.

The detached buffer.

Detaches the stream that is associated with the data reader.

The detached stream.

Creates a new instance of the data reader with data from the specified buffer.

The buffer. The data reader.

Loads data from the input stream.

The count of bytes to load into the intermediate buffer. The asynchronous load data request.

Reads a Boolean value from the input stream.

The value.

Reads a buffer from the input stream.

The length of the buffer, in bytes. The buffer.

Reads a byte value from the input stream.

The value.

Reads an array of byte values from the input stream.

The array that receives the byte values.

Reads a date and time value from the input stream.

The value.

Reads a floating-point value from the input stream.

The value.

Reads a GUID value from the input stream.

The value.

Reads a 16-bit integer value from the input stream.

The value.

Reads a 32-bit integer value from the input stream.

The value.

Reads a 64-bit integer value from the input stream.

The value.

Reads a floating-point value from the input stream.

The value.

Reads a string value from the input stream.

The length of the string. The value.

Reads a time-interval value from the input stream.

The value.

Reads a 16-bit unsigned integer from the input stream.

The value.

Reads a 32-bit unsigned integer from the input stream.

The value.

Reads a 64-bit unsigned integer from the input stream.

The value.

Loads data from an input stream.

Gets or sets the handler to call when the data load operation is complete.

The handler to call when the operation is complete.

Gets the error code for the data load operation if it fails.

The status of the operation.

Gets a unique identifier that represents the data load operation.

The identifier.

Gets the current status of the data load operation.

One of the enumeration values.

Requests the cancellation of the data load operation.

Requests that work associated with the data load operation should stop.

Returns the result of the data load operation.

The number of bytes read by the DataReader.

Writes data to an output stream.

Creates and initializes a new instance of the data writer.

Creates and initializes a new instance of the data writer to an output stream.

The new output stream instance.

Gets or sets the byte order of the data in the output stream.

One of the enumeration values.

Gets or sets the Unicode character encoding for the output stream.

One of the enumeration values.

Gets the size of the buffer that has not been used.

The size of the buffer that has not been used, in bytes.

Closes the current stream and releases system resources.

Detaches the buffer that is associated with the data writer.

The detached buffer.

Detaches the stream that is associated with the data writer.

The detached stream.

Flushes data asynchronously.

The stream flush operation.

Gets the size of a string.

The string. The size of the string, in bytes.

Commits data in the buffer to the output stream. This method should only be called when the DataWriter is writing into a stream; it will fail when the underlying store is a buffer.

The asynchronous store data operation.

Writes a Boolean value to the output stream.

The value.

Writes the contents of the specified buffer to the output stream.

The buffer.

Writes the specified bytes from a buffer to the output stream.

The buffer. The starting byte. The number of bytes to write.

Writes a byte value to the output stream.

The value.

Writes an array of byte values to the output stream.

The array of values.

Writes a date and time value to the output stream.

The value.

Writes a floating-point value to the output stream.

The value.

Writes a GUID value to the output stream.

The value.

Writes a 16-bit integer value to the output stream.

The value.

Writes a 32-bit integer value to the output stream.

The value.

Writes a 64-bit integer value to the output stream.

The value.

Writes a floating-point value to the output stream.

The value.

Writes a string value to the output stream.

The value. The length of the string, in bytes.

Writes a time-interval value to the output stream.

The value.

Writes a 16-bit unsigned integer value to the output stream.

The value.

Writes a 32-bit unsigned integer value to the output stream.

The value.

Writes a 64-bit unsigned integer value to the output stream.

The value.

Commits data in a buffer to a backing store.

Gets or sets the handler to call when the data store operation is complete.

The handler to call when the operation is complete.

Gets the error code for the data store operation if it fails.

The status of the operation.

Gets a unique identifier that represents the data store operation.

The identifier.

Gets the current status of the data store operation.

One of the enumeration values.

Requests the cancellation of the data store operation.

Requests that work associated with the data store operation should stop.

Returns the result of the data store operation.

The number of bytes returned by the StoreAsync method of the DataWriter.

Reads data from a file.

Closes the current stream and releases system resources.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Enumeration values for actions to take on a file.

Opens a file and truncates it so that its size is zero bytes. If the file does not exist, a new file will be created and opened.

Creates a new file if one does not exist. If the file does exist, this will fail.

Opens a file. If the file does not exist, a new file will be created and opened.

Opens a file only if it exists.

Opens a file and truncates it so that its size is zero bytes. If the file does not exist, this will fail.

Writes data to a file.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Writes data asynchronously to a file.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Supports reading and writing to a file at a specified position.

Gets a value that indicates whether the stream can be read from.

True if the stream can be read from. Otherwise, false.

Gets a value that indicates whether the file can be written to.

True if the stream can be written to. Otherwise, false.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the random access stream.

The size of the stream.

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

The new stream. The initial, internal position of the stream is 0.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Returns an input stream at a specified location in a stream.

The location in the stream at which to begin. The input stream.

Returns an output stream at a specified location in a stream.

The location in the output stream at which to begin. The output stream.

Opens a stream to an existing file given the file's path.

A path to the file to be opened. The permissions level to open the stream with. A stream to the specified file.

Opens a stream to a file given a file path. If the file does not exist, it can be created using FileOpenDisposition.

A path to the file to be opened. The permissions level to open the stream with. A bitwise combination of the enumeration values that specify options for opening the stream. An action to take on the file. A stream to the specified file.

Opens a stream for a user to an existing file given the file path and the user's information.

The user account for opening the stream. A path to the file to be opened. The permissions level to open the stream with. A stream to the specified file.

Opens a stream for a user to a file given a file path and the user's information. If the file does not exist, it can be created using FileOpenDisposition.

The user account for opening the stream. A path to the file to be opened. The permissions level to open the stream with. A bitwise combination of the enumeration values that specify options for opening the stream. An action to take on the file. A stream to the specified file.

Opens a stream for writing to an existing file given the file's path.

A path to the file to be opened. When this method completes, it returns a StorageStreamTransaction containing the random-access stream and methods that can be used to complete transactions.

Opens a stream for writing to a file given a file path. If the file does not exist, it can be created using FileOpenDisposition.

A path to the file to be opened. A bitwise combination of the enumeration values that specify options for opening the stream. An action to take on the file. When this method completes, it returns a StorageStreamTransaction containing the random-access stream and methods that can be used to complete transactions.

Opens a writable stream for a user to an existing file given the file's path and the user's information.

The user account for opening the stream. A path to the file to be opened. When this method completes, it returns a StorageStreamTransaction containing the random-access stream and methods that can be used to complete transactions.

Opens a writable stream for a user to a file given a file path and the user's information. If the file does not exist, it can be created using FileOpenDisposition.

The user account for opening the stream. A path to the file to be opened. A bitwise combination of the enumeration values that specify options for opening the stream. An action to take on the file. When this method completes, it returns a StorageStreamTransaction containing the random-access stream and methods that can be used to complete transactions.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Sets the position of the stream to the specified value.

The new position of the stream.

Writes data asynchronously to a file.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Represents a referenced array of bytes used by byte stream read and write interfaces. Buffer is the class implementation of this interface.

Gets the maximum number of bytes that the buffer can hold.

The maximum number of bytes that the buffer can hold.

Gets the number of bytes currently in use in the buffer.

The number of bytes currently in use in the buffer which is less than or equal to the capacity of the buffer.

Characterizes the format of the data.

Gets the format of the data.

The identifier for the format of the data.

Provides read access to an input stream.

Gets or sets the byte order of the data in the input stream.

One of the enumeration values.

Gets or sets the read options for the input stream.

One of the enumeration values.

Gets the size of the buffer that has not been read.

The size of the buffer that has not been read, in bytes.

Gets or sets the Unicode character encoding for the input stream.

One of the enumeration values.

Detaches a buffer that was previously attached to the reader.

The detached buffer.

Detaches a stream that was previously attached to the reader.

The detached stream.

Loads data from the input stream.

The count of bytes to load into the intermediate buffer. The asynchronous operation.

Reads a Boolean value from the input stream.

The value.

Reads a buffer from the input stream.

The length of the buffer, in bytes. The buffer.

Reads a byte value from the input stream.

The value.

Reads an array of byte values from the input stream.

The array of values.

Reads a date and time value from the input stream.

The value.

Reads a floating-point value from the input stream.

The value.

Reads a GUID value from the input stream.

The value.

Reads a 16-bit integer value from the input stream.

The value.

Reads a 32-bit integer value from the input stream.

The value.

Reads a 64-bit integer value from the input stream.

The value.

Reads a floating-point value from the input stream.

The value.

Reads a string value from the input stream.

The length of the string. The value.

Reads a time interval from the input stream.

The value.

Reads a 16-bit unsigned integer from the input stream.

The value.

Reads a 32-bit unsigned integer from the input stream.

The value.

Reads a 64-bit unsigned integer from the input stream.

The value.

Provides write access to an output stream.

Gets or sets the byte order of the data in the output stream.

One of the enumeration values.

Gets or sets the Unicode character encoding for the output stream.

One of the enumeration values.

Gets the size of the buffer that has not been used.

The available buffer length, in bytes.

Detaches a buffer that was previously attached to the writer.

The detached buffer.

Detaches a stream that was previously attached to the writer.

The detached stream.

Flushes data asynchronously.

The stream flush operation.

Gets the size of a string.

The string. The size of the string, in bytes.

Commits data in the buffer to a backing store.

The asynchronous store data operation.

Writes a Boolean value to the output stream.

The value.

Writes a number of bytes from a buffer to the output stream.

The buffer.

Writes a range of bytes from a buffer to the output stream.

The buffer. The starting byte tobe written. The number of bytes to write.

Writes a byte value to the output stream.

The value.

Writes an array of byte values to the output stream.

The array of values.

Writes a date and time value to the output stream.

The value to write.

Writes a floating-point value to the output stream.

The value to write.

Writes a GUID value to the output stream.

The value to write.

Writes a 16-bit integer value to the output stream.

The value.

Writes a 32-bit integer value to the output stream.

The value.

Writes a 64-bit integer value to the output stream.

The value.

Write a floating-point value to the output stream.

The value to write.

Writes a string value to the output stream.

The value to write. The length of the string.

Writes a time interval value to the output stream.

The value to write.

Writes a 16-bit unsigned integer value to the output stream.

The value.

Writes a 32-bit unsigned integer value to the output stream.

The value.

Writes a 64-bit unsigned integer value to the output stream.

The value.

Represents a sequential stream of bytes to be read.

Reads data from the stream asynchronously.

A buffer that may be used to return the bytes that are read. The return value contains the buffer that holds the results. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Enables a Windows Runtime component to provide sequential read access to an encapsulated stream.

Opens a stream for sequential read access.

The asynchronous operation.

Provides random access of data in input and output streams that are stored in memory instead of on disk.

Creates a new instance of the InMemoryRandomAccessStream class.

Gets a value that indicates whether the stream can be read from.

True if the stream can be read from. Otherwise, false.

Gets a value that indicates whether the stream can be written to.

True if the stream can be written to. Otherwise, false.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the random access stream.

The size of the stream.

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

The new stream. The initial, internal position of the stream is 0.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Returns an input stream at a specified location in a stream.

The location in the stream at which to begin. The input stream.

Returns an output stream at a specified location in a stream.

The location in the output stream at which to begin. The output stream.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Sets the position of the stream to the specified value.

The new position of the stream.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Specifies the read options for an input stream.

No options are specified.

The asynchronous read operation completes when one or more bytes is available.

The asynchronous read operation may optionally read ahead and prefetch additional bytes.

Provides a Windows Runtime input stream for an IStream base implementation.

Closes the current stream and releases system resources.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Represents a sequential stream of bytes to be written.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Writes data asynchronously in a sequential stream.

A buffer that contains the data to be written. The byte writer operation. The first integer represents the number of bytes written. The second integer represents the progress of the write operation.

Supports random access of data in input and output streams.

Gets a value that indicates whether the stream can be read from.

True if the stream can be read from. Otherwise, false.

Gets a value that indicates whether the stream can be written to.

True if the stream can be written to. Otherwise, false.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the random access stream.

The size of the stream.

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

The new stream. The initial, internal position of the stream is 0.

Returns an input stream at a specified location in a stream.

The location in the stream at which to begin. The input stream.

Returns an output stream at a specified location in a stream.

The location in the output stream at which to begin. The output stream.

Sets the position of the stream to the specified value.

The new position of the stream.

Enables a Windows Runtime component to provide access to an encapsulated stream.

Opens a stream for random access.

The asynchronous operation.

Supports random access of data in input and output streams for a specified data format.

Provides a Windows Runtime output stream for an IStream base implementation.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Provides random access of data in input and output streams.

Copies a source stream to a destination stream and waits for the copy operation to complete.

The stream to copy data from. The stream to copy data to. The asynchronous operation.

Copies a source stream to a destination stream.

The stream to copy data from. The stream to copy data to. The asynchronous operation.

Copies the specified number of bytes from a source stream to a destination stream.

The stream to copy data from. The stream to copy data to. The number of bytes to copy. The asynchronous operation.

Provides a Windows Runtime random access stream for an IStream base implementation.

Gets a value that indicates whether the stream can be read from.

True if the stream can be read from. Otherwise, false.

Gets a value that indicates whether the stream can be written to.

True if the stream can be written to. Otherwise, false.

Gets the byte offset of the stream.

The number of bytes from the start of the stream.

Gets or sets the size of the random access stream.

The size of the stream.

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

The new stream. The initial, internal position of the stream is 0.

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

The stream flush operation.

Returns an input stream at a specified location in a stream.

The location in the stream at which to begin. The input stream.

Returns an output stream at a specified location in a stream.

The location in the output stream at which to begin. The output stream.

Returns an asynchronous byte reader object.

The buffer into which the asynchronous read operation places the bytes that are read. The number of bytes to read that is less than or equal to the Capacity value. Specifies the type of the asynchronous read operation. The asynchronous operation.

Sets the position of the stream to the specified value.

The new position of the stream.

Writes data asynchronously in a sequential stream.

The buffer into which the asynchronous writer operation writes. The byte writer operation.

Provides random access of data in input and output streams for a file.

Creates a random access stream around a file.

The file to create a stream around. The stream that encapsulates *file*.

Creates a random access stream around the specified stream.

The source stream. The random access stream that encapsulates *stream*.

Creates a random access stream around the specified URI.

The Uniform Resource Identifier (URI) to create the stream around. The valid Uniform Resource Identifier (URI) schemes are http, https, ms-appx, and ms-appdata. The random access stream that encapsulates *uri*.

Opens a stream for random access.

The asynchronous operation.

Specifies the type of character encoding for a stream.

The encoding is UTF-16, with the most significant byte first in the two eight-bit bytes.

The encoding is UTF-16, with the least significant byte first in the two eight-bit bytes.

The encoding is UTF-8.

Gets the result of activating an app via AppDiagnosticInfo.LaunchAsync.

Gets diagnostic information, such as memory and energy use, for the activated app.

Gets the error information, if any, that may have resulted from trying to activate the app.

Contains APIs for getting a basic set of diagnostic information for all running apps.

Provides info about the app's package family name and package-relative app name.

Creates a **ResourceGroupInfoWatcher** that monitors the execution state of an app or task, and provides notifications when its state changes.

A **ResourceGroupInfoWatcher** that can be used to monitor diagnostic info.

Creates an **AppDiagnosticInfoWatcher ** that monitors information about the execution state of an app, and provides notifications when its state changes.

An **AppDiagnosticInfoWatcher ** that can be used to monitor diagnostic info.

Gets diagnostic information such as memory usage over time, energy use over time, and so on, for each resource group in the app.

Diagnostic info for each resource group in the app.

Launches the app associated with the diagnostic info.

On success, `AppActivationResult.AppResourceGroupInfo` will correspond to the newly-activated app instance.

Asynchronously requests access to diagnostic information.

Returns an async operation with a **DiagnosticAccessStatus ** value indicating the level of diagnostic info available to this app.

Gets a collection of AppDiagnosticInfo objects for all running apps that have a package family name.

A list of AppDiagnosticInfo objects for all running apps that have a package family name.

Gets a collection of AppDiagnosticInfo objects for all running instances of this app.

A collection of AppDiagnosticInfo objects for all running instances of this app.

Gets a collection of AppDiagnosticInfo objects for all instances of the specified running app.

The identifier of the running app for which to get the AppDiagnosticInfo. A collection of AppDiagnosticInfo objects for all instances of the app specified by *appUserModelId*.

Gets a collection of AppDiagnosticInfo objects for all instances of the specified app package.

The identifier of the app package for which to get the AppDiagnosticInfo. A collection of AppDiagnosticInfo objects for all instances of the app package specified by *packageFamilyName*.

Allows you to monitor diagnostic information for an app and get notifications when an app is added or removed from the list of running apps.

Gets this **AppDiagnosticInfoWatcher** status.

The status such as Started, Stopped, and so on.

Event that fires when an app is added to the list of running apps.

Fires when the watcher has completed enumerating the list of running apps that are available to monitor.

Fires when one of the apps has been removed from the list of running apps.

Event that fires when this **AppDiagnosticInfoWatcher** stops watching for changes.

Start firing events when the execution state changes, or apps change, within the list of running apps.

Stops firing events when the execution state changes, or apps change, within the list of running apps.

The data object passed to an **AppDiagnosticInfoWatcher ** event.

Gets diagnostic info for the app package.

The AppDiagnosticInfo for the current event.

Defines the status values that are returned from a call to AppDiagnosticInfoWatcher.Status.

The **AppDiagnosticInfoWatcher** was aborted.

The **AppDiagnosticInfoWatcher** has been created.

The **AppDiagnosticInfoWatcher** has finished enumerating running apps.

The **AppDiagnosticInfoWatcher** has started.

The **AppDiagnosticInfoWatcher** has stopped.

The **AppDiagnosticInfoWatcher** is stopping.

Provides the result of an attempt to change an app's execution state (such as from running to suspended).

Gets the error information, if any, that may have resulted from trying to change the apps execution state.

The exception information.

Represents app memory usage at a single point in time.

Gets the expected commit limit for the current app.

The expected commit limit in bytes.

Gets the app's peak usage of private commit.

The app's peak usage of private commit.

Gets the app's usage of private commit.

The app's usage of private commit.

Gets the app's total cap for private plus shared commit.

The app's total usage of private plus shared commit.

Gets the app's total usage of private plus shared commit.

The app's total cap for private plus shared commit.

An enumeration containing 4 levels of app memory usage: low, medium, high, and overlimit.

High app memory usage.

Low app memory usage.

Medium app memory usage.

App memory usage is over the limit.

Provides data for the AppMemoryUsageLimitChanging event.

Gets the new limit for how much total memory the app can use, in bytes.

The new limit for how much total memory the app can use, in bytes.

Gets the old limit for how much total memory the app can use, in bytes.

The old limit for how much total memory the app can use, in bytes.

Provides snapshot information about a background task such as its name, trigger name, entry point name, and task identifier.

Gets the name of the background task entry point.

The name of the entry point as specified in the app manifest.

Gets the name of the background task.

The background task name.

Gets the background task's identifier.

The background task GUID.

Gets the name of the trigger that activated this task.

The name of the trigger.

Describes how the resource group is performing relative to its energy quota.

The resource group has used more than its energy quota.

The resource group has not used its energy quota.

Unable to determine the energy quota state.

Describes the execution state of the resource group.

The resource group is part of an app that is not running.

The resource group is part of an app that is currently running.

The resource group is part of an app that has been suspended.

The resource group is part of an app that is entering the suspend state.

The execution state is not known.

Provides diagnostic information such as memory usage and energy use.

Gets the instance identifier.

The instance ID.

Indicates whether the group is part of a shared resource group. Being part of a shared resource group indicates that there are multiple apps in the package and that they share a common component.

**True** means the group is part of a shared resource group; **false**, otherwise.

Provides information about background tasks such as their entry points, names, task ids, and trigger names.

Information about each background task.

Provides information about memory usage such as the commit limit, commit usage, and so on.

Information about memory usage.

Gets process diagnostic information for the group such as used CPU time, disk I/O usage, and so on.

The process diagnostic info.

Gets the state report information such as execution state, energy quota state, and so on.

The state info.

Initiate moving the associated app to the active state.

The result of trying to resume the app.

Initiate moving the associated app to the suspended state.

The result of trying to suspend the app.

Initiate moving the associated app to the terminated state.

The result of trying to terminate the app.

Allows you to monitor the set of resource groups (AppResourceGroupInfo objects) for an app, and get notifications when a resource group is added or removed.

Gets this **AppResourceGroupInfoWatcher** status.

The status such as Started, Stopped, and so on.

Event that fires when a resource group is added.

Fires when the watcher has completed enumerating the resource groups that are available to monitor.

Event that fires when the execution state (running, suspending, an so on) for this group changes.

Fires when one of the resource groups has been removed from the list of AppResourceGroupInfos in the package.

Event that fires when this **AppResourceGroupInfoWatcher** stops watching for resource group changes.

Start firing events when the execution state changes, or resource groups change, within the set of resource groups for this app.

Stops firing events when the execution state changes, or resource groups change, within the set of resource groups for this app.

Provides information about app resource groups.

Gets diagnostic info for the resource group.

The diagnostic info for the apps associated with the AppResourceGroupInfo for the current event.

Gets diagnostic info, such as memory usage, and energy use.

The **AppResourceGroupInfo** that was added or removed.

Provides info about the execution state of this resource group when the state changes.

Gets diagnostic info for the resource group.

The diagnostic info for each resource group associated with this app.

Gets diagnostic info, such as memory usage over time, energy use over time, and so on.

The diagnostic info for this app.

Describes the various states that the AppResourceGroupInfoWatcher may be in.

The watcher has been stopped by the system as the result of an internal error or other failure condition.

The watcher has been created.

The watcher has completed enumerating the resource groups that are available to monitor. After enumeration is complete, the watcher will report when items are added or removed.

The watcher has started monitoring changes.

The watcher has stopped monitoring changes.

The watcher is in the process of stopping monitoring changes.

Provides memory information for a resource group, such as commit usage.

Returns the commit usage level for the resource group.

The amount of memory that has been allocated a data storage location as opposed to simply being reserved for future allocation.

Gets the limit of the amount of memory that can be committed (allocated) by this resource group.

The maximum amount of memory that is available for allocation.

Gets the amount of private memory (memory that can't be shared between processes) committed by this resource group.

The amount of private commit memory.

Gets the total amount of memory committed by this resource group.

The total amount of committed memory.

Provides information, such as the execution state and energy quota usage, for a resource group.

Gets the energy quota state of the resource group, such as whether it is under quota or over quota.

The energy quota state.

Gets the execution state of the resource group, such as whether it is suspended, running, and so on.

The execution state.

An object representation of the Host field in an AppUriHandler registration. These are used in conjunction with AppUriHandlerRegistration.

Default constructor for AppUriHandlerHost.

Constructor for AppUriHandlerHost which sets the name as well.

A website hostname.

A website hostname.

A website hostname.

Sets and retrieves dynamic AppUriHandlerHost entries for a given AppUriHandler registration.

The name of the registration.

The name of the registration.

The user context of this registration.

The user context of this registration.

Retrieves the set of hosts added by SetAppAddedHostsAsync for the given registration.

The set of hosts last added by SetAppAddedHostsAsync.

Registers hosts in addition to the hosts already defined in the AppxManifest.

The set of AppUriHandlerHost objects to register. Represents the asynchronous action.

Retrieves AppUriHandlerRegistrations for the calling package. This can be used to access AppUriHandler registrations.

The user context registrations will occur for.

The user context registrations will occur for.

Creates an AppUriHandlerRegistrationManager for the calling app for the current user.

An AppUriHandlerRegistrationManager which can be used to access AppUriHandlerRegistrations.

Creates an AppUriHandlerRegistrationManager for the calling app for the requested user context.

User context to perform operations for. An AppUriHandlerRegistrationManager which can be used to access AppUriHandlerRegistrations.

Attempts to retrieve a registration object for the windows.AppUriHandler extension present in the caller's AppxManifest with the given name.

Name corresponding to an entry in the caller's AppxManfiest. AppUriHandlerRegistration object representing the AppxManifest extension registration. This can be used to update dynamic registrations.

Indicates if your app has permission to access to UWP app diagnostic information.

Diagnostic access is allowed for all app packages.

Diagnostic access is denied for all app packages.

Diagnostic access is allowed for this app package only.

Diagnostic access is unspecified.

Manages a prioritized queue on which tasks execute in a serial fashion on a thread.

Gets a value indicating whether the DispatcherQueue has access to the current thread.

Fires after the **DispatcherQueue** event loop stops which is the last step in the **DispatcherQueue** shutdown process.

Fires before the dispatcher queue initiates an exit from its event loop.

Creates a **DispatcherQueueTimer** on the **DispatcherQueue** to execute a task periodically after a time interval has elapsed.

An **DispatcherQueueTimer** that can queue tasks on a timed basis to the current **DispatcherQueue**.

Gets the **DispatcherQueue** associated with the current thread.

A **DispatcherQueue** instance that will execute tasks serially on the current thread.

Adds a task to the **DispatcherQueue** which will be executed on the thread associated with the **DispatcherQueue**.

The task to execute. **True** indicates that the task was added to the queue; **false**, otherwise.

Adds a task to the **DispatcherQueue** which will be executed on the thread associated with the **DispatcherQueue**.

The priority of the task such as Low, Normal, or High. A delegate to the task to execute. **True** indicates that the task was added to the queue; **false**, otherwise.

Manages the lifetime of a DispatcherQueue. Provides methods to create and shutdown the **DispatcherQueue**.

Gets the **DispatcherQueue** associated with this **DispatcherQueueController**.

The **DispatcherQueue** instance that you use to queue tasks that run on a thread.

Creates a DispatcherQueue that you can use to run tasks on a dedicated thread.

The created **DispatcherQueueController**.

Stops the **DispatcherQueue** associated with this **DispatcherQueueController**. Shuts down the thread if the **DispatcherQueueController** was created by **CreateOnDedicatedThread**.

An asynchronous operation which will complete after the queue has dispatched all of its remaining work.

A callback that will be executed on the **DispatcherQueue** thread.

Defines the priority levels that can be given to work assigned to a DispatcherQueue.

Work scheduled at **High** priority will be dispatched first, along with other **High** priority System tasks, before processing **Normal** or **Low** priority work.

**Low** priority work will be scheduled when there isn't any other work to process. Work at **Low** priority can be preempted by new incoming **High** and **Normal** priority tasks.

Work will be dispatched once all **High** priority tasks are dispatched. If a new **High** priority work is scheduled, all new **High** priority tasks are processed before resuming **Normal** tasks. This is the default priority.

Provides the arguments for the ShutdownStarting event.

Gets a deferral object so that you can use to continue to post work to the **DisbpatcherQueue** until you mark the deferral complete.

The deferral object.

Executes a task in a **DispatcherQueue** periodically after a time interval has elapsed.

Gets and sets the interval for the timer.

The amount of time before the timer ticks.

Indicates whether the timer is repeating.

**True** indicates that the timer fires every **DispatcherQueueTimer.Interval**; **false** means that it fires once, after **DispatcherQueueTimer.Interval** elapses.

Indicates whether the timer is currently running.

**True** indicates that the timer is running; otherwise **false**

Event that fires when the timer **Interval** elapses.

Starts the timer.

Stops the timer.

Specifies the options to use when launching File Explorer to display the contents of a specific folder by calling the LaunchFolderAsync(IStorageFolder, FolderLauncherOptions) method.

Initializes a new instance of the FolderLauncherOptions class.

Specifies how much space on the screen to leave for the calling app when launching File Explorer. The calling app can take up more or less space than File Explorer, or File Explorer can fill the entire screen.

One of the enumeration values that specifies how much space on the screen to leave for the calling app when launching File Explorer.

Provides the list of items to select when File Explorer displays the contents of the specified folder.

The list of items to select when File Explorer displays the contents of the specified folder.

Contains methods for launcher view options.

Gets the desired remaining view.

The desired remaining view.

Contains basic information about a user.

Gets the user's account name.

The user's account name.

Gets the user's display name.

The user's display name.

Gets the user's domain name.

The user's domain name.

Gets the user's first name.

The user's first name.

Gets the user's guest host.

The user's guest host.

Gets the user's last name.

The user's last name.

Gets the user's principal name.

The user's principal name.

Gets the user's provider name.

The user's provider name.

Gets the user's session initiation protocol Uri.

The user's session initiation protocol Uri.

Starts the default app associated with the specified file or URI.

Enumerate the Uniform Resource Identifiers (URI) handlers on the device.

The Uri that you want to find handlers for. A list of AppInfo objects representing each application that handles the specified http(s) URI.

Enumerate the file handlers on the device.

The file extension that you want to find handlers for. For example, ".bat". Include the leading period '.'. A list of AppInfo s for each application that handles the specified file extension.

Enumerate the scheme handlers on the device.

The scheme name that you find to find handlers for. For example, "ms-lens". A list of AppInfo s for each application that handles the specified scheme.

Enumerate the scheme handlers on the device.

The scheme name that you find to find handlers for. For example, "ms-lens". Filter the list of handlers by whether they can be launched for results or not. A list of AppInfo s for each application that handles the specified scheme.

Starts the default app associated with the specified file.

The file. The launch operation.

Starts the default app associated with the specified file, using the specified options.

The file. The launch options for the app. The launch operation.

Launches File Explorer and displays the contents of the specified folder.

The folder to display in File Explorer. The result of the operation.

Launches File Explorer with the specified options and displays the contents of the specified folder.

The folder to display in File Explorer. Options that specify the amount of screen space that File Explorer fills, and the list of items to select in the specified folder. The result of the operation.

Launches File Explorer and displays the contents of the specified folder.

A filepath to the folder to open. The result of the operation.

Launches File Explorer with the specified options and displays the contents of the specified folder.

A filepath to the folder to open. Options that specify the amount of screen space that File Explorer fills, and the list of items to select in the specified folder. The result of the operation.

Launches File Explorer and displays the contents of the specified folder.

The user context to pass to the launched app. A filepath to the folder to open. The result of the operation.

Launches File Explorer with the specified options and displays the contents of the specified folder.

The user context to pass to the launched app. A filepath to the folder to open. Options that specify the amount of screen space that File Explorer fills, and the list of items to select in the specified folder. The result of the operation.

Starts the default app associated with the URI scheme name for the specified URI.

The URI. Returns **true** if the default app for the URI scheme was launched; **false** otherwise.

Starts the default app associated with the URI scheme name or the one specified by the ContentType for the specified URI, using the specified options.

The URI. The launch options for the app. Returns **true** if the default app for the URI scheme was launched; **false** otherwise.

Starts the default app associated with the URI scheme name for the specified URI, using the specified options and input data.

The URI. The launch options for the app. The input data for the app. Returns **true** if the default app for the URI scheme was launched; **false** otherwise.

Asynchronously starts the default app associated with the URI scheme name for the specified URI, using the specified options.

The Uri to launch. The launch options. When this method completes, it returns the results of the launch.

Asynchronously starts the default app associated with the URI scheme name for the specified URI, using the specified options and input data.

The Uri to launch. The launch options. The data to send to the launched app. When this method completes, it returns the results of the launch.

Asynchronously starts the default app associated with the URI scheme name for the specified URI using the specified options, and provides a specific User as context.

The user context to pass to the launched app. The Uri. The launch options. When this method completes, it returns the results of the launch.

Asynchronously starts the default app associated with the URI scheme name for the specified URI using the specified options and input data, and provides a specific User as context.

The user context to pass to the launched app. The Uri. The launch options. The data to send to the launched app. When this method completes, it returns the results of the launch.

Starts the default multi-user app associated with the URI scheme name for the specified URI and provides a specific User as context.

The user context to pass to the launched app. The URI scheme. The status of the launch attempt.

Starts the default multi-user app associated with the URI scheme name for the specified URI using the specified options, and provides a specific User as context.

The user context to pass to the launched app. The URI scheme. The launch options for the app. The status of the launch attempt.

Starts the default multi-user app associated with the URI scheme name for the specified URI, using the specified options and input data, and provides a specific User as context.

The user context to pass to the launched app. The URI scheme. The launch options for the app. The input data for the app. The status of the launch attempt.

Asynchronously query whether there is an app that can handle the specified URI.

The URI of the website. A value that indicates whether an application is available to handle the URI.

Asynchronously query whether the specified app can handle the specified URI.

The URI of the website. Specifies a specific package that will be used to launch this URI. A value that indicates whether the application is available to launch the URI.

Asynchronously query whether an app can be activated for the specified file.

The file for which to query support. A value that indicates whether an application can be activated for the file.

Asynchronously query whether an app with the specified package name can be activated for the specified file.

The file for which to query support. The package for which to query support. A value that indicates whether an application can be activated for the file.

Asynchronously query whether an app can be activated for the specified URI and launch type.

The URI for which to query support. The type of launch for which to query support. A value that indicates whether an application is available to launch the URI.

Asynchronously query whether an app can be activated for the specified URI, launch type, and package name.

The URI for which to query support. The type of launch for which to query support. Specifies a specific package that will be used to launch this URI. A value that indicates whether the application is available to launch the URI.

Specifies the options used to launch the default app for a file or URI.

Creates and initializes a new instance of the launcher options object.

Gets or sets the content type that is associated with a URI that represents a file on the network.

The content type of the URI.

Launch a target app and have the currently running source app remain on the screen by sharing the space equally with the target app or by taking up more or less space than the target app.

A ViewSizePreference -typed value that specifies the app’s desired view size.

Gets or sets a value that indicates whether to display the **Open With** dialog whenever the association launching API is called.

True if the **Open With** dialog should always be displayed; otherwise false.

Gets or sets a value that represents a URI that the user should be taken to in the browser if no app exists to handle the file type or URI.

URI that the user should be taken to in the browser.

Indicates whether to ignore handlers that can handle http(s) schemes (such as browsers). Instead, launch will fall back to the default browser.

**True** indicates that apps that can handle http(s) schemes will be ignored and instead the URI will be opened in the default browser; **false** otherwise.

Gets or sets whether to limit the picker for the launcher to the current app and its associated URI handlers.

True if the launcher should limit the picker to the current app and its associated URI handlers; otherwise, false.

Enables an app to access files that are related to the file used to activate the app.

A query containing the list of related files.

Gets or sets a value that represents the display name of the app in the store that the user should install if no app exists to handle the file type or URI.

The display name of the app.

Gets or sets a value that represents the package family name of the app in the Store that the user should install if no app exists to handle the file type or URI.

The package family name of the app.

The package family name of the target package that should be used to launch a file or URI. This property is optional.

The package family name of the target package that should be used to launch a file or URI. This property is optional.

Gets or sets a value that indicates whether the system should display a warning that the file or URI is potentially unsafe when starting the app associated with a file or URI.

True if the warning should be displayed; otherwise false.

Gets the user interface (UI) options when starting a default app.

The UI options.

Specifies options for user interface elements such as the application picker that can be invoked by this API.

Gets or sets the point on the screen where the user opened a file or URI.

The invocation point.

Gets or sets the preferred placement of the **Open With** and **Warning** dialog boxes when starting a default app.

The preferred placement.

Gets or sets the selection rectangle on the screen where the user opened a file or URI.

The selection rectangle.

Specifies the result of activating an application for a file.

The application cannot be activated which may be because it is being updated by the store, it was installed on a removable device that is not available, and so on.

The application cannot be activated for this file because files may not cross user boundaries.

The application you are trying to activate does not support this file type.

The application activated successfully.

An unknown error was encountered while activating the application.

Specifies whether an app is available that supports activation.

No app is installed to handle the activation.

An app that handles the activation is installed but not available because it is being updated by the store or it was installed on a removable device that is not available.

An app that handles the activation is available and may be activated.

The app does not handle the activation.

An unknown error was encountered while determining whether an app supports the activation.

Specifies the type of activation to query for.

Activate by URI but do not return a result to the calling app. This is the default.

Activate by URI and return a result to the calling app.

Represents the results of a Uri launch.

Gets the result of the Uri launch.

The result of the Uri launch.

Gets the status of the Uri launch.

The status of the Uri launch.

Specifies the result of activating an application for a URI.

The application cannot be activated which may be because it is being updated by the store, it was installed on a removable device that is not available, and so on.

The application you are trying to activate does not support this URI.

The application activated successfully.

An unknown error was encountered while activating the application.

Provides access to information on an app's memory usage.

Gets the app's current memory usage.

The app's current memory usage in bytes.

Gets the app's memory usage level.

The app's memory usage level.

Gets the app's memory usage limit.

The app's memory usage limit in bytes.

Gets the amount of memory that your app may expect to have available.

The expected memory cap in bytes.

Raised when the app's memory consumption has decreased to a lower value in the AppMemoryUsageLevel enumeration.

Raised when the app's memory consumption has increased to a higher value in the AppMemoryUsageLevel enumeration.

Raised just before the limit of how much total memory the app can use is changed.

Gets an AppMemoryReport for the app, which provides information about its memory usage.

Information about the process' memory usage.

Gets a ProcessMemoryReport for a process, which provides information about its memory usage.

Information about the process' memory usage.

Tries to set a specific memory cap for the current app or task. In cases where memory caps are shared between foreground and background components, any difference between the default cap and the new request will be assigned to the other component.

The new memory limit to set. **True** if the operation succeeded; otherwise, **false**.

Represents process memory usage at a single point in time.

Gets the process' private working set usage.

The process' private working set usage.

Gets the process' total working set usage.

The process' total working set usage.

Specifies the processor architecture supported by an app.

The ARM processor architecture.

The Arm64 processor architecture

A neutral processor architecture.

An unknown processor architecture.

The x64 processor architecture.

The x86 processor architecture.

The Arm64 processor architecture emulating the X86 architecture

Represents the result to the application that launched the current application for results.

Indicates that the application activated for results is ready to return to the application that launched it for results.

The data to return to the application that activated this app.

Starts the default app associated with the specified URI on a remote device.

Starts the default app associated with the URI scheme name for the specified URI on a remote device.

Specifies the remote system (device) to connect to. The URI scheme. The result of the launch attempt.

Starts the default app associated with the URI scheme name for the specified URI on a remote device, using the specified options.

Specifies the remote system (device) to connect to. The Uri scheme. The launch options for the app. The result of the launch attempt.

Starts the default app associated with the URI scheme name for the specified URI on a remote device, using the specified options and input data.

Specifies the remote system (device) to connect to. The Uri scheme. The launch options for the app. The input data for the app. The result of the launch attempt.

Specifies the options used to launch the default app for URI on a remote device.

Creates an instance of the RemoteLauncherOptions class.

Specifies the URI of the web site to view if the app to handle the URI can't be launched on the remote device.

The URI of a website.

A list of package family names that should be used to launch the URI on the remote device. The first one in the list should be the preferred application to launch on the remote system (device).

The list of package family names.

Specifies the result of activating an application for a URI on a remote device.

The app is not installed on the remote system.

The user is not authorized to launch an app on the remote system.

The user is not signed in on the target device or may be blocked by group policy.

The application you are trying to activate on the remote system does not support this URI.

The remote system could not be reached.

The URI was successfully launched on the remote system.

The URI could not be successfully launched on the remote system.

The amount of data you tried to send to the remote system exceeded the limit.

Represents a user.

Gets the authentication status of the user.

The authentication status of the user.

Gets the user's non-roamable id.

The user's non-roamable Id.

Gets the user type.

The user type.

Creates a UserWatcher which enumerates users and raises events when the collection of users changes or when a user’s authentication state changes.

A UserWatcher which enumerates users and raises events when the collection of users changes.

Finds all users asynchronously.

When this method completes successfully, it returns a list (type IVectorView ) of Users.

Finds all users of a given type asynchronously.

The type of users to find. When this method completes successfully, it returns a list (type IVectorView ) of Users.

Finds all users of a given type and authentication status asynchronously.

The type of users to find. The authentication status of users to find. When this method completes successfully, it returns a list (type IVectorView ) of Users.

Gets a user with a given Id.

The Id of the user to get. The user with the given Id.

Gets a user's picture asynchronously.

The desired size of the user's picture to return. When this method completes, it returns the user's picture.

Gets properties for the user.

The properties to get. Use the KnownUserProperties class to obtain property names. When this method completes, it returns the requested properties. If a property is missing or unavailable, it is reported as an empty string.

Gets a property for the user. Use the KnownUserProperties class to obtain property names.

The property to get. When this method completes, it returns the requested property. If the property is missing or unavailable, an empty string is returned.

Represents the authentication status of a user.

The user is locally authenticated.

The user is remotely authenticated.

The user is unauthenticated.

Represents a user authentication status change deferral returned by the UserAuthenticationStatusChangingEventArgs.GetDeferral method.

Reports that the application has completed its user authentication status change deferral.

Provides data for a user authentication status changing event.

Gets the user's current authentication status.

The user's current authentication status.

Gets the user's new authentication status.

The user's new authentication status.

Gets the user.

The user.

Requests a delay before the user's authentication status changes.

The user authentication status change deferral.

Provides data for a user changed event.

Gets the user.

The user.

Contains methods for querying for an association between a user and a device.

Fires when the user associated with a device changes.

Finds the user associated with a device.

The Id of the device. The user associated with the device.

Contains information about a UserDeviceAssociationChanged event.

Gets the Id of the associated device.

The Id of the associated device.

Gets the new user associated with the device.

The new user associated with the device.

Gets the old user previously associated with the device.

The old user previously associated with the device.

Contains methods and properties for allowing a user to select a user account in multi-user scenarios (such as on Xbox).

Creates a new UserPicker.

Gets or sets whether picking guest accounts is allowed.

True if guest accounts are allowed; otherwise, false.

Gets or sets a suggested user for the picker to indicate in the UI.

The suggested user.

Gets if the user picker is supported. This property will return false for single user devices or apps, and true for multi-user devices (such as Xbox).

True if the user picker is supported; otherwise, false.

Displays a dialog for the user to pick a user account. The selected account is signed in, paired with the IGameController that selected it, and becomes obtainable using the User class. This method is only supported for multi-user devices and apps, and will throw an exception if called from a single user device or app.

When this method completes, it returns the selected user. If no user was selected, it returns null instead.

Represents user picture sizes.

The picture size is 1080x1080.

The picture size is 208x208.

The picture size is 424x424.

The picture size is 64x64.

Represents user types.

The user is a local guest.

The user is a local user.

The user is a remote guest.

The user is a remote user.

Provides events that fire during enumeration of users, when the collection of users changes, or when a user's authentication status changes.

Gets the status of a user watcher.

The status of the user watcher.

Fires when a user is added to the collection of users returned by User.FindAllAsync.

Fires when a user's authentication status has changed.

Fires when a user's authentication status is about to change.

Fires when the initial pass of watcher events has been processed and the collection of users is complete.

Fires when a user is removed from the collection of users returned by User.FindAllAsync.

Fires when the user watcher has stopped.

Fires when the data associated with a user has changed.

Starts the user watcher.

Stops the user watcher.

Represents the status of a user watcher.

The watcher was aborted.

The watcher has been created.

The watcher's enumeration has completed.

The watcher has started.

The watcher has stopped.

The watcher is stopping.

The user's picture has been changed.

The user's properties have been changed.

Specifies the values for each virtual key.

The letter "A" key.

The accept button or key.

The add (+) operation key as located on a numeric pad.

The application key or button.

The letter "B" key.

The virtual back key or button.

The letter "C" key.

The cancel key or button

The Caps Lock key or button.

The Clear key or button.

The Ctrl key. This is the general Ctrl case, applicable to key layouts with only one Ctrl key or that do not need to differentiate between left Ctrl and right Ctrl keystrokes.

The convert button or key.

The letter "D" key.

The decimal (.) key as located on a numeric pad.

The Delete key.

The divide (/) operation key as located on a numeric pad.

The Down Arrow key.

The letter "E" key.

The End key.

The Enter key.

The Esc key.

The execute key or button.

The letter "F" key.

The F1 function key.

The F10 function key.

The F11 function key.

The F12 function key.

The F13 function key.

The F14 function key.

The F15 function key.

The F16 function key.

The F17 function key.

The F18 function key.

The F19 function key.

The F2 function key.

The F20 function key.

The F21 function key.

The F22 function key.

The F23 function key.

The F24 function key.

The F3 function key.

The F4 function key.

The F5 function key.

The F6 function key.

The F7 function key.

The F8 function key.

The F9 function key.

The favorites key.

The Final symbol key-shift button.

The letter "G" key.

The gamepad A button.

The gamepad B button.

The gamepad d-pad down.

The gamepad d-pad left.

The gamepad d-pad right.

The gamepad d-pad up.

The gamepad left shoulder.

The gamepad left thumbstick button.

The gamepad left thumbstick down.

The gamepad left thumbstick left.

The gamepad left thumbstick right.

The gamepad left thumbstick up.

The gamepad left trigger.

The gamepad menu button.

The gamepad right shoulder.

The gamepad right thumbstick button.

The gamepad right thumbstick down.

The gamepad right thumbstick left.

The gamepad right thumbstick right.

The gamepad right thumbstick up.

The gamepad right trigger.

The gamepad view button.

The gamepad X button.

The gamepad Y button.

The go back key.

The go forward key.

The go home key.

The letter "H" key.

The Hangul symbol key-shift button.

The Hanja symbol key shift button.

The Help key or button.

The Home key.

The letter "I" key.

The Insert key.

The letter "J" key.

The Junja symbol key-shift button.

The letter "K" key.

The Kana symbol key-shift button

The Kanji symbol key-shift button.

The letter "L" key.

The Left Arrow key.

The left mouse button.

The left Ctrl key.

The left menu key.

The left Shift key.

The left Windows key.

The letter "M" key.

The menu key or button.

The middle mouse button.

The mode change key.

The multiply (*) operation key as located on a numeric pad.

The letter "N" key.

The navigation accept button.

The navigation cancel button.

The navigation down button.

The navigation left button.

The navigation menu button.

The navigation right button.

The navigation up button.

The navigation up button.

The nonconvert button or key.

No virtual key value.

The number "0" key.

The number "1" key.

The number "2" key.

The number "3" key.

The number "4" key.

The number "5" key.

The number "6" key.

The number "7" key.

The number "8" key.

The number "9" key.

The Num Lock key.

The number "0" key as located on a numeric pad.

The number "1" key as located on a numeric pad.

The number "2" key as located on a numeric pad.

The number "3" key as located on a numeric pad.

The number "4" key as located on a numeric pad.

The number "5" key as located on a numeric pad.

The number "6" key as located on a numeric pad.

The number "7" key as located on a numeric pad.

The number "8" key as located on a numeric pad.

The number "9" key as located on a numeric pad.

The letter "O" key.

The letter "P" key.

The Page Down key.

The Page Up key.

The Pause key or button.

The Print key or button.

The letter "Q" key.

The letter "R" key.

The refresh key.

The Right Arrow key.

The right mouse button.

The right Ctrl key.

The right menu key.

The right Shift key.

The right Windows key.

The letter "S" key.

The Scroll Lock (ScrLk) key.

The search key.

The Select key or button.

The separator key as located on a numeric pad.

The Shift key. This is the general Shift case, applicable to key layouts with only one Shift key or that do not need to differentiate between left Shift and right Shift keystrokes.

The sleep key or button.

The snapshot key or button.

The Spacebar key or button.

The stop key.

The subtract (-) operation key as located on a numeric pad.

The letter "T" key.

The Tab key.

The letter "U" key.

The Up Arrow key.

The letter "V" key.

The letter "W" key.

The letter "X" key.

An additional "extended" device key or button (for example, an additional mouse button).

An additional "extended" device key or button (for example, an additional mouse button).

The letter "Y" key.

The letter "Z" key.

Specifies the virtual key used to modify another keypress. For example, the Ctrl key when pressed in conjunction with another key, as in Ctrl+C.

The Ctrl (control) virtual key.

The Menu virtual key.

No virtual key modifier.

The Shift virtual key.

The Windows virtual key.

Represents a property bag containing the results of a diagnostic action.

Contains extended error data about a diagnostic action.

An **HRESULT** containing the error data.

Contains the results of executing a diagnostics troubleshooting package.

Key-value pair containing the results, such as root causes, resolutions, and so on.

Indicates the current state of the execution of a diagnostics troubleshooting package.

The diagnostics run is detecting.

The diagnostics run is downloading the troubleshooting package.

The diagnostics run is initializing.

The diagnostics run is resolving.

The diagnostics run is verifying resolution.

The diagnostics run is verifying trust of the downloaded troubleshooting package.

Contains functionality for executing a diagnostics troubleshooting package.

Gets a Boolean value indicating if the diagnostics invoker is supported.

A Boolean value indicating if the diagnostics invoker is supported.

Gets the default diagnostics invoker.

Returns the default diagnostics invoker.

Gets the diagnostics invoker for the specified user.

The user for which to get the diagnostics invoker. Returns the diagnostics invoker for the specified *user*.

Asynchronously runs the diagnostics invoker with the specified diagnostics context.

A Json object containing the context for the diagnostics action. Returns an async operation object that indicates when the action has completed. A DiagnosticActionState enum value is in the result.

Asynchronously runs the diagnostics invoker with the specified diagnostics context.

A string containing the context for the diagnostics action. Returns an async operation object that indicates when the action has completed. A DiagnosticActionState enum value is in the result.

Provides access to data about the CPU usage of a process.

Gets the ProcessCpuUsageReport for the process.

The CPU usage report for the process.

Provides data about the CPU usage of the process.

Gets the amount of CPU kernel time consumed by the process.

The amount of CPU kernel time consumed by the process.

Gets the amount of CPU user time consumed by the process.

The amount of CPU user time consumed by the process.

Provides diagnostic information about a process, such as CPU usage, disk usage, memory usage and so on.

Gets the CPU time used by the process.

The CPU time used by the process.

Gets the disk I/O usage of the process.

The disk I/O usage of the process.

Gets the name of the executable file for the process.

The name of the executable file for the process.

Gets a Boolean value indicating whether or not this ProcessDiagnosticInfo instance has any related UWP information.

A Boolean value indicating whether or not this ProcessDiagnosticInfo instance has any related UWP information.

Gets memory usage data for the process.

Memory usage data for the process.

Gets the ProcessDiagnosticInfo for the parent process.

The ProcessDiagnosticInfo for the parent process.

Gets the unique process ID.

The unique process ID.

Gets the time the process was started.

The time the process was started.

Gets one or more AppDiagnosticInfo objects if the IsPackaged property is **true**.

Returns one or more AppDiagnosticInfo objects.

Gets the ProcessDiagnosticInfo for the currently running process.

The ProcessDiagnosticInfo for the currently running process.

Gets a list of ProcessDiagnosticInfo objects for all running processes that are accessible to the caller.

A list of ProcessDiagnosticInfo objects for all running processes.

Gets a ProcessDiagnosticInfo object for the specified process.

The identifier of the process for which to retrieve a ProcessDiagnosticInfo object.

Provides access to data about the disk usage of a process.

Gets the ProcessDiskUsageReport for the process.

The ProcessDiskUsageReport for the process.

Provides data about the disk usage of the process.

Gets the number of bytes the process has read from disk.

The number of bytes the process has read from disk.

Gets the number of bytes the process has written to disk.

The number of bytes the process has written to disk.

Gets the number of bytes used by the process in disk operations that were not read or write operations.

The number of bytes used by the process in disk operations that were not read or write operations.

Gets the number of disk operations performed by the process that were not read or write operations.

The number of disk operations performed by the process that were not read or write operations.

Gets the number of disk read operations performed by the process.

The number of disk read operations performed by the process.

Gets the number of disk write operations performed by the process.

The number of disk write operations performed by the process.

Provides access to data about the memory usage of a process.

Gets the ProcessMemoryUsageReport for the process.

The ProcessMemoryUsageReport for the process.

Provides data about the memory usage of the process.

Gets the amount of non-paged memory available to the process, in bytes.

The amount of non-paged memory available to the process, in bytes.

Gets the amount of paged memory available to the process, in bytes.

The amount of memory, in bytes, allocated by the associated process that can be written to the virtual memory paging file.

Gets the number of memory page faults.

The number of memory page faults.

Gets the size of the memory page file in bytes.

The size of the memory page file in bytes.

Gets the maximum amount of non-paged memory used by the process, in bytes.

The maximum amount of non-paged memory used by the process, in bytes.

Gets the maximum amount of paged memory used by the process, in bytes.

The maximum amount of paged memory used by the process, in bytes.

Gets the maximum size of the memory page file used by the process, in bytes.

The maximum size of the memory page file used by the process, in bytes.

Gets the maximum amount of virtual memory used by the associated process.

The maximum amount of virtual memory, in bytes, allocated for the associated process since it was started.

Gets the maximum amount of physical memory used by the associated process.

The maximum amount of physical memory, in bytes, allocated for the associated process since it was started.

Gets the number of private memory pages allocated for the associated process.

The number of private memory pages allocated for the associated process.

Gets the amount of the virtual memory allocated for the associated process.

The amount of virtual memory, in bytes, allocated for the associated process.

Gets the amount of physical memory allocated for the associated process.

The amount of physical memory, in bytes, allocated for the associated process.

Provides access to data about the CPU usage of the system.

Gets the CPU usage report for the system.

The SystemCpuUsageReport.

Provides data about the CPU usage of the system.

Gets the amount of time the CPU was idle.

The amount of time the CPU was idle.

Gets the amount of CPU kernel time consumed by the system.

The amount of CPU kernel time consumed by the system.

Gets the amount of CPU user time consumed by the system.

The amount of CPU user time consumed by the system.

Provides diagnostic information about the system, such as CPU usage, disk usage, memory usage and so on.

Gets the CPU time used by the system.

The CPU time used by the system.

Gets memory usage data for the system.

Memory usage data for the system.

Gets the SystemDiagnosticInfo for the current system.

The SystemDiagnosticInfo for the current system.

Provides access to data about the memory usage of the system.

Gets the memory usage report for the system.

The SystemMemoryUsageReport.

Provides data about the memory usage of the system.

Gets the amount of system memory available in bytes.

The amount of system memory available in bytes.

Gets the amount of committed memory for the system.

The amount of committed memory for the system.

Get the total amount of physical memory for the system.

The total amount of physical memory for the system.

Handles a connection to the Windows Device Portal.

Raised when the connection to the Windows Device Portal is closed. A device portal plugin app must implement a handler for this event.

Raised when a request has been received through the Windows Device Portal server. A device portal plugin app must implement a handler for this event.

Initializes an instance of DevicePortalConnection by using the app service connection passed in.

The AppServiceConnection that was used to launch the background task calling this method. The DevicePortalConnection object.

Returns a server-side message WebSocket for use with Device Portal.

The HTTP request message (found as a property of the **DevicePortalConnectionRequestReceivedEventArgs ** class). A server-side message WebSocket object that can be used with Device Portal.

Returns a server-side message WebSocket for use with Device Portal.

The HTTP request message (found as a property of the **DevicePortalConnectionRequestReceivedEventArgs ** class). A **SocketMessageType ** value indicating the type of messaging that this WebSocket will use. The sub-protocol that this WebSocket will use. A server-side message WebSocket object that can be used with Device Portal.

Returns a server-side message WebSocket for use with Device Portal.

The HTTP request message (found as a property of the **DevicePortalConnectionRequestReceivedEventArgs ** class). A **SocketMessageType ** value indicating the type of messaging that this WebSocket will use. The sub-protocol that this WebSocket will use. The size, in bytes, of the send buffer to be used for sending data on a **ServerMessageWebSocket ** object. The maximum message size, in bytes, for a WebSocket message to be configured on the **ServerMessageWebSocket ** object. A **MessageWebSocketReceiveMode ** value indicating whether this WebSocket will receive either complete or partial messages. A server-side message WebSocket object that can be used with Device Portal.

Returns a server-side stream WebSocket for use with Device Portal.

The HTTP request message (found as a property of the **DevicePortalConnectionRequestReceivedEventArgs ** class). A server-side stream WebSocket object that can be used with Device Portal.

Returns a server-side stream WebSocket for use with Device Portal.

The HTTP request message (found as a property of the **DevicePortalConnectionRequestReceivedEventArgs ** class). The sub-protocol that this WebSocket will use. The size, in bytes, of the send buffer to be used for sending data on a **ServerMessageWebSocket ** object. A boolean value indicating whether Nagle's algorithm is used on this WebSocket object. See the **StreamSocketControl ** class for more information on Nagle's algorithm. A server-side stream WebSocket object that can be used with Device Portal.

Describes a DevicePortalConnection.Closed event that was raised.

Describes the reason that the device portal connection was closed.

A DevicePortalConnectionClosedReason value describing the reason for closing.

Contains values that explain why a device portal connection was closed.

The app is missing the appropriate capability to use a device portal.

The connection closed because of an unrecognized app service message.

Windows Devices Portal closed the connection because the resource limit was exceeded.

Windows Device Portal has shut down.

The connection closed for an unknown reason.

The WTS active console user was missing.

Describes a DevicePortalConnection.RequestReceived event that was raised.

Gets a value describing whether the request is for WebSocket communication.

**True** if a WebSocket is being requested, otherwise **False**.

Gets the HTTP request message for this request.

An HttpRequestMessage instance representing the HTTP request coming in through the Windows Device Portal server.

Gets the HTTP response message for this request.

An HttpResponseMessage instance that will contain the device portal plugin's response to an HTTP request. Its properties must be set by the plugin app.

Gets a list of the sub-protocols that the WebSocket is requested to follow.

A list of strings representing WebSocket sub-protocols.

Retrieves a deferral object to allow the background task to continue executing while a Device Portal connection is open.

The deferral object.

Provides functionality to register a client with the Connected User Experience and Telemetry component.

Registers a client with the Connected User Experience and Telemetry component.

Unique string value that identifies the client.

Registers a client with the Connected User Experience and Telemetry component.

Unique string value that identifies the client. PlatformTelemetryRegistrationSettings for registering a client.

The result of registering a client with or without registration settings.

Gets the status of the client registration result.

Success; SettingsOutOfRange; UnknownFailure. For more information, see PlatformTelemetryRegistrationStatus.

Describes the settings for registering an app with the Connected User Experience and Telemetry component.

Settings for registering a client.

Gets the storage size of the client.

Storage size of the client, in bytes. Value must be greater than 0 and less than 100 megabytes.

Gets the upload quota size of the client.

Upload quota for the client, in bytes. A value of 0 indicates no upload limitation.

Provides information about the status of registering a client with the Connected User Experience and Telemetry component.

The registration settings are invalid.

Registration is successful or the app has already been registered.

Registration failed for another unknown reason.

Manages diagnostic scenarios

Downloads the settings that describes which diagnostic data is collected as part of the specified profile.

The name of the partner associated with this profile. The name of the feature associated with this profile. *true* if this profile is associated with a scenario; *false* otherwise. *true* to download settings even if the device only has access to a costed network connection; *false* otherwise. *true* to download the settings even if the device is running on battery; *false*, otherwise. The result of trying to download the settings.

Cause diagnostic data to be uploaded within the specified parameters.

True to upload even if the device only has access to a cellular data connection; false otherwise. **True** to upload even if the device is running on battery; **false** otherwise.

Get the list of scenarios that have been downloaded to the device.

A list of GUIDs that identify the scenarios that have been downloaded.

Returns the amount of time that a trace in the specified slot has been running.

Which slot to query. How long the trace in the specified slot has been running.

Get the list of diagnostic traces that are available on the system.

The slot for which you want a list of traces. A list that describes the traces available for the slot.

Whether a scenario profile has been downloaded to the device.

The scenario identifier. *True* if the scenario is available; *false* otherwise.

Whether a trace for the specified scenario is in progress.

The slot for the scenario. The scenario identifier. The trace profile identifier. **True** if the specified trace is running; **false** otherwise.

Try to run a scenario on demand.

The scenario identifier. The type of escalation. The path to the location where the diagnostic data will be stored. *True* to have the output directory timestamp reflect when the diagnostic data is written to the directory; *false* otherwise. If the diagnostic scenario cannot be found on the device, *true* initiates an upload of the escalation scenario. A dictionary of trigger and property pairs. The format is "$(T,P)=V where T is the trigger, P is the property, and V is the value. For example, {""$(T1,Filename)=c:\foo.dat"} implies that the Connected User Experience and Telemetry component will substitute c:\foo.dat in any action which specifies $(T1,FileName). *True* indicates the scenario was escalated; *false*, otherwise.

Specifies the outcome of a diagnostic trace operation.

The operation failed because the device is running on battery power.

The operation failed because a non-metered network connection is not available.

The operation was successful.

Specifies the categories of escalation actions.

Take the actions associated with diagnostic escalation success.

Take the actions associated with diagnostic escalation failure.

Specifies the kinds of network connections that can be used to transfer diagnostic data.

Less strict than **Normal**. If, after three days, there has been no opportunity to connect over a non-cellular connection, trace data will be transferred even if the device is still on a cellular connection.

Trace data will be transferred unless the device is on a metered connection.

Trace data will be uploaded as soon as a network connection (of any kind) is available.

Provides information about the trace.

Indicates whether the trace is from an ETW AutoLogger session.

**True** if the trace is from an ETW autologger session; **false** otherwise.

Indicates whether the trace is exclusive.

**true** - the trace is exclusive; **false** otherwise.

Trace files are circular. This property reflects the amount of time that will pass before the trace file starts writing over itself--starting at the beginning of the file.

The amount of time until the file overwrites itself, expressed in clock ticks.

The trace priority.

Whether the priority of the trace is normal or has been elevated by the user.

An identifier for this trace.

The trace hash value.

A unique identifier for this scenario.

The globally unique identifier (GUID) for this scenario.

Describes the priority of a trace.

The trace is being collected at normal priority.

The trace priority has been elevated by user action.

Provides timestamp information about the trace.

The internal time stamp (in ticks) for the Event Tracing for Windows (ETW) file.

The time stamp for the Event Tracing for Windows (ETW) file.

The timestamp (in ticks) for the trace.

The timestamp for the trace file.

Describes the state of a trace.

The trace is not currently running.

The trace is running.

The trace is not running because another trace has higher priority, or the device is running on battery power.

Describes the slot type that a trace can be assigned to.

Traces that run briefly are assigned to this slot. For example, a user initiated trace that is started while the user reproduces a scenario, and then stops the trace, is assigned to this slot.

A slot for long running traces. Traces in this slot are circular (they don't grow indefinitely ). This slot might be used to run a diagnostic trace for an infrequent failure. With the trace always running, you can gather trace information that immediately preceded the failure.

Always running, low impact traces, are assigned to this slot.

Represents a display request.

Creates an instance of the DisplayRequest class.

Activates a display request.

Deactivates a display request.

Provides a list of installed Win32 apps available to the current user. This includes apps installed for all users as well as only for the current user.

Gets the display name of the installed desktop app.

The display name of the installed desktop app.

Gets the string-based version of the installed desktop app.

The string-based version of the installed desktop app.

Gets the string-based ID of the installed desktop app.

The string-based ID of the installed desktop app.

Gets the publisher of the installed desktop app.

The publisher of the installed desktop app.

Gets a list of installed Win32 apps available to the current user. This includes apps installed for all users as well as only for the current user.

Returns an async operation indicating that the task has completed and containing a list of installed Win32 apps available to the current user.

Returns a string that represents the current InstalledDesktopApp object.

The string version of the InstalledDesktopApp.

Provides information about your app's background energy usage.

Background Energy Manager has been deprecated. For more info, see MSDN.

Gets the excessive usage level, expressed as a percentage of normal energy usage.

The excessive usage level, expressed as a percentage of normal energy usage.

Gets the low usage level, expressed as a percentage of normal energy consumption.

The low usage level, expressed as a percentage of normal energy consumption.

Gets the maximum acceptable usage level, expressed as a percentage of normal energy consumption.

The maximum acceptable usage level, expressed as a percentage of normal energy consumption.

Gets the near-maximum acceptable usage level, expressed as a percentage of normal energy usage.

The near-maximum acceptable usage level, expressed as a percentage of normal energy usage.

Gets the near-termination usage level, expressed as a percentage of normal energy usage.

The near-termination usage level, expressed as a percentage of normal energy usage.

Gets the energy usage of the app's background task for the current 30 minute period, expressed as a percentage of normal.

The energy usage of the app's background task for the current 30 minute period, expressed as a percentage of normal.

Gets the nearest predefined energy level of the app's background task for the current 30 minute period, equal to LowUsageLevel, NearMaxAcceptableUsageLevel, MaxAcceptableUsageLevel, ExcessiveUsageLevel, NearTerminationUsageLevel, or TerminationUsageLevel.

The nearest predefined energy level of the app's background task for the current 30 minute period.

Gets the termination usage level, expressed as a percentage of normal energy usage.

The termination usage level, expressed as a percentage of normal energy usage.

Occurs when the background task's energy usage has increased significantly.

Occurs when the background task's energy usage has decreased to a low usage level.

Indicates the status of the battery.

The battery is charging.

The battery is discharging.

The battery is idle.

The battery or battery controller is not present.

Specifies the status of battery saver.

Battery saver is off permanently or the device is plugged in.

Battery saver is off now, but ready to turn on automatically.

Battery saver is on. Save energy where possible.

Provides information about your app's foreground energy usage.

Foreground Energy Manager has been deprecated. For more info, see MSDN.

Gets the excessive usage level, expressed as a percentage of normal energy usage.

The excessive usage level, expressed as a percentage of normal energy usage.

Gets the low usage level, expressed as a percentage of normal energy consumption.

The low usage level, expressed as a percentage of normal energy consumption.

Gets the maximum acceptable usage level, expressed as a percentage of normal energy consumption.

The maximum acceptable usage level, expressed as a percentage of normal energy consumption.

Gets the near-maximum acceptable usage level, expressed as a percentage of normal energy usage.

The near-maximum acceptable usage level, expressed as a percentage of normal energy usage.

Gets the nearest predefined energy level of the foreground app for the current 30 minute period, equal to LowUsageLevel, NearMaxAcceptableUsageLevel, MaxAcceptableUsageLevel, or ExcessiveUsageLevel.

The nearest predefined energy level of the foreground app for the current 30 minute period.

Gets the nearest predefined energy level of the foreground app for the current 30 minute period, equal to LowUsageLevel, NearMaxAcceptableUsageLevel, MaxAcceptableUsageLevel, or ExcessiveUsageLevel.

The nearest predefined energy level of the foreground app for the current 30 minute period.

Occurs when the app's foreground energy usage has increased significantly.

Occurs when the app's energy usage has decreased to a low usage level.

Provides access to information about a device's battery and power supply status.

Gets the device's battery status.

The device's battery status.

Gets the devices's battery saver status, indicating when to save energy.

The status of battery saver.

Gets the device's power supply status.

The device's power supply status.

Gets the total percentage of charge remaining from all batteries connected to the device.

The total percentage of charge remaining from all batteries connected to the device.

Gets the total runtime remaining from all batteries connected to the device.

The total runtime remaining from all batteries connected to the device.

Occurs when BatteryStatus changes.

Occurs when EnergySaverStatus changes.

Occurs when the PowerSupplyStatus changes.

Occurs when RemainingChargePercent changes.

Occurs when RemainingDischargeTime changes.

Represents the device's power supply status.

The device has an adequate power supply.

The device has an inadequate power supply.

The device has no power supply.

Provides debugging APIs for calculating your app's background energy usage in real time. We recommend using these APIs only for debugging.

Background Energy Diagnostics has been deprecated. For more info, see MSDN.

Gets the device-specific conversion factor used to convert energy usage (mW) to a normalized percentage.

The device-specific conversion factor used to convert energy usage (mW) to a normalized percentage.

Computes the total cumulative energy usage of the background task since the last reset, expressed as a percentage of normal.

Background Energy Diagnostics has been deprecated. For more info, see MSDN. The total cumulative energy usage of the background task since the last reset, expressed as a percentage of normal.

Clears the value that represents the total cumulative energy usage of the background task since the last reset.

Background Energy Diagnostics has been deprecated. For more info, see MSDN.

Provides debugging APIs for calculating your app's foreground energy usage in real time. We recommend using these APIs only for debugging.

Foreground Energy Diagnostics has been deprecated. For more info, see MSDN.

Gets the device-specific conversion factor used to convert energy usage (mW) to a normalized percentage.

The device-specific conversion factor used to convert energy usage (mW) to a normalized percentage

Computes the total cumulative energy usage of the foreground app since the last reset, expressed as a percentage of normal.

Background Energy Diagnostics has been deprecated. For more info, see MSDN. The total cumulative energy usage of the foreground app since the last reset, expressed as a percentage of normal.

Clears the value that represents the total cumulative energy usage of the foreground app since the last reset.

Background Energy Diagnostics has been deprecated. For more info, see MSDN.

HingeState is deprecated and might not work on all platforms. For more info, see MSDN.

The device is closed.

The device is opened more than 180 degrees.

The device is opened less than 180 degrees.

The device is opened 180 degrees.

The device is fully opened.

The hinge state is unknown.

Provides information about the device posture, including hinge state and orientation.

TwoPanelHingedDevicePosturePreview is deprecated and might not work on all platforms. For more info, see MSDN.

Occurs when the device posture has changed.

Gets the current device posture.

TwoPanelHingedDevicePosturePreview is deprecated and might not work on all platforms. For more info, see MSDN. A TwoPanelHingedDevicePosturePreviewReading representing the current posture.

Gets the default posture for the device.

TwoPanelHingedDevicePosturePreview is deprecated and might not work on all platforms. For more info, see MSDN. A TwoPanelHingedDevicePosturePreview representing the default posture for the device.

A snapshot of the device's posture information at a moment in time.

TwoPanelHingedDevicePosturePreviewReading is deprecated and might not work on all platforms. For more info, see MSDN.

The hinge state of the device.

The device's hinge state.

Describes the id of the device's 1st panel.

The 1st panel's id.

Describes the orientation of the device's first panel at the time the reading was taken.

The first panel's orientation.

Describes the id of the device's second panel.

The second panel's id.

Describes the orientation of the device's second panel at the time the reading was taken.

The second panel's orientation.

Describes when a TwoPanelHingedDevicePosturePreviewReading was taken.

The timestamp when the reading was taken.

Contains information about a TwoPanelHingedDevicePosturePreviewReadingChanged event

TwoPanelHingedDevicePosturePreviewReadingChangedEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

The TwoPanelHingedDevicePosturePreviewReading that is passed along with the TwoPanelHingedDevicePosturePreviewReadingChangedEvent.

The device posture reading associated with a posture changed event.

Provides information about the device for profiling purposes.

Gets the device form factor running Windows 10. For example, the app could be running on a phone, tablet, desktop, and so on.

The device form factor.

Gets version info about the device family.

Version info about the device family.

Asynchronously retrieves the requested system attributes.

An IIterable list of strings containing the system attributes to retrieve. Returns an IAsyncOperation object indicating that the task has completed and containing an IMapView object with the requested attributes as Key/Value pairs.

Provides version information about the device family.

Gets a string that represents the type of device the application is running on.

The device family.

Gets the version within the device family.

The version within the device family.

This class exposes a single static method used to check if a list of App Capabilities is supported on the current device.

Given a list of App Capabilities required by an app, returns a list of UnsupportedAppRequirement objects representing capabilities in the list that are not supported on the current device

A list of App Capability strings A collection of UnsupportedAppRequirement objects that represents the requested capabilities not supported on the current device.

Indicates if an app is running in an education environment.

Gets a Boolean value indicating if the app is running in an education environment.

A Boolean value indicating if the app is running in an education environment.

Specifies the diagnostics data collection level.

Basic data

Enhanced data

All data

Security data

Provides access to settings for collecting diagnostic data and an event to subscribe to changes to the platform diagnostics and usage data collection level settings.

Gets the current data collection level.

The current data collection level.

Occurs when the data collection level has changed.

Returns a Boolean value indicating if the requested data collection level can be enabled.

The desired data collection level. Returns true if the requested data collection level can be enabled, otherwise false.

Provides information to uniquely identify the system on which the app is running.

Gets an identifier value for the system based on the app publisher ID.

A SystemIdentificationInfo object for this system, based on the app publisher ID.

Gets an identifier value for the system based on the user ID.

The User data to use for creating the system ID. If the value is `null`, this method will get the current user's ID. A SystemIdentificationInfo object for this system, based on the user ID.

Represents a unique system identifier based on either the app publisher ID or a user ID.

Gets a unique system identifier based on either the app publisher ID or a user ID.

A unique system identifier based on either the app publisher ID or a user ID.

Gets the source that generated the unique ID, either a Unified Extensible Firmware Interface (UEFI) or a Trusted Platform Module (TPM).

The source that generated the unique ID.

Indicates the module used to generate a unique system identifier.

There is no module present on the device for generating a unique system ID.

The ID was generated from the system registry.

The ID was generated by a Trusted Platform Module (TPM).

The ID was generated by a Unified Extensible Firmware Interface (UEFI).

Defines constants that specify the current stage in the lifecycle of the Out-of-Box Experience (OOBE).

Indicates that the OOBE has completed on this device. This is the value reported for devices that have no OOBE.

Indicates that the OOBE has started and is in progress on this device.

Indicates that the OOBE has not yet started on this device.

Provides a property and an event that describe the current stage in the lifecycle of the Out-of-Box Experience (OOBE).

Gets a value representing the current stage in the lifecycle of the Out-of-Box Experience (OOBE).

A SystemOutOfBoxExperienceState value describing the current stage in the lifecycle of the Out-of-Box Experience (OOBE).

Raised when the current stage in the lifecycle of the Out-of-Box Experience (OOBE) changes.

Provides a reason why a particular App Capability is not supported on a particular device

An UnsupportedAppRequirementReasons object that explains why a particular App Capability is unsupported on the current device

The name of the App Capability that is not supported

Indicate why an App Capability is unsupported on the current device

The system has indicated that the capability is not available

The reason is unknown

Provides information about the current Windows 10 secure mode (10 S mode), and an event that is raised when the mode changes.

Gets a value that indicates whether or not Windows 10 secure mode (10 S mode) can be disabled by any means—at run time and/or offline; by the original equipment manufacturere (OEM), or by a third party.

`true` if Windows 10 secure mode (10 S mode) can be disabled by any means, otherwise `false`.

Gets a value that indicates (see Remarks for other necessary conditions) whether or not there is any published way, or API, for third-party vendors to disable Windows 10 secure mode (10 S mode) at run time.

`true` (but see Remarks for other necessary conditions) if there is any published way, or API, for third-party vendors to disable Windows 10 secure mode (10 S mode) at run time, otherwise `false`.

Gets a value that indicates whether or not Windows 10 secure mode (10 S mode) is enabled (Windows Lockdown mode).

`true` if Windows 10 secure mode (10 S mode) is enabled (Windows Lockdown mode), otherwise `false`.

Gets a value that indicates whether or not Windows 10 secure mode (10 S mode) is enabled (Windows Lockdown mode) for trial purposes.

`true` if Windows 10 secure mode (10 S mode) is enabled (Windows Lockdown mode) for trial purposes, otherwise `false`.

Raised when the current Windows 10 secure mode (10 S mode) changes.

Provides Remote Desktop information about the current session.

Indicates whether the calling process is running in a Remote Desktop session.

Contains **True** if the current process is running in a remote session or **False** otherwise.

Limits the set of remote systems that a RemoteSystemWatcher object can discover, according to a particular characterization.

Contains the string names of different features of the Remote Systems platform. A remote system is either compatible or incompatible with each of the capabilities corresponding to the properties of this class.

Gets the canonical string name of the app service capability.

The canonical string name of the app service capability.

Gets the canonical string name of the launch URI capability.

The canonical string name of the launch URI capability.

Gets the canonical string name of the remote session capability.

The canonical string name of the remote session capability.

Gets the canonical string name of the spatial entity capability.

The canonical string name of the spatial entity capability.

This class manages the attributes of a discovered remote system (device) and provides the capabilities to discover remote systems as part of Project Rome.

A list of the applications on this remote system that have registered with the Connected Devices Platform.

The list of applications.

Gets the machine name of the given remote system.

The name of the given remote system.

Gets the unique string identifier for the given remote system.

The string identifier for the remote system.

Checks whether the given remote system is available through proximal connection (such as a Bluetooth or local network connection) as opposed to cloud connection.

**True** if the given remote system is available by proximal connection, **False** otherwise.

Checks whether the given remote system is available through spatially proximal connection.

**true** if the given remote system is available by spatially proximal connection, **false** otherwise.

Gets a String representation of the device type of the given remote system (desktop, Xbox, ...).

The device type of the remote system.

Gets the manufacturer name of the given remote system.

The name of the given remote system's manufacturer.

Gets the model name of the given remote system.

The model name of the given remote system.

Gets a value describing the OS platform that this remote system is running.

A **RemoteSystemPlatform ** value for the corresponding remote system.

Gets the status of this remote system's availability.

The availability status of the remote system.

Gets the User property.

The User.

Returns a RemoteSystemWatcher object with no filters.

A watcher that can raise events related to the status of any discoverable device.

Returns a RemoteSystemWatcher object that filters the remote systems it can see. The *filters* parameter determines which remote systems will be seen.

A list of objects implementing the IRemoteSystemFilter interface. Each item in the list acts as a filter for the set of remote systems that can be discovered. A watcher that can raise events related to the status of any discoverable devices that pass the given filter(s).

Returns a RemoteSystemWatcher object that operates in the context of the specified User. The *user* parameter indicates the User to discover devices for.

The specific User for which the RemoteSystemWatcher will discover remote systems. A watcher that can raise events related to the status of a specific User's discoverable devices.

Returns a RemoteSystemWatcher object that operates in the context of a given User and filters the remote systems it can see. The *user* parameter indicates the User to discover remote systems for. The *filters* parameter determines which remote systems will be seen.

The specific User for which the RemoteSystemWatcher will discover remote systems. A list of objects implementing the IRemoteSystemFilter interface. Each item in the list acts as a filter for the set of remote systems that can be discovered. A watcher that can raise events related to the status of any discoverable devices that pass the given user and filter(s) parameters.

Attempts to discover a single remote system specified by the *HostName* parameter.

A wrapper object for the address of a remote system to be discovered. For information on how to instantiate a , see the HostName constructor. An asynchronous operation that returns the RemoteSystem that was found. Returns *null* if no was found.

Reports whether the **RemoteSystem** is capable of the given Remote System feature.

The Remote System capability to check. This should be the value of one of the properties of KnownRemoteSystemCapabilities. An asynchronous operation with a value of **true** if the **RemoteSystem** is capable, otherwise **false**.

Checks whether the client device is authorized to discover other users' devices or just same-user devices.

The RemoteSystemAuthorizationKind to check. Returns **true** if the client device is set to *kind* authorization scheme, otherwise **false**.

Gets the status of the calling app's access to the Remote Systems feature. This method should always be called before an app attempts to discover or otherwise interact with remote systems.

An asynchronous operation that returns the status of access.

Contains the values that describe an app's access to use the **Remote Systems** feature.

Access is allowed

Access is denied to this app by the System; the app hasn't requested the proper capability.

Access has been denied to this particular app by this particular user.

Access is denied for an unknown reason.

Gets information about a RemoteSystemAdded event, namely the RemoteSystem that was added.

The RemoteSystem object representing the device that was added to the set of discoverable devices, causing the containing RemoteSystemAdded event to be raised.

The device added.

Represents an application on a remote system.

The app-specific attributes of this application.

A Map of key/value pairs defining the attributes.

Gets a token that can be persisted by a RemoteSystemApp so that it can be connected back to later.

A string of the ConnectionToken.

The display-friendly name for this application. This is the name used by the device for Bluetooth identification. If this hasn't been set or the device doesn't support Bluetooth, this field will be empty.

A String of the display name.

The unique identifier for this application.

A unique String identifier.

Indicates whether this application is currently available for proximal connection.

**true** if the application is available for proximal connection, otherwise **false**.

Indicates whether this application is currently available for spatial sharing connection.

**true** if the application is available for spatial sharing, otherwise **false**.

Gets the User.

The User.

This class represents an application that is to be registered in the cloud for remote connectivity. A registered app can provide remote app services or be used to launch a URI.

Gets the attributes associated with this application.

A map of key/value attributes.

The user under which to register the app.

The user.

Gets a **RemoteSystemAppRegistration ** instance to register an app for the device's default user account.

A new **RemoteSystemAppRegistration** instance.

Gets a **RemoteSystemAppRegistration ** instance to register an app for the given user.

The user. A new **RemoteSystemAppRegistration** instance.

Starts the process of registering this application in the cloud.

An asynchronous operation with a value of **true** if the registration was successful, otherwise **false**.

Contains values specifying whether the client device can discover only same-user devices or other users' devices as well. Cross-user devices must be available through a proximal connection in order to be discovered (see RemoteSystemDiscoveryType for details).

The client device can discover other users' devices, provided they are available for proximal connection.

The client device can only discover devices signed in by the same user.

An IRemoteSystemFilter that alters the set of discoverable remote systems by allowing those of a specific authorization kind.

Initializes an instance of the RemoteSystemAuthorizationKindFilter class.

The authorization kind to target.

The authorization kind setting that the containing RemoteSystemAuthorizationKindFilter object targets.

The authorization kind to target.

Provides information about a connection to a remote system. For example, the type of connection.

Gets whether the associated remote system connection is a proximal connection or not.

**True** if the connection is proximal, **False** otherwise.

Creates an instance of this class corresponding to the given app service connection.

The AppServiceConnection instance for which the underlying remote system connection's information should be obtained. **RemoteSystemConnectionInfo **

Represents an intent to communicate with a specific remote system (device).

Initializes an instance of the RemoteSystemConnectionRequest class.

The underlying remote system (device) for the resulting RemoteSystemConnectionRequest.

Gets a token that persists connection info of a RemoteSystemConnectionRequest so that it can be connected back to later.

A string of the ConnectionToken.

Represents the remote system (device) that the app intends to communicate with.

The remote system to communicate with.

Represents the remote application that the app intends to communicate with.

The remote application to communicate with.

Initializes a new instance of the RemoteSystemConnectionRequest class for a particular application on a remote system.

The underlying remote application to attempt to connect to. An instance of the RemoteSystemConnectionRequest class.

Returns a RemoteSystemConnectionRequest based on a ConnectionToken.

The specific connection token for which the RemoteSystemConnectionRequest will be created with. An instance of the RemoteSystemConnectionRequest class.

Returns a RemoteSystemConnectionRequest based on a ConnectionToken and a specific user.

The specific User for which the RemoteSystemConnectionRequest will be created for. The specific connection token for which the RemoteSystemConnectionRequest will be created with. An instance of the RemoteSystemConnectionRequest class.

Contains the values that describe how remote systems are able to be discovered.

Remote systems are discoverable both through a proximal connection and through cloud connection.

Remote systems are only discoverable through cloud connection.

Remote systems are only discoverable through a proximal connection, such as a local network or Bluetooth connection.

Remote systems are discoverable through a proximal connection and are expected to be spatially near to the client device.

An IRemoteSystemFilter that limits the set of discoverable remote systems by allowing only those of a specific discovery type.

Initializes an instance of the RemoteSystemDiscoveryTypeFilter class.

The discovery type to target.

The discovery type that the containing RemoteSystemDiscoveryTypeFilter object targets.

The discovery type to target.

This is the argument class for the **RemoteSystemWatcher.EnumerationCompleted ** event.

An IRemoteSystemFilter that limits the set of discoverable remote systems by allowing only those of specific device types.

Initializes an instance of the RemoteSystemKindFilter class with a list of string representations of device types to target. These strings should conform to the values of the properties of the RemoteSystemKinds class.

A list of string representations of the device types to target.

String representation(s) of the device type(s) that the containing RemoteSystemKindFilter object targets.

A read-only list of string representations of the device types to target.

Contains read-only strings that identify various device types.

Gets the string representation of the **desktop** device type.

String representing **desktop**.

Gets the string representation of the **holographic** device type.

String representing **holographic**.

Gets the string representation of the **hub** device type.

String representing **hub**.

Gets the string representation of the **Internet of Things (IoT)** device type.

String representing **IoT**.

Gets the string representation of the **laptop** device type.

String representing **laptop**.

Gets the string representation of the **phone** device type.

String representing **phone**.

Gets the string representation of the **tablet** device type.

String representing **tablet**.

Gets the string representation of the **Xbox** device type.

String representing **Xbox**.

Contains values that describe the operating system platforms that a remote system could be running.

The device is running Android.

The device is running iOS.

The device is running Linux.

The OS platform is unknown.

The device is running Windows.

Gets information about a RemoteSystemRemoved event, namely the RemoteSystem that was removed

The RemoteSystem object representing the device that was removed from the set of discoverable devices, causing the containing RemoteSystemRemoved event to be raised.

The device removed.

Represents and handles a remote session that can be shared between two or more connected devices. See Remarks for information on this feature.

Gets the machine name of the device that is the controller of this remote session.

The machine name of the controller device.

Gets the public-facing name for this remote session, given by the controller of the session.

The display name for this session.

Gets the unique identifier for this remote session.

An id string unique to this session.

Raised when this device has been disconnected from this remote session.

Closes the session, disconnecting all participants.

Initializes a RemoteSystemSessionParticipantWatcher to monitor the participants of this remote session.

A RemoteSystemSessionParticipantWatcher for this session.

Initializes and returns a RemoteSystemSessionWatcher object to monitor the presence of remote sessions.

A watcher object to be used in discovering remote sessions.

Invites a given remote device to join this remote session.

The RemoteSystem object representing the system to which this invitation is being sent. An asynchronous operation with a boolean value: **true** if the invitation was sent successfully, otherwise **false**.

Contains information about a RemoteSystemSessionWatcher.Added event.

Gets information about the remote session that has been discovered.

A RemoteSystemSessionInfo object corresponding to the newly discovered remote session.

Handles the creation and management of a new remote session for other devices to join.

Initializes a RemoteSystemSessionController with a custom display name.

The public-facing name for this remote session. It should be simple and descriptive.

Initializes a RemoteSystemSessionController with a custom display name and specified options.

The public-facing name for this remote session. It should be simple and descriptive. The RemoteSystemSessionOptions object specifying additional options for this remote session.

Raised whenever another device has discovered and requested access to the remote session managed by this RemoteSystemSessionController.

Asynchronously attempts to create a remote session.

An asynchronous operation with a RemoteSystemSessionCreationResult object describing the result.

Removes a participant from the remote session.

A RemoteSystemSessionParticipant object corresponding to the participant being removed. An asynchronous operation containing a boolean value: **true** if the removal operation was a success, otherwise **false**.

Represents the result of an attempt by a RemoteSystemSessionController object to create a new remote session.

Gets the RemoteSystemSession object related to this creation attempt.

The RemoteSystemSession object representing the session that was created (if the attempt was successful). If the session was not created successfully, this value is **null**.

Gets the status of a RemoteSystemSessionController object's attempt to create a remote session.

A RemoteSystemSessionCreationStatus value describing the result.

Describes the status of an attempt to create a remote session.

The creation attempt failed for an unknown reason.

The remote session was not created because this device is already a participant in the maximum allowed number of sessions.

The remote session was created successfully.

Contains information about a RemoteSystemSession.Disconnected event, namely the reason that this device was disconnected from the session.

Gets the reason this device was disconnected from the session.

The RemoteSystemSessionDisconnectedReason value representing the reason for disconnection.

Contains values that describe the reason that a device may be disconnected from a remote session.

The device controlling the remote session removed this device as a participant.

The device controlling the remote session ended the session.

The connection to the remote session was lost.

Contains identifying information about a remote session.

Gets the machine name of the device that is the controller of the remote session.

The machine name of the controller device.

Gets the public-facing name for the remote session, given by the controller of the session.

The display name for the session.

Issues a request from the calling device to join the given remote session.

An asynchronous operation with the result of this join request. This also returns a value if the connection to the device controlling the session is lost.

Represents an invitation from a session participant to join their remote session.

Gets a RemoteSystem object representing the device that sent the invitation.

The RemoteSystem object representing the sending device.

Gets a RemoteSystemSessionInfo object representing the session to which this device was invited.

The RemoteSystemSessionInfo object representing the session to which this device was invited.

Contains the functionality for receiving and handling invitations to join remote sessions. This class begins listening for invitations when it is instantiated.

Initializes an instance of RemoteSystemSessionInvitationListener.

Raised when a remote session invitation from another device has been detected.

Contains information about a RemoteSystemSessionInvitationListener.InvitationReceived event, namely the associated RemoteSystemSessionInvitation object.

Gets the RemoteSystemSessionInvitation object associated with the invitation received.

The RemoteSystemSessionInvitation object representing this invitation.

Represents a remote device's request to join a session controlled by this device.

Describes a request by a remote device to join a remote session.

A RemoteSystemSessionParticipant object representing the participant that issued the join request.

Causes the app to accept the requesting device into the remote session it is controlling.

Contains information about the RemoteSystemSessionController.JoinRequested event that was raised.

Gets the RemoteSystemSessionJoinRequest that represents this incoming request.

The RemoteSystemSessionJoinRequest that represents this incoming request.

Gets a deferral object for this operation.

A Deferral object that the app uses to signal when it has finished processing this request.

Represents the result of this device's attempt to join a remote session.

Gets the RemoteSystemSession object representing the session that was joined (if the join attempt was successful).

The RemoteSystemSession object representing the session that was joined (if the join attempt was successful). If the attempt failed, this value is **null**.

Represents the success status of this device's attempt to join a remote session.

A RemoteSystemSessionJoinStatus value representing the result.

Contains values which describe the result of this device's attempt to join a remote session.

The join attempt failed for an unknown reason.

The join request was rejected by the device controlling this session.

The join request failed because this device is already a participant in the maximum allowed number of sessions.

The connection to the remote session was lost.

The join attempt was successful.

Handles a dedicated data transfer channel within a remote session. This class owns the functionality for both sending and receiving.

Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session

The RemoteSystemSession to which this messaging channel will correspond. The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App session."

Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session, specifying the reliability type of the channel.

The RemoteSystemSession to which this messaging channel will correspond. The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App messaging channel." A RemoteSystemSessionMessageChannelReliability value describing the reliability type of this channel.

Gets the remote session to which this messaging channel corresponds.

A RemoteSystemSession object representing the remote session.

Raised when a message (in the form of a key-value pair) is received by the channel. The contents of the message are contained by the RemoteSystemSessionValueSetReceivedEventArgs object that is passed in.

Sends a message to all other participants in this remote session messaging channel.

A ValueSet object containing the data to be sent to all participants in the channel. An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**.

Sends a message to a participant in this remote session messaging channel.

A ValueSet object containing the data to be sent to the specified participant. A RemoteSystemSessionParticipant object corresponding to the participant to which the message should be sent. An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**.

Sends a message to a specified set participants in this remote session messaging channel.

A ValueSet object containing the data to be sent to the specified participants. An iterable collection of RemoteSystemSessionParticipant objects corresponding to the participants to which the message should be sent. An asynchronous operation containing a boolean value: **true** if the send operation was a success, otherwise **false**.

Contains values that describe the reliability type of a remote session messaging channel.

The channel is connection-based. Delivery of packets is guaranteed as long as the connection remains open.

The channel is connectionless. Delivery of packets is not guaranteed.

Contains additional options that a RemoteSystemSessionController instance can specify when attempting to create a remote session.

Initializes an instance of the RemoteSystemSessionOptions class.

Indicates whether or not the session described by this RemoteSystemSessionOptions instance should be discoverable by invite only.

A value of **true** if the corresponding session will only be discoverable for systems that receive an invitation, **false** if the session will be publicly discoverable.

Represents a device that is a participant in a remote session. A session can have one or more participants.

Gets the remote system that is a participant in the session.

A RemoteSystem object representing the participant device.

Retrieves a list of host names for this remote session participant that are resolvable by the other remote systems in the session.

A list of HostName objects for the IP/Bluetooth addresses of this remote system.

Contains information about a RemoteSystemSessionParticipantWatcher.Added event, namely the participant that was added to the session.

Gets the participant that was added to the remote session.

A RemoteSystemSessionParticipant object corresponding to the participant added.

Contains information about a RemoteSystemSessionParticipantWatcher.Removed event, namely the participant that was removed from the session.

Gets the participant that was removed from the remote session.

A RemoteSystemSessionParticipant object corresponding to the participant removed.

Handles the discovery and monitoring of remote session participants by raising the appropriate events.

Gets the operational status of this participant watcher.

A RemoteSystemSessionParticipantWatcherStatus value describing the status of the watcher.

Raised when a new participant has been added to the remote session.

Raised after the initial enumeration of participants has completed.

Raised when a participant in the session has been removed.

Starts watching for participants in the remote session. The discovery process runs until the Stop method is called. A RemoteSystemSessionParticipantWatcher object can have its **Start** method called again at a later time.

Stops watching for discoverable session participants.

Contains values that describe the operational status of a participant watcher object.

The watching operation was aborted for an unknown reason.

The watcher has been created but has not yet been started.

The initial enumeration of session participants has completed.

The watcher has started looking for session participants.

The watcher has stopped looking for session participants.

The watcher is in the process of stopping.

Contains information about a RemoteSystemSessionWatcher.Removed event that was raised, namely the remote session that has disappeared.

Gets information about the remote session that disappeared.

A RemoteSystemSessionInfo object describing the remote session that disappeared.

Contains information about a RemoteSystemSessionWatcher.Updated event that was raised, namely the remote session whose information was updated.

Gets information about the remote session that was updated.

A RemoteSystemSessionInfo object describing the remote session that was updated.

Contains information about a RemoteSystemSessionMessageChannel.ValueSetReceived event that was raised, namely the message that was received.

Gets the contents of the message received by the channel.

A ValueSet object containing the data that was received from the channel.

Gets the remote session participant that sent the message to the channel and caused this ValueSetReceived event to be raised.

The RemoteSystemSessionParticipant object corresponding to the sender participant.

Watches for activity related to the discovery of remote sessions and raises the appropriate events.

Gets the operational status of this remote session watcher.

A RemoteSystemSessionWatcherStatus value describing the status of the watcher.

Raised when a new remote session has been discovered by the RemoteSystemSessionWatcher.

Raised when a previously discovered remote session has disappeared.

Raised when a previously discovered remote session has some part of its information updated.

Starts watching for discoverable remote sessions. The discovery process runs until the Stop method is called. A RemoteSystemSessionWatcher object can have its **Start** method called again at a later time.

Stops watching for discoverable remote sessions.

Contains values that describe the operational status of a remote session watcher object.

The watching operation was aborted for an unknown reason.

The watcher has been created but has not yet been started.

The initial enumeration of remote sessions has completed.

The watcher has started looking for remote sessions.

The watcher has stopped looking for remote sessions.

The watcher is in the process of stopping.

Contains the values that describe a remote system's availability status.

The remote system is available.

The availability of the remote system is currently being discovered.

The remote system is unavailable.

The availability of the remote system is unknown.

Contains the values that describe a remote system's status type. This is a simplification of the RemoteSystemStatus enumeration and is used to construct a RemoteSystemStatusTypeFilter object.

The remote system can have any availability status and be discoverable.

The remote system must have a Status property value of **Available** in order to be discoverable.

An IRemoteSystemFilter that limits the set of discoverable remote systems by allowing only those of a specific availability status.

Initializes an instance of the RemoteSystemStatusTypeFilter class.

The status type to target.

The status type that the containing RemoteSystemStatusTypeFilter object targets.

The status type to target.

Gets information about a RemoteSystemUpdated event, namely the RemoteSystem that was updated.

The RemoteSystem object representing the device in the set of discoverable devices whose properties were updated, causing the containing RemoteSystemUpdated event to be raised.

The device updated.

Watches for activity related to the discovery of remote systems and raises the appropriate events.

Represents the User that the RemoteSystemWatcher intends to see devices for.

The User to see devices for.

This event is raised when the initial remote system discovery process completes.

This event is raised when an error occurs during discovery. The discovery process will continue if possible. For example, if the error occurs with a value of **RemoteSystemWatcherError.InternetNotAvailable** (see **RemoteSystemWatcherError **), proximal discovery will continue because the error applies only to cloud discovery (see **RemoteSystemDiscoveryType **).

The event that is raised when a new remote system (device) is discovered.

The event that is raised when a previously discovered remote system (device) is no longer visible.

Raised when a remote system (device) that was previously discovered in this discovery session changes from proximally connected to cloud connected, or the reverse. It is also raised when a remote system changes one of its monitored properties (see the properties of the RemoteSystem class).

Starts watching for discoverable remote systems. The discovery process runs until the Stop method is called or an error occurs. A RemoteSystemWatcher object can have its **Start** method called again at a later time.

Stops watching for discoverable remote systems.

Contains values that describe a watcher error, which may stop discovery.

Discovery of cloud remote systems for a web account failed because authentication of that web account failed.

Discovery of cloud remote systems failed because Internet connection was lost or is unavailable.

Discovery stopped for an unknown reason.

Gets information about an **ErrorOccurred ** event, namely the **RemoteSystemWatcherError ** value describing the error.

The **RemoteSystemWatcherError ** value representing the error that occurred during discovery, causing the containing **ErrorOccurred ** event to be raised.

A **RemoteSystemWatcherError ** value corresponding to the error.

An IRemoteSystemFilter that limits the set of discoverable remote systems by allowing only those which are signed in with a certain web account.

Initializes an instance of the RemoteSystemWebAccountFilter class.

The web account to target.

The web account that the containing RemoteSystemStatusTypeFilter object targets.

The web account to target.

Provides access to the thread pool. See Threading and async programming for detailed guidance on using the thread pool:

Creates a work item.

The method to call when a thread becomes available to run the work item. An IAsyncAction interface that provides access to the work item.

Creates a work item and specifies its priority relative to other work items in the thread pool.

The method to call when a thread becomes available to run the work item. The priority of the work item relative to other work items in the thread pool. The value of this parameter can be **Low**, **Normal**, or **High**. An IAsyncAction interface that provides access to the work item.

Creates a work item, specifies its priority relative to other work items in the thread pool, and specifies how long-running work items should be run.

The method to call when a thread becomes available to run the work item. The priority of the work item relative to other work items in the thread pool. If this parameter is **TimeSliced**, the work item runs simultaneously with other time-sliced work items with each work item receiving a share of processor time. If this parameter is **None**, the work item runs when a worker thread becomes available. An IAsyncAction interface that provides access to the work item.

Represents a timer created with CreateTimer or CreatePeriodicTimer.

Gets the timeout value of a single-use timer created with CreateTimer.

The timeout value. When the timeout value elapses, the timer expires and its TimerElapsedHandler delegate is called.

Gets the timeout value of a periodic timer created with CreatePeriodicTimer.

The timeout value. When the timeout value elapses, the timer expires, its TimerElapsedHandler delegate is called, and the timer reactivates. This behavior continues until the timer is canceled.

Cancels a timer.

Creates a periodic timer.

The method to call when the timer expires. The amount of time until the timer expires. The timer reactivates each time the period elapses, until the timer is canceled. An instance of a periodic timer.

Creates a periodic timer and specifies a method to call after the periodic timer is complete. The periodic timer is complete when the timer has expired without being reactivated, and the final call to *handler* has finished.

The method to call when the timer expires. The amount of time until the timer expires. The timer reactivates each time the period elapses, until the timer is canceled. The method to call after the periodic timer is complete. An instance of a periodic timer.

Creates a single-use timer.

The method to call when the timer expires. The amount of time until the timer expires. An instance of a single-use timer.

Creates a single-use timer and specifies a method to call after the timer is complete. The timer is complete when the timer has expired and the final call to *handler* has finished.

The method to call when the timer expires. The amount of time until the timer expires. The method to call after the timer is complete. An instance of a single-use timer.

Represents a method that is called when a timer created with CreateTimer or CreatePeriodicTimer is complete.

The timer to associate with this method.

Represents a method that is called when a timer created with CreateTimer or CreatePeriodicTimer expires.

The timer to associate with this method. When this timer expires, the method is called.

Represents a method that is called when a work item runs.

The work item to associate with the callback method.

Specifies how work items should be run.

The work item should be run when the thread pool has an available worker thread.

The work items should be run simultaneously with other work items sharing a processor.

Specifies the priority of a work item relative to other work items in the thread pool.

The work item should run at high priority.

The work item should run at low priority.

The work item should run at normal priority. This is the default value.

A preallocated work item is constructed in advance of its submission to the thread pool, ensuring that the work item is constructed so that it can be submitted to the thread pool when necessary. For example, a PreallocatedWorkItem can be created in case it is needed for a resource deallocation routine, since the resource deallocation routine may be called in circumstances when not enough resources would be available to create the work item.

Initializes a new work item with a WorkItemHandler delegate, allocating resources for the work item in advance.

Indicates the method that the preallocated work item will run.

Initializes a new work item with a WorkItemHandler delegate, allocating resources for the work item in advance, and specifies the priority of the work item relative to other work items in the thread pool.

Indicates the method that the preallocated work item will run. The priority of the work item relative to other work items in the thread pool. The value of this parameter can be **Low**, **Normal**, or **High**.

Initializes a new work item with a WorkItemHandler delegate, allocating resources for the work item in advance, and specifies the priority of the work item relative to other work items in the thread pool. Also specifies how the thread pool will allocate processor time for the work item.

Indicates the method that the preallocated work item will run. The priority of the work item relative to other work items in the thread pool. The value of this parameter can be **Low**, **Normal**, or **High**. If this parameter is set to **TimeSliced**, the work item runs simultaneously with other time-sliced work items, with each work item receiving a share of processor time. If this parameter is set to **None**, the work item runs when a worker thread becomes available.

Submits the preallocated work item to the thread pool, without requiring any additional resources to be allocated.

Provides access to the running IAsyncAction that was previously constructed and given the necessary resource allocation.

Represents a method that is called when a signal notifier's attached event or semaphore is signaled, or when the optional timeout value has elapsed (whichever comes first).

Represents the signal notifier that called the delegate. Indicates whether *timeout* value elapsed before calling the delegate.

Runs a method when an event or semaphore is signaled. A timeout value can also be specified, causing the delegate to run after the time span has elapsed if the named event does not occur (or if the semaphore does not reach a signaled state).

Attaches a SignalHandler delegate to an event. The delegated method will run the next time the event occurs.

Indicates the event that causes the method to run. Indicates the method that will run in response to the event. The resulting SignalNotifier object.

Attaches a SignalHandler delegate to an event. The delegated method will run if the event occurs or the time span elapses, whichever comes first.

Indicates the event that causes the method to run. Indicates the method that will run in response to the event, or when the time span elapses, whichever comes first. Indicates the amount of time to continue waiting for the event before running the *handler* method. The resulting SignalNotifier object.

Attaches a SignalHandler delegate to a named semaphore. The delegated method will run when the named semaphore is signaled.

Names the semaphore that signals the method to run. Indicates the delegate that will run in response to the named semaphore entering the signaled state. The resulting SignalNotifier object.

Attaches a SignalHandler delegate to a named semaphore and specifies a timeout value. The delegated method will run when the named semaphore is signaled, or if the time span elapses before the semaphore reaches a signaled state.

Names the semaphore that signals the method to run. Indicates the delegate that will run in response to the named semaphore entering the signaled state. Indicates the amount of time to continue waiting for the named semaphore before running the delegate. The resulting SignalNotifier object.

Submits the SignalNotifier to the thread pool.

Terminates the SignalNotifier if it has not already started running.

Provides a property that lets the caller retrieve the advertising ID.

Retrieves a unique ID used to provide more relevant advertising. If the advertising ID feature is turned off, no ID is retrieved.

The advertising ID is represented as an alphanumeric string. When the advertising ID feature is turned off, this is an empty string.

Gets the advertising ID for the specified user.

The user to get the advertising ID for. An instance of AdvertisingManagerForUser that associates a user ID with their advertising ID.

Associates a user with an advertising ID.

Gets a unique ID used to provide more relevant advertising to a user.

The advertising ID is represented as an alphanumeric string. When the advertising ID feature is turned off, this is an empty string.

Gets the user who is associated with the advertising ID.

The user who is associated with the advertising ID.

Provides properties and methods to access the user's assigned access settings.

Gets a value that indicates whether the user has configured _Assigned Access_ in the Windows settings.

**true** if assigned access is configured; otherwise, **false**.

Gets a value that indicates whether the kiosk account is configured as a single-app kiosk.

**true** if the kiosk account is configured as a single-app kiosk.; otherwise, **false**.

Gets the User associated with this instance of assigned access settings.

The user associated with this instance of assigned access settings.

Retrieves the default assigned access settings.

A settings object that contains the user's current assigned access settings.

Retrieves the assigned access settings for the specified user.

The user to get settings for. A settings object that contains the user's current assigned access settings.

Provides properties and methods to access the user's diagnostics settings.

Gets a value that indicates whether the user has turned on access to diagnostic data for tailored experiences in the Windows *Feedback & diagnostics* settings.

**true** if access to diagnostic data is turned on; otherwise, **false**.

Gets the User associated with this instance of diagnostics settings.

The user associated with this instance of diagnostics settings.

Retrieves the default diagnostics settings.

A settings object that contains the user's current diagnostics settings.

Retrieves the diagnostics settings for the specified user.

The user to get settings for. A settings object that contains the user's current diagnostics settings.

Represents a collection of settings that a user can opt-in to during the first run experience.

Returns the number of elements in the map.

The number of elements in the map.

Returns an iterator for the items in the collection.

The iterator.

Gets the default instance of the settings.

The default instance of the settings.

Determines whether the map view contains the specified key.

The key to locate in the map view. **true** if the key is found; otherwise, **false**.

Returns the item in the map view with the specified key.

The key to locate in the map view. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Splits the map view into two views.

The first part of the original map. The second part of the original map.

A static class for holding various user globalization preferences.

Gets the set of calendars that are preferred by the user, in order of preference.

One or more calendar identifiers for the user's preferred calendars.

Gets the set of clocks that are preferred by the user, in order of preference.

One or more clock identifiers for the user's preferred clocks.

Gets the set of currencies that are preferred by the user, in order of preference.

One or more currency identifiers for the user's preferred currencies.

Gets the user's home geographic region.

The GeographicRegion identifier that represents the user's home location.

Gets the set of languages that are preferred by the user, in order of preference.

One or more language identifiers for the user's preferred languages.

Gets the day of the week that is considered to be the first day of the week.

The day of the week that the week starts on.

Retrieves an object representing the globalization preferences of the specified user. This API is part of support for multi-user apps (MUA).

The user to retrieve preferences for.

Attempts to set the user's home geographic region on an IoT device.

The GeographicRegion identifier that represents the user's home location. **true** if HomeGeographicRegion was set; otherwise, **false**.

Attempts to set the preferred languages on an IoT device.

One or more language identifiers for the user's preferred languages. **true** if Languages was set; otherwise, **false**.

A class for holding the various globalization preferences of a user. This API is part of support for multi-user apps (MUA).

Gets the set of calendars that are preferred by the represented user, in order of preference.

One or more calendar identifiers.

Gets the set of clocks that are preferred by the represented user, in order of preference.

One or more clock identifiers.

Gets the set of currencies that are preferred by the represented user, in order of preference.

One or more currency identifiers.

Gets the represented user's home geographic region.

A geographic region identifier.

Gets the set of languages that are preferred by the represented user, in order of preference.

One or more language identifiers.

Gets the user represented by this class instance.

The represented user.

Gets the day of the week that is considered by the represented user to be the first day of the week.

The day of the week that the week starts on.

Provides properties and methods to manage the user's desktop wallpaper and lock screen background image.

Gets the current instance of UserProfilePersonalizationSettings.

The current instance of UserProfilePersonalizationSettings.

Gets a value that indicates whether changing the desktop and lock screen images is supported on the current device.

**true** if changing the desktop and lock screen images is supported; otherwise, **false**.

Attempts to set the specified image file as the lock screen background image.

The image to set as the lock screen background. The result of the async operation.

Attempts to set the specified image file as the desktop wallpaper image.

The image to set as the desktop background. The result of the async operation.

Describes a color in terms of alpha, red, green, and blue channels.

Gets or sets the **sRGB** alpha channel value of the color.

Gets or sets the **sRGB** blue channel value of the color.

Gets or sets the **sRGB** green channel value of the color.

Gets or sets the **sRGB** red channel value of the color.

Provides static helper methods for processing Color values. C# and Microsoft Visual Basic code should use methods of Color instead.

Generates a Color structure, based on discrete **Byte** values for **ARGB** components. C# and Microsoft Visual Basic code should use **Color.FromArgb** instead.

The **A** (transparency) component of the desired color. Range is 0-255. The **R** component of the desired color. Range is 0-255. The **G** component of the desired color. Range is 0-255. The **B** component of the desired color. Range is 0-255. The generated Color value.

Retrieves the display name of the specified color.

The color to get the name for. The localized display name of the color.

Implements a set of predefined colors. See Color for usage information.

Gets the system-defined color that has an ARGB value of #FFF0F8FF.

The system-defined color that has an ARGB value of #FFF0F8FF.

Gets the system-defined color that has an ARGB value of #FFFAEBD7.

The system-defined color that has an ARGB value of #FFFAEBD7.

Gets the system-defined color that has an ARGB value of #FF00FFFF.

The system-defined color that has an ARGB value of #FF00FFFF.

Gets the system-defined color that has an ARGB value of #FF7FFFD4.

The system-defined color that has an ARGB value of #FF7FFFD4.

Gets the system-defined color that has an ARGB value of #FFF0FFFF.

The system-defined color that has an ARGB value of #FFF0FFFF.

Gets the system-defined color that has an ARGB value of #FFF5F5DC.

The system-defined color that has an ARGB value of #FFF5F5DC.

Gets the system-defined color that has an ARGB value of #FFFFE4C4.

The system-defined color that has an ARGB value of #FFFFE4C4.

Gets the system-defined color that has the ARGB value of #FF000000.

The system-defined color that has the ARGB value of #FF000000.

Gets the system-defined color that has an ARGB value of #FFFFEBCD.

The system-defined color that has an ARGB value of #FFFFEBCD.

Gets the system-defined color that has the ARGB value of #FF0000FF.

The system-defined color that has the ARGB value of #FF0000FF.

Gets the system-defined color that has an ARGB value of #FF8A2BE2.

The system-defined color that has an ARGB value of #FF8A2BE2.

Gets the system-defined color that has the ARGB value of #FFA52A2A.

The system-defined color that has the ARGB value of #FFA52A2A.

Gets the system-defined color that has an ARGB value of #FFDEB887.

The system-defined color that has an ARGB value of #FFDEB887.

Gets the system-defined color that has an ARGB value of #FF5F9EA0.

The system-defined color that has an ARGB value of #FF5F9EA0.

Gets the system-defined color that has an ARGB value of #FF7FFF00.

The system-defined color that has an ARGB value of #FF7FFF00.

Gets the system-defined color that has an ARGB value of #FFD2691E.

The system-defined color that has an ARGB value of #FFD2691E.

Gets the system-defined color that has an ARGB value of #FFFF7F50.

The system-defined color that has an ARGB value of #FFFF7F50.

Gets the system-defined color that has an ARGB value of #FF6495ED.

The system-defined color that has an ARGB value of #FF6495ED.

Gets the system-defined color that has an ARGB value of #FFFFF8DC.

The system-defined color that has an ARGB value of #FFFFF8DC.

Gets the system-defined color that has an ARGB value of #FFDC143C.

The system-defined color that has an ARGB value of #FFDC143C.

Gets the system-defined color that has the ARGB value of #FF00FFFF.

The system-defined color that has the ARGB value of ##FF00FFFF.

Gets the system-defined color that has an ARGB value of #FF00008B.

The system-defined color that has an ARGB value of #FF00008B.

Gets the system-defined color that has an ARGB value of #FF008B8B.

The system-defined color that has an ARGB value of #FF008B8B.

Gets the system-defined color that has an ARGB value of #FFB8860B.

The system-defined color that has an ARGB value of #FFB8860B.

Gets the system-defined color that has the ARGB value of #FFA9A9A9.

The system-defined color that has the ARGB value of #FFA9A9A9.

Gets the system-defined color that has an ARGB value of #FF006400.

The system-defined color that has an ARGB value of #FF006400.

Gets the system-defined color that has an ARGB value of #FFBDB76B.

The system-defined color that has an ARGB value of #FFBDB76B.

Gets the system-defined color that has an ARGB value of #FF8B008B.

The system-defined color that has an ARGB value of #FF8B008B.

Gets the system-defined color that has an ARGB value of #FF556B2F.

The system-defined color that has an ARGB value of #FF556B2F.

Gets the system-defined color that has an ARGB value of #FFFF8C00.

The system-defined color that has an ARGB value of #FFFF8C00.

Gets the system-defined color that has an ARGB value of #FF9932CC.

The system-defined color that has an ARGB value of #FF9932CC.

Gets the system-defined color that has an ARGB value of #FF8B0000.

The system-defined color that has an ARGB value of #FF8B0000.

Gets the system-defined color that has an ARGB value of #FFE9967A.

The system-defined color that has an ARGB value of #FFE9967A.

Gets the system-defined color that has an ARGB value of #FF8FBC8F.

The system-defined color that has an ARGB value of #FF8FBC8F.

Gets the system-defined color that has an ARGB value of #FF483D8B.

The system-defined color that has an ARGB value of #FF483D8B.

Gets the system-defined color that has an ARGB value of #FF2F4F4F.

The system-defined color that has an ARGB value of #FF2F4F4F.

Gets the system-defined color that has an ARGB value of #FF00CED1.

The system-defined color that has an ARGB value of #FF00CED1.

Gets the system-defined color that has an ARGB value of #FF9400D3.

The system-defined color that has an ARGB value of #FF9400D3.

Gets the system-defined color that has an ARGB value of #FFFF1493.

The system-defined color that has an ARGB value of #FFFF1493.

Gets the system-defined color that has an ARGB value of #FF00BFFF.

The system-defined color that has an ARGB value of #FF00BFFF.

Gets the system-defined color that has an ARGB value of #FF696969.

The system-defined color that has an ARGB value of #FF696969.

Gets the system-defined color that has an ARGB value of #FF1E90FF.

The system-defined color that has an ARGB value of #FF1E90FF.

Gets the system-defined color that has an ARGB value of #FFB22222.

The system-defined color that has an ARGB value of #FFB22222.

Gets the system-defined color that has an ARGB value of #FFFFFAF0.

The system-defined color that has an ARGB value of #FFFFFAF0.

Gets the system-defined color that has an ARGB value of #FF228B22.

The system-defined color that has an ARGB value of #FF228B22.

Gets the system-defined color that has an ARGB value of #FFFF00FF.

The system-defined color that has an ARGB value of #FFFF00FF.

Gets the system-defined color that has an ARGB value of #FFDCDCDC.

The system-defined color that has an ARGB value of #FFDCDCDC.

Gets the system-defined color that has an ARGB value of #FFF8F8FF.

The system-defined color that has an ARGB value of #FFF8F8FF.

Gets the system-defined color that has an ARGB value of #FFFFD700.

The system-defined color that has an ARGB value of #FFFFD700.

Gets the system-defined color that has an ARGB value of #FFDAA520.

The system-defined color that has an ARGB value of #FFDAA520.

Gets the system-defined color that has the ARGB value of #FF808080.

The system-defined color that has the ARGB value of #FF808080.

Gets the system-defined color that has the ARGB value of #FF008000.

The system-defined color that has the ARGB value of #FF008000.

Gets the system-defined color that has an ARGB value of #FFADFF2F.

The system-defined color that has an ARGB value of #FFADFF2F.

Gets the system-defined color that has an ARGB value of #FFF0FFF0.

The system-defined color that has an ARGB value of #FFF0FFF0.

Gets the system-defined color that has an ARGB value of #FFFF69B4.

The system-defined color that has an ARGB value of #FFFF69B4.

Gets the system-defined color that has an ARGB value of #FFCD5C5C.

The system-defined color that has an ARGB value of #FFCD5C5C.

Gets the system-defined color that has an ARGB value of #FF4B0082.

The system-defined color that has an ARGB value of #FF4B0082.

Gets the system-defined color that has an ARGB value of #FFFFFFF0.

The system-defined color that has an ARGB value of #FFFFFFF0.

Gets the system-defined color that has an ARGB value of #FFF0E68C.

The system-defined color that has an ARGB value of #FFF0E68C.

Gets the system-defined color that has an ARGB value of #FFE6E6FA.

The system-defined color that has an ARGB value of #FFE6E6FA.

Gets the system-defined color that has an ARGB value of #FFFFF0F5.

The system-defined color that has an ARGB value of #FFFFF0F5.

Gets the system-defined color that has an ARGB value of #FF7CFC00.

The system-defined color that has an ARGB value of #FF7CFC00.

Gets the system-defined color that has an ARGB value of #FFFFFACD.

The system-defined color that has an ARGB value of #FFFFFACD.

Gets the system-defined color that has an ARGB value of #FFADD8E6.

The system-defined color that has an ARGB value of #FFADD8E6.

Gets the system-defined color that has an ARGB value of #FFF08080.

The system-defined color that has an ARGB value of #FFF08080.

Gets the system-defined color that has an ARGB value of #FFE0FFFF.

The system-defined color that has an ARGB value of #FFE0FFFF.

Gets the system-defined color that has an ARGB value of #FFFAFAD2.

The system-defined color that has an ARGB value of #FFFAFAD2.

Gets the system-defined color that has the ARGB value of #FFD3D3D3.

The system-defined color that has the ARGB value of #FFD3D3D3.

Gets the system-defined color that has an ARGB value of #FF90EE90.

The system-defined color that has an ARGB value of #FF90EE90.

Gets the system-defined color that has an ARGB value of #FFFFB6C1.

The system-defined color that has an ARGB value of #FFFFB6C1.

Gets the system-defined color that has an ARGB value of #FFFFA07A.

The system-defined color that has an ARGB value of #FFFFA07A.

Gets the system-defined color that has an ARGB value of #FF20B2AA.

The system-defined color that has an ARGB value of #FF20B2AA.

Gets the system-defined color that has an ARGB value of #FF87CEFA.

The system-defined color that has an ARGB value of #FF87CEFA.

Gets the system-defined color that has an ARGB value of #FF778899.

The system-defined color that has an ARGB value of #FF778899.

Gets the system-defined color that has an ARGB value of #FFB0C4DE.

The system-defined color that has an ARGB value of #FFB0C4DE.

Gets the system-defined color that has an ARGB value of #FFFFFFE0.

The system-defined color that has an ARGB value of #FFFFFFE0.

Gets the system-defined color that has an ARGB value of #FF00FF00.

The system-defined color that has an ARGB value of #FF00FF00.

Gets the system-defined color that has an ARGB value of #FF32CD32.

The system-defined color that has an ARGB value of #FF32CD32.

Gets the system-defined color that has an ARGB value of #FFFAF0E6.

The system-defined color that has an ARGB value of #FFFAF0E6.

Gets the system-defined color that has the ARGB value of #FFFF00FF.

The system-defined color that has the ARGB value of #FFFF00FF.

Gets the system-defined color that has an ARGB value of #FF800000.

The system-defined color that has an ARGB value of #FF800000.

Gets the system-defined color that has an ARGB value of #FF66CDAA.

The system-defined color that has an ARGB value of #FF66CDAA.

Gets the system-defined color that has an ARGB value of #FF0000CD.

The system-defined color that has an ARGB value of #FF0000CD.

Gets the system-defined color that has an ARGB value of #FFBA55D3.

The system-defined color that has an ARGB value of #FFBA55D3.

Gets the system-defined color that has an ARGB value of #FF9370DB.

The system-defined color that has an ARGB value of #FF9370DB.

Gets the system-defined color that has an ARGB value of #FF3CB371.

The system-defined color that has an ARGB value of #FF3CB371.

Gets the system-defined color that has an ARGB value of #FF7B68EE.

The system-defined color that has an ARGB value of #FF7B68EE.

Gets the system-defined color that has an ARGB value of #FF00FA9A.

The system-defined color that has an ARGB value of #FF00FA9A.

Gets the system-defined color that has an ARGB value of #FF48D1CC.

The system-defined color that has an ARGB value of #FF48D1CC.

Gets the system-defined color that has an ARGB value of #FFC71585.

The system-defined color that has an ARGB value of #FFC71585.

Gets the system-defined color that has an ARGB value of #FF191970.

The system-defined color that has an ARGB value of #FF191970.

Gets the system-defined color that has an ARGB value of #FFF5FFFA.

The system-defined color that has an ARGB value of #FFF5FFFA.

Gets the system-defined color that has an ARGB value of #FFFFE4E1.

The system-defined color that has an ARGB value of #FFFFE4E1.

Gets the system-defined color that has an ARGB value of #FFFFE4B5.

The system-defined color that has an ARGB value of #FFFFE4B5.

Gets the system-defined color that has an ARGB value of #FFFFDEAD.

The system-defined color that has an ARGB value of #FFFFDEAD.

Gets the system-defined color that has an ARGB value of #FF000080.

The system-defined color that has an ARGB value of #FF000080.

Gets the system-defined color that has an ARGB value of #FFFDF5E6.

The system-defined color that has an ARGB value of #FFFDF5E6.

Gets the system-defined color that has an ARGB value of #FF808000.

The system-defined color that has an ARGB value of #FF808000.

Gets the system-defined color that has an ARGB value of #FF6B8E23.

The system-defined color that has an ARGB value of #FF6B8E23.

Gets the system-defined color that has the ARGB value of #FFFFA500.

The system-defined color that has the ARGB value of #FFFFA500.

Gets the system-defined color that has an ARGB value of #FFFF4500.

The system-defined color that has an ARGB value of #FFFF4500.

Gets the system-defined color that has an ARGB value of #FFDA70D6.

The system-defined color that has an ARGB value of #FFDA70D6.

Gets the system-defined color that has an ARGB value of #FFEEE8AA.

The system-defined color that has an ARGB value of #FFEEE8AA.

Gets the system-defined color that has an ARGB value of #FF98FB98.

The system-defined color that has an ARGB value of #FF98FB98.

Gets the system-defined color that has an ARGB value of #FFAFEEEE.

The system-defined color that has an ARGB value of #FFAFEEEE.

Gets the system-defined color that has an ARGB value of #FFDB7093.

The system-defined color that has an ARGB value of #FFDB7093.

Gets the system-defined color that has an ARGB value of #FFFFEFD5.

The system-defined color that has an ARGB value of #FFFFEFD5.

Gets the system-defined color that has an ARGB value of #FFFFDAB9.

The system-defined color that has an ARGB value of #FFFFDAB9.

Gets the system-defined color that has an ARGB value of #FFCD853F.

The system-defined color that has an ARGB value of #FFCD853F.

Gets the system-defined color that has an ARGB value of #FFFFC0CB.

The system-defined color that has an ARGB value of #FFFFC0CB.

Gets the system-defined color that has an ARGB value of #FFDDA0DD.

The system-defined color that has an ARGB value of #FFDDA0DD.

Gets the system-defined color that has an ARGB value of #FFB0E0E6.

The system-defined color that has an ARGB value of #FFB0E0E6.

Gets the system-defined color that has the ARGB value of #FF800080.

The system-defined color that has the ARGB value of #FF800080.

Gets the system-defined color that has the ARGB value of #FFFF0000.

The system-defined color that has the ARGB value of #FFFF0000.

Gets the system-defined color that has an ARGB value of #FFBC8F8F.

The system-defined color that has an ARGB value of #FFBC8F8F.

Gets the system-defined color that has an ARGB value of #FF4169E1.

The system-defined color that has an ARGB value of #FF4169E1.

Gets the system-defined color that has an ARGB value of #FF8B4513.

The system-defined color that has an ARGB value of #FF8B4513.

Gets the system-defined color that has an ARGB value of #FFFA8072.

The system-defined color that has an ARGB value of #FFFA8072.

Gets the system-defined color that has an ARGB value of #FFF4A460.

The system-defined color that has an ARGB value of #FFF4A460.

Gets the system-defined color that has an ARGB value of #FF2E8B57.

The system-defined color that has an ARGB value of #FF2E8B57.

Gets the system-defined color that has an ARGB value of #FFFFF5EE.

The system-defined color that has an ARGB value of #FFFFF5EE.

Gets the system-defined color that has an ARGB value of #FFA0522D.

The system-defined color that has an ARGB value of #FFA0522D.

Gets the system-defined color that has an ARGB value of #FFC0C0C0.

The system-defined color that has an ARGB value of #FFC0C0C0.

Gets the system-defined color that has an ARGB value of #FF87CEEB.

The system-defined color that has an ARGB value of #FF87CEEB.

Gets the system-defined color that has an ARGB value of #FF6A5ACD.

The system-defined color that has an ARGB value of #FF6A5ACD.

Gets the system-defined color that has an ARGB value of #FF708090.

The system-defined color that has an ARGB value of #FF708090.

Gets the system-defined color that has an ARGB value of #FFFFFAFA.

The system-defined color that has an ARGB value of #FFFFFAFA.

Gets the system-defined color that has an ARGB value of #FF00FF7F.

The system-defined color that has an ARGB value of #FF00FF7F.

Gets the system-defined color that has an ARGB value of #FF4682B4.

The system-defined color that has an ARGB value of #FF4682B4.

Gets the system-defined color that has an ARGB value of #FFD2B48C.

The system-defined color that has an ARGB value of #FFD2B48C.

Gets the system-defined color that has an ARGB value of #FF008080.

The system-defined color that has an ARGB value of #FF008080.

Gets the system-defined color that has an ARGB value of #FFD8BFD8.

The system-defined color that has an ARGB value of #FFD8BFD8.

Gets the system-defined color that has an ARGB value of #FFFF6347.

The system-defined color that has an ARGB value of #FFFF6347.

Gets the system-defined color that has the ARGB value of #00FFFFFF.

The system-defined color that has the ARGB value of #00FFFFFF.

Gets the system-defined color that has an ARGB value of #FF40E0D0.

The system-defined color that has an ARGB value of #FF40E0D0.

Gets the system-defined color that has an ARGB value of #FFEE82EE.

The system-defined color that has an ARGB value of #FFEE82EE.

Gets the system-defined color that has an ARGB value of #FFF5DEB3.

The system-defined color that has an ARGB value of #FFF5DEB3.

Gets the system-defined color that has the ARGB value of #FFFFFFFF.

The system-defined color that has the ARGB value of #FFFFFFFF.

Gets the system-defined color that has an ARGB value of #FFF5F5F5.

The system-defined color that has an ARGB value of #FFF5F5F5.

Gets the system-defined color that has the ARGB value of #FFFFFF00.

The system-defined color that has the ARGB value of #FFFFFF00.

Gets the system-defined color that has an ARGB value of #FF9ACD32.

The system-defined color that has an ARGB value of #FF9ACD32.

Represents the root of a UI element tree for an app window or view.

Gets the context identifier for the content root.

The context identifier for the content root.

Represents an identifier for an app window or view.

Contains event data for the ScreenReaderPositionChanged event of a ScreenReaderService.

Gets whether a screen reader is currently reading a block of text.

True if the screen reader is reading text; otherwise, false.

Gets a rectangle corresponding to the new location of the screen reader focus indicator (such as the Narrator focus highlight box).

The physical screen coordinates of the upper left corner of the screen reader focus indicator, and its height and width, in pixels.

Provides properties and events associated with a screen reader device.

Initializes a new instance of the ScreenReaderService class.

Gets both the rectangle corresponding to the current position of the screen reader focus indicator (such as the Narrator focus highlight box) and whether the screen reader is in continuous reading mode.

An object that provides:

Occurs when the location of the screen reader focus indicator (such as the Narrator focus highlight box) changes.

Provides methods to show the accounts pane and also to enable the app to register callbacks when the accounts flyout is about to be displayed.

Occurs when the user opens the accounts pane. Handling this event lets the app initialize the accounts commands and pause its UI until the user closes the pane.

Gets an AccountsSettingsPane object that is associated with the current app view (that is, with CoreWindow ).

The account settings pane.

Displays the account settings pane.

Displays the add accounts screen.

Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is **void**.

Displays the add accounts screen for the specified user.

The user who will add an account. Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is **void**.

Displays the manage accounts screen.

Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is **void**.

Displays the manage accounts screen for the specified user.

The user whose accounts will be accessed. Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is **void**.

Provides data for the AccountCommandsRequested event.

Gets the SettingsCommand collection for the account settings pane.

The settings commands.

Gets the CredentialCommand collection for the account settings pane.

The credential commands.

Gets or sets the header text for the account settings pane.

The header text.

Gets the user for the account settings pane.

The user to whom the account settings apply.

Gets the WebAccountCommand collection for the account settings pane.

The web account collection.

Gets the WebAccountProviderCommand collection for the account settings pane.

The web account provider command collection.

Gets the deferral object for the AccountCommandsRequested event.

The deferral object.

Enables the app to signal when it has finished populating command collections while handling the AccountCommandsRequested event.

Signals that the app has finished populating command collections while handling the AccountCommandsRequested event.

Deprecated. Represents a command for changing web account credentials in the account settings pane.

Initializes a new instance of the CredentialCommand class with a PasswordCredential object.

The password credential.

Initializes a new instance of the CredentialCommand class with a PasswordCredential object and a CredentialCommandCredentialDeletedHandler delegate.

The password credential. The delegate that handles credential deletion.

Gets the delegate that's invoked by the account settings pane when the user deletes a credential.

The delegate that handles credential deletion.

Gets the password credential that the current command applies to.

The password credential.

Represents the method that's invoked by the account settings pane when the user deletes a credential.

The credential command that corresponds with the delegate.

Creates a settings command object that represents a settings entry. This settings command can be appended to the ApplicationCommands vector.

Creates a new settings command.

The ID of the command. The label for the command, which is displayed in the settings pane. The event handler that is called when the user selects this command in the settings pane.

Gets the command for a web account in the account settings pane.

The command.

Gets or sets the command ID.

The command ID.

Gets or sets the handler for the event that is raised when the user selects the command.

The event handler associated with the command.

Gets or sets the label for the command.

The label for the command.

Specifies actions that your app enables on an web account instance in the account settings pane.

The app displays UI for managing the web account.

The app does a custom action with the web account.

No action.

The app attempts to connect to the web account.

The app removes the web account from the account settings pane.

The app displays details about the web account.

Specifies actions that your app does on an web account.

The app displays UI for managing the web account.

The app does a custom action with the web account.

The app attempts to connect to the web account.

The app removes the web account from the account settings pane.

The app displays details about the web account.

Associates a command with a WebAccount in the account settings pane..

Initializes a new instance of the WebAccountCommand class.

The web account to associate with the current command. The delegate that handles the command. A bitmask of web account actions.

Gets the actions that the command performs on the web account in the accounts pane.

The actions for the web account.

Gets the delegate that's invoked when the user selects an account and a specific action in the account settings pane.

The handler.

Gets the web account that's associated with the current command.

The web account.

Represents the method that's invoked when the user selects an account and a specific action in the account settings pane.

The command that's done against the web account in the accounts pane. The data for the command.

Provides data for the WebAccountCommandInvokedHandler delegate.

Gets the action for the web account in the accounts pane.

The action.

Associates a provider command with a WebAccountProvider in the account settings pane.

Initializes a new instance of the WebAccountProviderCommand class.

The web account provider. The delegate that handles the provider command.

Gets the delegate that's invoked when the user selects an account and a specific action in the accounts pane.

The handler.

Gets the web account provider that's associated with the current command.

The web account provider.

Represents the method that's invoked when the user selects an account and a specific action in the account settings pane.

The provider command that's done against the web account in the accounts pane.

A light that illuminates every targeted Visual equally.

Color of the light. Animatable.

The color of the ambient light.

Gets or sets the intensity of the light.

The intensity of the light.

Provides playback controls for a KeyFrameAnimation.

Gets the maximum allowed playback rate.

The maximum allowed playback rate.

Gets the minimum allowed playback rate.

The minimum allowed playback rate.

Gets or sets the rate at which the animation plays.

The rate at which the animation plays. The default is 1.0.

Gets or sets a value that indicates the current playback position of the animation.

The current playback position of the animation.

Gets or sets a value that indicates how progress is determined.

A value of the enumeration that indicates how progress is determined. The default is **Default**.

Pauses playback of the animation.

Starts playback of an animation that was previously paused.

Defines constants that specify how the AnimationController.Progress value is determined.

The progress value does not include delay time.

The progress value includes delay time.

Specifies the animation delay behavior.

Does not compute anything in animation nor holds the value of composition object property. If a DelayTime is specified, it delays starting the animation according to delay time and after delay has expired it applies animation to the object property.

Applies the initial value of the animation (i.e. the value at Keyframe 0) to the object before the delay time is elapsed (when there is a DelayTime specified), it then delays starting the animation according to the DelayTime.

Specifies the play direction of an animation.

Alternate between normal and reverse playback.

Alternate between reverse and normal playback.

Play the animation from start to end.

Play the animation in reverse from end to start.

Specifies if the animation should loop.

The animation should loop the specified number of times.

The animation should loop forever.

Defines constants that specify how an animated property can be accessed.

The property cannot be accessed.

The property can only be read.

The property can be read or written to.

The property can only be written to.

Represents information about a property that can be animated.

Gets or sets a value that specifies how an animated property can be accessed.

A value of the enumeration that specifies how an animated property can be accessed.

Specifies the behavior of an animation when it stops.

Leave the animation at its current value.

Set the animation to its final value.

Reset the animation to its initial value.

A time-based animation that targets a Boolean property with one or more key frames.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

A bounce physics-based animation that targets any Scalar-based property.

Gets or sets the rate at which the velocity increases.

The rate at which the velocity increases.

Gets or sets the amount that an object rebounds after collision.

The amount that an object rebounds after collision.

A bounce physics-based animation that targets any Vector2-based property.

Gets or sets the rate at which the velocity increases.

The rate at which the velocity increases.

Gets or sets the amount that an object rebounds after collision.

The amount that an object rebounds after collision.

A bounce physics-based animation that targets any Vector3-based property.

Gets or sets the rate at which the velocity increases.

The rate at which the velocity increases.

Gets or sets the amount that an object rebounds after collision.

The amount that an object rebounds after collision.

A time-based animation that targets the Color property with one or more color key frames.

The color space the color interpolation should run through.

The color space the color interpolation should run through.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a key frame with the specified easing function.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use to interpolate between key frames.

Represents the base animation class.

Gets the initial values for the animation.

The initial values for the animation.

The target of the animation.

The target of the animation.

Clears all of the parameters of the animation.

Clears a parameter from the animation.

The parameter to clear.

Sets a boolean value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The boolean value.

Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Color value.

Sets an IAnimationObject value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The source object.

Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Matrix3x2 value.

Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Matrix4x4 value.

Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The quaternion value.

Sets a reference to a Composition object for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The name can be used to reference the parameter in the ExpressionAnimation. The CompositionObject value.

Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Single value.

Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Vector2 value.

Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter to set. The Vector3 value.

Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe.

The name of the parameter. The Vector4 value.

Defines a group of animations.

The number of animations in the group.

The number of animations in the group.

Adds an animation to the animation group.

The animation to add to the group.

Retrieves the first animation in the group.

Returns the first animation in the group.

Removes an animation from the animation group.

The animation to remove from the group.

Removes all animations from the group.

A brush that applies an effect (or a chain of effects) to the region behind a SpriteVisual.

Specifies whether the back face of a visual is visible during a 3D transform.

The back face should not be visible during a 3D transform.

Inherit the back face visibility value.

The back face should be visible during a 3D transform.

Arguments for the CompositionCommitBatch.Completed or CompositionScopedBatch.Completed events.

Batch types for CompositionCommitBatch and CompositionScopedBatch.

The batch contains animations.

The batch contains effects.

None.

Specifies the algorithm used for interpolating pixels from ICompositionSurface when they do not form a one-to-one mapping to pixels on screen.

Interpolate a color from the four bitmap pixels that are the nearest to the current rendering pixel.

Use the exact color of the nearest bitmap pixel to the current rendering pixel.

Controls the aliasing behavior on the edges of visual borders.

Bitmap and clip edges are aliased.

Inherit from parent.

Bitmap and clip edges are antialiased.

Base class for brushes used to paint a SpriteVisual.

Provides the ability to check system hardware capabilities so that Visual Layer Effects may be scaled accordingly. This allows you to ensure that your application's use of rendering-intensive operations is tailored to match the device's capabilities, providing optimum performance and pleasant visual results.

Event triggered when the supported composition capabilities changes.

Indicates whether fast effects are supported.

Returns a boolean indicating whether fast effects are supported.

Indicates whether effects are supported.

Returns a boolean indicating whether effects are supported.

Gets the supported composition capabilities for the current view.

Returns the supported composition capabilities for the current view.

Base class for clipping objects such as InsetClip.

The point on the clip to be positioned at the clip's offset. Value is normalized with respect to the size of the clip.

The point on the clip to be positioned at the clip's offset. Value is normalized with respect to the size of the clip. An AnchorPoint value of (0, 0) refers to the top-left corner of the untransformed clip and a value of (1, 1) refers to the bottom-right corner. Negative values and values greater than one are accepted but will result in an AnchorPoint that is outside the boundaries of the original, untransformed clip.

The point about which rotation or scaling occurs.

The point about which rotation or scaling occurs. Value is in pixels within the local coordinate space of the visual on which the clip is applied.

The offset of the clip relative to the visual on which the clip is applied.

The offset of the clip relative to the visual on which the clip is applied. By default, the Offset value on a clip is (0, 0).

The angle of rotation applied to the clip, in radians.

The angle of rotation applied to the clip, in radians. For a CompositionClip, the axis of rotation is always about the z-axis, with positive RotationAngle values resulting in a clockwise rotation and negative values resulting in a counter-clockwise rotation. For specifying RotationAngle in degrees, use CompositionClip.RotationAngleInDegrees.

The angle of rotation applied to the clip, in degrees.

The angle of rotation applied to the clip, in degrees. For a CompositionClip, the axis of rotation is always about the z-axis, with positive RotationAngleInDegrees values resulting in a clockwise rotation and negative values resulting in a counter-clockwise rotation. For specifying RotationAngle in radians, use CompositionClip.RotationAngle.

The scale to apply to the clip.

The scale to apply to the clip. The scale value is a multiplier of the clip's size. By default, the Scale value on a clip is (1, 1).

The 3x2 transformation matrix to apply to the clip.

The transformation matrix to apply to the clip. By default, the TransformMatrix is set to:

Paints a SpriteVisual with a solid color.

The color used to fill a SpriteVisual. Animatable.

The color used to fill a SpriteVisual.

Describes the location and color of a transition point in a gradient.

Gets or sets the color of the gradient stop.

The color of the gradient stop. The default is Transparent.

Gets or sets the location of the gradient stop within the gradient vector.

The relative location of this gradient stop along the gradient vector. The default is 0.

Represents a collection of CompositionColorGradientStop objects that can be individually accessed by index.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The CompositionColorGradientStop value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the CompositionColorGradientStop value specified.

The index at which to set the value. The value to set.

Specifies the color space for interpolating color values in ColorKeyFrameAnimation.

Use the default color space for interpolation.

Use the HSL color space for interpolation.

Use the ARGB color space for interpolation.

A group of active animations or effects.

Indicates whether the CompositionCommitBatch is currently opened for objects to be aggregated.

Boolean indicating whether the CompositionCommitBatch is currently opened for objects to be aggregated.

Indicates whether the CompositionCommitBatch has been closed and can no longer accept changes.

Boolean indicating whether the CompositionCommitBatch has been closed and can no longer accept changes.

Event that is triggered when all objects in a CompositionCommitBatch have completed.

Determines how a non-opaque visual's content is blended with the background content behind the visual.

The visual content's colors are inverted.

Inherits mode from parent visual.

Visual content's colors subtract for color channels in the background.

The standard Composite Mode. Colors are blended with per-pixel transparency.

Represents a container for CompositionShapes, used to group items that share 2D transforms.

Gets the collection of CompostionShapes in this container.

The collection of CompostionShapes in this container.

A drawing surface for interoperation with Direct2D or Direct3D.

The alpha mode of the drawing surface.

The alpha mode of the drawing surface.

The pixel format of the drawing surface.

The pixel format of the drawing surface.

The size of the drawing surface.

The size of the drawing surface.

The size of the drawing surface.

The size of the drawing surface.

Resizes the drawing surface to the specified size.

The new size in pixels for the drawing surface.

Scrolls the drawing surface.

The scrolling offset.

Scrolls the drawing surface.

The scrolling offset. The scrolling rectangle.

Scrolls the drawing surface using the specified clip rectangle.

The scrolling offset. The clipping rectangle to apply.

Scrolls the drawing surface with the specified clip rectangle.

The scrolling offset. The clipping rectangle to apply. The scrolling rectangle.

Specifies the masking policy for a shadow.

Shadow defaults to rectangular shape or the mask provided.

Shadow uses a mask using the alpha value of the visual's brush.

Base class for interpolator functions to use with KeyFrameAnimations.

Paints a SpriteVisual with the output of a filter effect. The filter effect description is defined using the CompositionEffectFactory class.

Retrieves a CompositionBrush associated with a given CompositionEffectSourceParameter name.

The name of the input. Returns the specified input.

Associates a name declared using CompositionEffectSourceParameter to an effect source.

The name of the source parameter. The source to pass to the effect.

Creates a composition object that contains a Win2D effect description format in the Microsoft.Graphics.Canvas.Effects namespace.

An extended error code for the result of a call to CreateBrush.

An extended error code for the result of a call to CreateBrush.

The load status of a CreateBrush call.

The load status of a CreateBrush call.

Creates an instance of CompositionEffectBrush with the effect definition and animatable properties contained in the CompositionEffectFactory object.

Returns the created CompositionEffectBrush object.

The status of the asynchronous compilation of a shader for an effect description.

The effect was too complex.

Other error.

The operation is still pending.

The operation was successful.

Used to declare an arbitrary name (a String) to be associated with a CompositionBrush (the “effect source”). The association of the given name and the effect source occurs when the SetSourceParameter method of a CompositionEffectBrush is called.

Creates an instance of CompositionEffectSourceParameter.

The name for the CompositionEffectSourceParameter instance.

The name associated with the effect source.

The name associated with the effect source.

Represents an ellipse with the specified center and radius.

Gets or sets the center point of the ellipse.

The center point of the ellipse.

Gets or sets the radius of the ellipse.

The radius of the ellipse.

Clips a portion of a visual. The visible portion of the visual is a shape defined by a CompositionGeometry. The portion of the visual outside the geometry is clipped.

Gets or sets CompositionGeometry that defines the shape of the clip.

A CompositionGeometry that defines the shape of the clip. The default is **null**.

Gets or sets a CompositionViewBox that maps the shape visual tree coordinates onto the visual.

A CompositionViewBox that maps the shape visual tree coordinates onto the visual.

Represents the base class for composition geometries.

Gets or sets the amount to trim the end of the geometry path.

The amount to trim the end of the geometry path. The default is 0.

Gets or sets the amount to offset trimming the geometry path.

The amount to offset trimming the geometry path. The default is 0.

Gets or sets the amount to trim the start of the geometry path.

The amount to trim the start of the geometry path. The default is 0.

Indicates the outcome of an attempt to retrieve the value of a key-value pair.

The key-value pair does not exist.

The value successfully retrieved.

The value type of the key-value pair is different than the value type requested.

Represents a brush that describes a gradient, composed of gradient stops.

Gets or sets the point on the brush to be positioned at the brush's offset.

The point on the brush to be positioned at the brush's offset.

Gets or sets the point about which the brush is rotated and scaled.

The point about which the brush is rotated and scaled.

Gets the brush's gradient stops.

A collection of the CompositionColorGradientStop objects associated with the brush, each of which specifies a color and an offset along the brush's gradient axis. The default is an empty CompositionColorGradientStopCollection.

Gets or sets a value that specifies how to draw the gradient outside the brush's gradient vector or space.

The mode used to paint the gradient.

Gets or sets a value that specifies how the gradient's colors are interpolated.

A value of the enumeration that specifies how the gradient's colors are interpolated.

Gets or sets a value that indicates whether the gradient brush's positioning coordinates (StartPoint, EndPoint) are absolute or relative to the output area.

A value of the enumeration that indicates whether the gradient brush's positioning coordinates (StartPoint, EndPoint) are absolute or relative to the output area.

Gets or sets the offset of the brush relative to the object being painted.

The offset of the brush relative to the object being painted.

Gets or sets the rotation angle of the brush in radians.

The rotation angle of the brush in radians.

Gets or sets the rotation angle of the brush in degrees.

The rotation angle of the brush in degrees.

Gets or sets the scale to apply to the brush.

The scale to apply to the brush.

Gets or sets the matrix of transforms to apply to the brush.

The matrix of transforms to apply to the brush.

Defines constants that specify how to draw the gradient outside the brush's gradient vector or space.

The gradient is not extended.

The gradient is repeated in the reverse direction..

The gradient is wrapped.

Used to create all hardware bound resources for a given DirectX device on a compositor session. CompositionGraphicsDevice contains a DirectX device that is used to perform the GPU operations. Developers can obtain a Graphics device from the compositor top level object.

Event triggered when the rendering device has been replaced.

Creates an instance of CompositionDrawingSurface.

The size in pixels of the surface. The pixel format of the surface. How the alpha channel should be handled. The created CompositionDrawingSurface.

Creates an instance of CompositionDrawingSurface.

The size of the drawing surface in pixels. The pixel format of the drawing surface. The alpha mode of the drawing surface. Returns the created CompositionDrawingSurface.

Creates an instance of CompositionMipMapSurface.

The size in pixels of the surface. The pixel format of the surface. How the alpha channel should be handled. The created CompositionMipMapSurface.

Creates an instance of CompositionVirtualDrawingSurface.

The size in pixels of the drawing surface. The pixel format of the drawing surface. The alpha mode of the drawing surface. Returns the created CompositionVirtualDrawingSurface.

Trims any graphics memory allocated by the graphics device on the app's behalf.

Base class for a light source that can target a UI scene.

Gets a collection of Visuals that are not targeted by the light.

The collection of Visuals that are not targeted by the light.

Gets or sets a value that determines whether the composition light is on.

**true** if the light is on; otherwise, **false**. The default is **true**.

The collection of Visuals targeted by the light.

The collection of Visuals targeted by the light.

Represents a brush that paints an area with a linear gradient.

Gets or sets the ending two-dimensional coordinates of the linear gradient.

The ending two-dimensional coordinates of the linear gradient.

Gets or sets the starting two-dimensional coordinates of the linear gradient.

The starting two-dimensional coordinates for the linear gradient.

Represents a straight line between two points.

Gets or sets the end point of the line.

The end point of the line.

Gets or sets the starting point of the line.

The starting point of the line.

Defines constants that specify whether the gradient brush's positioning coordinates (StartPoint, EndPoint) are absolute or relative to the output area.

Positioning coordinates (StartPoint, EndPoint) are absolute.

Positioning coordinates (StartPoint, EndPoint) are relative to the output area.

Paints a SpriteVisual with a CompositionBrush with an opacity mask applied to it. The source of the opacity mask can be any CompositionBrush of type CompositionColorBrush, CompositionLinearGradientBrush, CompositionSurfaceBrush, CompositionEffectBrush or a CompositionNineGridBrush. The opacity mask must be specified as a CompositionSurfaceBrush.

A brush that contains the opacity mask with which the Source brush's content is to be masked. Can be of type CompositionSurfaceBrush or CompositionNineGridBrush.

A brush that contains the opacity mask with which the Source brush's content is to be masked. Can be of type CompositionSurfaceBrush or CompositionNineGridBrush.

A brush whose content is to be masked by the opacity mask. Can be of type CompositionSurfaceBrush, CompositionColorBrush, or CompositionNineGridBrush.

A brush whose content is to be masked by the opacity mask. Can be of type CompositionSurfaceBrush, CompositionColorBrush, or CompositionNineGridBrush.

Represents a drawing surface for mipmap textures.

Gets the alpha mode of the mipmap surface.

The alpha mode of the mipmap surface.

Gets the number of texture levels in the mipmap.

The number of texture levels in the mipmap.

Gets the pixel format of the mipmap surface.

The pixel format of the mipmap surface.

Gets the size of the mipmap surface.

The size of the mipmap surface.

Retrieves the texture at the specified level of the mipmap.

The level from which to retrieve the texture. The texture at the specified level of the mipmap.

Paints a SpriteVisual with a CompositionBrush after applying Nine-Grid Stretching to the contents of the Source brush. The source of the nine-grid stretch can by any CompositionBrush of type CompositionColorBrush, CompositionSurfaceBrush or a CompositionEffectBrush.

Inset from the bottom edge of the source content that specifies the thickness of the bottom row. Defaults to 0.0f.

Inset from the bottom edge of the source content that specifies the thickness of the bottom row. Defaults to 0.0f.

Scale to be applied to BottomInset. Defaults to 1.0f.

Scale to be applied to BottomInset. Defaults to 1.0f.

Indicates whether the center of the Nine-Grid is drawn.

Indicates whether the center of the Nine-Grid is drawn.

Inset from the left edge of the source content that specifies the thickness of the left column. Defaults to 0.0f.

Inset from the left edge of the source content that specifies the thickness of the left column. Defaults to 0.0f.

Scale to be applied to LeftInset. Defaults to 1.0f.

Scale to be applied to LeftInset. Defaults to 1.0f.

Inset from the right edge of the source content that specifies the thickness of the right column. Defaults to 0.0f.

Inset from the right edge of the source content that specifies the thickness of the right column. Defaults to 0.0f.

Scale to be applied to RightInset. Defaults to 1.0f.

Scale to be applied to RightInset. Defaults to 1.0f.

The brush whose content is to be Nine-Grid stretched. Can be of type CompositionSurfaceBrush or CompositionColorBrush.

The brush whose content is to be scaled using Nine-Grid Scaling. Can be of type CompositionSurfaceBrush or CompositionColorBrush.

Inset from the top edge of the source content that specifies the thickness of the top row. Defaults to 0.0f.

Inset from the top edge of the source content that specifies the thickness of the top row. Defaults to 0.0f.

Scale to be applied to TopInset. Defaults to 1.0f.

Scale to be applied to TopInset. Defaults to 1.0f.

Sets the insets of a CompositionNineGridBrush using the same value for the top, bottom, left, and right. Defaults to 0.0f.

The inset value to use for the top, bottom, left, and right.

Sets the insets of a CompositionNineGridBrush using the specified values for the top, bottom, left, and right. Defaults to 0.0f.

The inset from the left of the image. The inset from the top of the image. The inset from the right of the image. The inset from the bottom of the image.

Sets the (same) scale to be applied to the left, top, right, and bottom insets. Defaults to 1.0f.

The scale for all of the insets.

Sets the scale to be applied to the left, top, right, and bottom insets respectively. Defaults to 1.0f.

The scale of the left inset. The scale of the top inset. The scale of the right inset. The scale of the bottom inset.

Base class of the composition API representing a node in the visual tree structure.

A string to associate with the CompositionObject.

A string to associate with the CompositionObject. Note that for Visual Studio's Live Visual Tree debugging tool, the name displayed for a particular visual will be pulled from its Comment property

The Compositor used to create this CompositionObject.

The Compositor used to create this CompositionObject.

The dispatcher for the CompositionObject.

The dispatcher for the CompositionObject.

Gets the DispatcherQueue for the CompostionObject.

The DispatcherQueue for the CompostionObject.

The collection of implicit animations attached to this object.

The collection of implicit animations attached to this object.

The collection of properties associated with the CompositionObject.

The collection of properties associated with the CompositionObject.

Closes the CompositionObject and releases system resources.

Defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

Connects an animation with the specified property of the object and starts the animation.

The property to associate the animation with. The animation to associate with the specified property.

Starts an animation group.

The animation group to start.

Starts an animation group on the specified target.

The object that defines the property to be animated. The animation to associate with the specified property.

Connects an animation with the specified property of the target object and starts the animation.

The object that defines the property to be animated. The property to associate the animation with. The animation to associate with the specified property.

Disconnects an animation from the specified property and stops the animation.

The name of the property to disconnect the animation from.

Stops an animation group.

The animation group to stop.

Returns an AnimationController for the animation running on the specified property.

The property being animated. An instance of AnimationController for the specified animation, or **null** if the animation is not found.

Represents a series of connected lines and curves.

Initializes a new instance of the CompositionPath class.

The source of the path data.

Represents a series of connected lines and curves.

Gets or sets the data that defines the lines and curves of the path.

The data that defines the lines and curves of the path.

Represents a scene-based shadow calculated using the relationship between the light, the visual that casts the shadow,and the visual that receives the shadow, such that the shadow is drawn differently on each receiver.

Gets or sets the multiplier for the shadow's blur radius.

The multiplier for the shadow's blur radius.

Gets the collection of objects that cast a shadow on the receivers.

The collection of objects that cast a shadow on the receivers.

Gets or sets the composition light that determines the direction the shadow is cast.

The composition light that determines the direction the shadow is cast.

Gets or sets the maximum blur radius of the shadow.

The maximum blur radius of the shadow.

Gets or sets the minimum blur radius of the shadow.

The minimum blur radius of the shadow.

Gets the collection of objects that the shadow is cast on.

The collection of objects that the shadow is cast on.

Represents an object that casts a projected shadow.

Gets or sets the brush used to draw the shadow.

The brush used to draw the shadow.

Gets or sets the Visual that casts the shadow.

The Visual that casts the shadow.

Represents a collection of CompositionProjectedShadowCaster objects.

Gets the size (count) of the collection.

The number of items in the collection.

Gets the maximum number of shadow casters that will be respected.

The maximum number of shadow casters that will be respected.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Adds a CompositionProjectedShadowCaster to the collection above the specified item.

The CompositionProjectedShadowCaster to add to the collection. The item to add _newCaster_ above.

Adds a CompositionProjectedShadowCaster to the bottom of the collection.

The CompositionProjectedShadowCaster to add to the collection.

Adds a CompositionProjectedShadowCaster to the top of the collection.

The CompositionProjectedShadowCaster to add to the collection.

Adds a CompositionProjectedShadowCaster to the collection below the specified item.

The CompositionProjectedShadowCaster to add to the collection. The item to add _newCaster_ below.

Removes the specified CompositionProjectedShadowCaster from the collection.

The CompositionProjectedShadowCaster to remove from the collection.

Removes all items from the collection.

Represents an object that can have a projected shadow cast on it.

Gets or sets the Visual that the shadow is cast on.

The Visual that the shadow is cast on.

Represents an unordered collection of CompositionProjectedShadowReceiver objects.

Gets the size (count) of the collection.

The number of items in the collection.

Adds the specified CompositionProjectedShadowReceiver to the collection.

The item to add to the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Removes the specified CompositionProjectedShadowReceiver from the collection.

The CompositionProjectedShadowReceiver to remove from the collection.

Removes all items from the collection.

Stores values as key-value pairs.

Inserts a boolean key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Color key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Matrix3x2 key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Matrix4x4 key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a quaternion key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Single key-value pair.

The name of the property to insert. The value of the property to insert.

Inserts a Vector2 key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Vector3 key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Inserts a Vector4 key-value pair.

The key associated with the value. This key can be used to retrieve the value. The value to insert.

Retrieves the specified boolean property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified boolean property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Color property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Color property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Matrix3x2 property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Matrix3x2 property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Matrix4x4 property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Matrix4x4 property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified quaternion property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified quaternion property value when the method returns. Returns an enumeration value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Single property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Single property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Vector2 property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Vector2 property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Vector3 property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Vector3 property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Retrieves the specified Vector4 property value.

The name of the property to retrieve. If the operation is successful, this parameter will contain the specified Vector4 property value when the method returns. Returns a CompositionGetValueStatus value indicating the outcome of retrieving the key-value pair.

Represents a brush that paints an area with a radial gradient.

Gets or sets the two-dimensional coordinates of the center of the ellipse that contains the gradient.

The two-dimensional coordinates of the center of the ellipse the gradient is housed in. The default is a Vector2 with values (0.5, 0.5).

Gets or sets the radii of the ellipse that contains the gradient.

The radii of the ellipse that contains the gradient. The default is a Vector2 with values (0.5, 0.5).

Gets or sets the two-dimensional coordinates of the origin of the gradient.

The two-dimensional coordinates of the origin of the gradient. The default is a Vector2 with values (0, 0).

Represents a rectangle shape of the specified size.

Gets or sets the offset of the rectangle.

The offset of the rectangle.

Gets or sets the height and width of the rectangle.

The height and width of the rectangle.

Represents a rectangle shape of the specified size with rounded corners.

Gets or sets the degree to which the corners are rounded.

The degree to which the corners are rounded.

Gets or sets the offset of the rectangle.

The offset of the rectangle.

Gets or sets the height and width of the rectangle.

The height and width of the rectangle.

An explicitly created group of active animations or effects.

Indicates whether the CompositionScopedBatch is currently opened for objects to be aggregated.

Boolean indicating whether the CompositionScopedBatch is currently opened for objects to be aggregated.

Indicates whether the CompositionScopedBatch has been closed and can no longer accept changes.

Boolean indicating whether the CompositionScopedBatch has been closed and can no longer accept changes.

Event triggered once all animations and effects in the CompositionScopedBatch have completed.

Closes the CompositionScopedBatch. Once the CompositionScopedBatch has been closed it cannot be suspended or resumed again.

Resumes aggregating objects in the CompositionScopedBatch.

Suspends aggregating objects in the CompositionScopedBatch.

Base class for shadows that can be applied to a SpriteVisual.

Represents the base shape class.

The point about which the shape is rotated and scaled.

The point about which the shape is rotated and scaled.

Gets or sets the offset of the shape relative to its ShapeVisual.

The offset of the shape relative to its ShapeVisual.

Gets or sets the rotation angle of the shape in radians.

The rotation angle of the shape in radians.

Gets or sets the rotation angle of the shape in degrees.

The rotation angle of the shape in degrees.

Gets or sets the scale to apply to the shape.

The scale to apply to the shape.

Gets or sets the transform matrix to apply to the shape.

The transform matrix to apply to the shape.

Represents a collection of CompositionShape objects that can be individually accessed by index.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The CompositionShape value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The zero-based index at which to insert the item. The object to insert into the collection.

Removes the item at the specified index.

The zero-based index of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the CompositionShape value specified.

The index at which to set the value. The value to set.

A CompositionShape that draws Stroked and Filled CompositionGeometry.

Gets or sets the brush that paints the interior area of the shape.

A brush that paints/fills the shape interior.

Gets or sets the geometry that defines this shape.

The geometry that defines this shape.

Gets or sets a value that specifies whether the shape's outline scales.

**true** if the shape's outline does not scale; otherwise, **false**.

Gets or sets the brush that paints the outline of the shape.

A brush that paints the shape outline.

Gets the collection of values that indicates the pattern of dashes and gaps used to outline shapes.

The collection of values that indicates the pattern of dashes and gaps used to outline shapes.

Gets or sets a CompositionStrokeCap enumeration value that specifies how the ends of a dash are drawn.

An enumeration value that specifies how the ends of a dash are drawn. The default is **Flat**.

Gets or sets a value that specifies the distance within the dash pattern where a dash begins.

A value that represents the distance within the dash pattern where a dash begins. The default is 0.

Gets or sets a CompositionStrokeCap enumeration value that specifies how the end of a line is drawn.

An enumeration value that specifies how the end of a line is drawn. The default is **Flat**.

Gets or sets a CompositionStrokeLineJoin enumeration value that specifies the type of join used at the vertices of a shape.

An enumeration value that specifies the type of join used at the vertices of a shape. The default is **Miter**.

Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of a shape element.

The limit on the ratio of the miter length to the StrokeThickness of a shape element. This value is always a positive number that is greater than or equal to 1.

Gets or sets a CompositionStrokeCap enumeration value that specifies how the start of a line is drawn.

An enumeration value that specifies how the start of a line is drawn. The default is **Flat**.

Gets or sets the width of the shape outline.

The width of the shape outline, in pixels. The default value is 0.

Specifies how content is scaled when mapped from its source to a destination space.

Scale content such that its size is equal to the size of the destination. The aspect ratio of the content is not preserved.

No Scaling. If the size of the content is greater than size of destination, the content is clipped to the bounds of the destination space.

Scale content such that its aspect ratio is preserved and it fits entirely within the bounds of the destination space. If the content’s aspect ratio does not match that of the destination, the content will not cover some of the area bound by the destination space. This is the default value for CompositionSurfaceBrush.Stretch.

Scale content such that its aspect ratio is preserved and it fills the entirety of the destination’s bounds. If the content’s aspect ratio does not match that of the destination, the content will be clipped to the bounds of the destination.

Defines constants that specify the shape at the end of a line or segment.

A cap that does not extend past the last point of the line.

A semicircle that has a diameter equal to the line thickness.

Half of a square that has a length equal to the line thickness.

An isosceles right triangle whose hypotenuse is equal in length to the thickness of the line.

Represents a collection of values that indicates the pattern of dashes and gaps that is used to outline shapes.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the value located at the specified index.

The integer index for the value to retrieve. The value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the value specified.

The index at which to set the value. The value to set.

Defines constants that specify the shape used to join two lines or segments.

Line joins use beveled vertices.

Line joins use regular angular vertices.

Line joins use regular angular vertices unless the join would extend beyond the miter limit; otherwise, line joins use beveled vertices.

Line joins use rounded vertices.

Paints a SpriteVisual with pixels from an ICompositionSurface.

The point on the brush to be positioned at the brush's offset. Value is normalized with respect to the size of the SpriteVisual.

The point on the brush to be positioned at the brush's offset. Value is normalized with respect to the size of the SpriteVisual.

Specifies the algorithm used for interpolating pixels from ICompositionSurface when they do not form a one-to-one mapping to pixels on SpriteVisual (as can happen under stretch, scale, rotation, and other transformations).

Specifies the algorithm used for interpolating pixels from ICompositionSurface when they do not form a one-to-one mapping to pixels on SpriteVisual (as can happen under stretch, scale, rotation, and other transformations).

The point about which the brush is rotated and scaled.

The point about which the brush is rotated and scaled.

Controls the positioning of the vertical axis of content with respect to the vertical axis of the SpriteVisual. The value is clamped from 0.0f to 1.0f with 0.0f representing the left vertical edge and 1.0f representing the right vertical edge of the SpriteVisual. By default this is set to 0.0f.

The positioning of the vertical axis of content with respect to the vertical axis of the SpriteVisual. The value is clamped from 0.0f to 1.0f with 0.0f representing the left vertical edge and 1.0f representing the right vertical edge of the SpriteVisual. The default value is 0.5f.

The offset of the brush relative to its SpriteVisual.

The offset of the brush relative to its SpriteVisual.

The rotation angle, in radians, of the brush.

The rotation angle, in radians, of the brush.

The rotation angle, in degrees, of the brush.

The rotation angle, in degrees, of the brush.

The scale to apply to the brush.

The scale to apply to the brush.

Gets or sets a value that indicates whether the surface brush aligns with pixels.

**true** if the surface brush aligns with pixels; otherwise, **false**.

Controls the scaling that is applied to the contents the ICompositionSurface with respect to the size of the SpriteVisual that is being painted.

Controls how the brush's content is scaled with respect to the size of the SpriteVisual it is painted onto.

The ICompositionSurface associated with the CompositionSurfaceBrush.

The composition surface associated with the CompositionSurfaceBrush.

The transformation matrix to apply to the brush.

The transformation matrix to apply to the brush.

Controls the positioning of the horizontal axis of content with respect to the horizontal axis of the SpriteVisual. The value is clamped from 0.0f to 1.0f with 0.0f representing the top horizontal edge and 1.0f representing the bottom horizontal edge of the SpriteVisual. The default value is 0.5f.

The positioning of the horizontal axis of content with respect to the horizontal axis of the SpriteVisual.

Represents the window on which to display the composition tree.

The root of the composition tree to display.

The root of the composition tree to display.

Provides generalized transformation support for composition objects.

Represents a container that maps shape visual tree coordinates onto the visual.

Gets or sets the horizontal alignment ratio of the view box.

The horizontal alignment ratio of the view box.

Gets or sets the offset of the view box.

The offset of the view box.

Gets or sets the height and width of the view box.

The height and width of the view box.

Gets or sets a value that specifies how content fits into the available space.

An enumeration value that specifies how content fits into the available space. The default is **Uniform**.

Gets or sets the vertical alignment ratio of the view box.

The vertical alignment ratio of the view box.

Represents sparsely allocated bitmaps that can be associated with visuals for composition in a visual tree.

Clears portions of a virtual drawing surface that were previously defined. Areas that are cleared will be treated as empty once again, and video memory that was previously backing them will be reclaimed.

The region of the drawing surface to trim.

Represents a visual tree as an ICompositionSurface that can be used to paint a Visual using a CompositionBrush.

Gets or sets the coordinates of the top-left corner of the part of the visual surface used for rendering.

The coordinates of the top-left corner of the part of the visual surface used for rendering.

Gets or sets the the height and width of the part of the visual surface used for rendering.

The height and width of the part of the visual surface used for rendering.

Gets or sets the root of the visual tree that is the target of the visual surface.

The root of the visual tree that is the target of the visual surface.

Manages the session between an application and the system compositor process.

Creates an instance of Compositor.

Gets or sets a string to associate with the Compositor.

A string to associate with the Compositor.

Gets or sets the rate at which animation plays for all KeyFrame animations created by this compositor.

The rate at which animation plays for all animations created by this compositor.

Gets the maximum allowed playback rate for all KeyFrame animations created by this compositor..

The maximum allowed playback rate.

Gets the minimum allowed playback rate for all KeyFrame animations created by this compositor.

The minimum allowed playback rate.

Closes the Compositor object and releases system resources.

Creates an instance of AmbientLight.

Returns the created AmbientLight object.

Creates an instance of CompositionAnimationGroup.

Returns the created CompositionAnimationGroup object.

Creates an instance of CompositionBackdropBrush.

Returns the created CompositionBackdropBrush object.

Creates an instance of BooleanKeyFrameAnimation.

Returns the created BooleanKeyFrameAnimation object.

Creates an instance of BounceScalarNaturalMotionAnimation.

The created BounceScalarNaturalMotionAnimation object.

Creates an instance of BounceVector2NaturalMotionAnimation.

The created BounceVector2NaturalMotionAnimation object.

Creates an instance of BounceVector3NaturalMotionAnimation.

The created BounceVector3NaturalMotionAnimation object.

Creates an instance of CompositionColorBrush.

Returns the created CompositionColorBrush object.

Creates an instance of CompositionColorBrush using the specified color.

The color for the brush to use. Returns the created CompositionColorBrush object.

Creates an instance of CompositionColorGradientStop.

The created CompositionColorGradientStop object.

Creates an instance of CompositionColorGradientStop with the specified offset and color.

The location of the gradient stop within the gradient vector. The color of the gradient stop. The created CompositionColorGradientStop object.

Creates an instance of ColorKeyFrameAnimation.

Returns the created ColorKeyFrameAnimation object.

Creates an instance of CompositionContainerShape.

Returns the created CompositionContainerShape object.

Creates an instance of ContainerVisual.

Returns the created ContainerVisual object.

Creates an instance of CubicBezierEasingFunction.

The first control point for the easing function. The second control point for the easing function. The created CubicBezierEasingFunction object.

Creates an instance of DistantLight.

Returns the created DistantLight object.

Creates an instance of DropShadow.

Returns the created DropShadow object.

Creates an instance of CompositionEffectFactory.

The type of effect to create. Returns the created CompositionEffectFactory object.

Creates an instance of CompositionEffectFactory specifying effect parameters that should be animatable.

The type of effect to create. The list of properties that should be animatable. Properties are specified using strings of the form 'EffectName.PropertyName', where 'EffectName' identifies a graphics effect object by its IGraphicsEffect.Name property and 'PropertyName' identifies a property of that object. Returns the created CompositionEffectFactory object.

Creates an instance of CompositionEllipseGeometry.

Returns the created CompositionEllipseGeometry object.

Creates an instance of ExpressionAnimation.

Returns the created ExpressionAnimation object.

Creates an instance of ExpressionAnimation.

The expression describing how the ExpressionAnimation should calculate its current value. Returns the created ExpressionAnimation object.

Creates an instance of CompositionGeometricClip.

# Windows.UI.Composition.Compositor.CreateGeometricClip

Creates an instance of CompositionGeometricClip using the specified geometry.

The geometry that defines the shape of the clip. The created CompositionGeometricClip object.

Creates an instance of CompositionBackdropBrush that samples from the area behind the visual, before the window is drawn.

Returns the created CompositionBackdropBrush.

Creates an instance of ImplicitAnimationCollection.

Returns the created ImplicitAnimationCollection object.

Creates an instance of InsetClip.

Returns the created InsetClip object.

Creates an instance of InsetClip.

Inset from the left of the visual. Inset from the top of the visual. Inset from the right of the visual. Inset from the bottom of the visual. Returns the created InsetClip object.

Creates an instance of LayerVisual.

Returns the created LayerVisual object.

Creates an instance of LinearEasingFunction.

Returns the created LinearEasingFunction object.

Creates an instance of CompositionLinearGradientBrush.

The created CompositionLinearGradientBrush object.

Creates an instance of CompositionLineGeometry.

Returns the created CompositionLineGeometry object.

Creates an instance of CompositionMaskBrush.

Returns the created CompositionMaskBrush object.

Creates an instance of CompositionNineGridBrush.

Returns the created CompositionNineGridBrush object.

Creates an instance of CompositionPathGeometry.

Returns the created CompositionPathGeometry object.

Creates an instance of CompositionPathGeometry using the specified path.

The path data. Returns the created CompositionPathGeometry object.

Creates an instance of PathKeyFrameAnimation.

Returns the created PathKeyFrameAnimation object.

Creates an instance of PointLight.

Returns the created PointLight object.

Creates an instance of CompositionProjectedShadow.

Returns the created CompositionProjectedShadow object.

Creates an instance of CompositionProjectedShadowCaster.

Returns the created CompositionProjectedShadowCaster object.

Creates an instance of CompositionProjectedShadowReceiver.

Returns the created CompositionProjectedShadowReceiver object.

Creates an instance of CompositionPropertySet.

Returns the created CompositionPropertySet object.

Creates an instance of QuaternionKeyFrameAnimation.

Returns the created QuaternionKeyFrameAnimation object.

Creates an instance of CompositionRadialGradientBrush.

Returns the created CompositionRadialGradientBrush object.

Creates an instance of CompositionRectangleGeometry.

Returns the created CompositionRectangleGeometry object.

Creates an instance of RedirectVisual.

Returns the created RedirectVisual object.

Creates an instance of RedirectVisual using the specified source.

Returns the created RedirectVisual object.

Creates an instance of CompositionRoundedRectangleGeometry.

Returns the created CompositionRoundedRectangleGeometry object.

Creates an instance of ScalarKeyFrameAnimation.

Returns the created ScalarKeyFrameAnimation object.

Creates an instance of CompositionScopedBatch.

The type of composition batch to create. Returns the created CompositionScopedBatch object.

Creates an instance of ShapeVisual.

Returns the created ShapeVisual object.

Creates an instance of SpotLight.

Returns the created SpotLight object.

Creates an instance of SpringScalarNaturalMotionAnimation.

The created SpringScalarNaturalMotionAnimation object.

Creates an instance of SpringVector2NaturalMotionAnimation.

The created SpringVector2NaturalMotionAnimation object.

Creates an instance of SpringVector3NaturalMotionAnimation.

The created SpringVector3NaturalMotionAnimation object.

Creates an instance of CompositionSpriteShape.

Returns the created CompositionSpriteShape object.

Creates an instance of CompositionSpriteShape using the specified geometry.

The geometry of the shape to create. Returns the created CompositionSpriteShape object.

Creates an instance of SpriteVisual.

Returns the created SpriteVisual object.

Creates an instance of StepEasingFunction.

Returns the created StepEasingFunction object.

Creates an instance of StepEasingFunction with the specified step count.

The step count for the StepEasingFunction. Returns the created StepEasingFunction object.

Creates an instance of CompositionSurfaceBrush.

Returns the created CompositionSurfaceBrush object.

Creates an instance of CompositionSurfaceBrush using the specified composition surface.

The composition surface to associate with the CompositionSurfaceBrush. Returns the created CompositionSurfaceBrush object.

Creates a CompositionTarget for the current view.

Returns the created CompositionTarget object.

Creates an instance of Vector2KeyFrameAnimation.

Returns the created Vector2KeyFrameAnimation object.

Creates an instance of Vector3KeyFrameAnimation.

Returns the created Vector3KeyFrameAnimation object.

Creates an instance of Vector4KeyFrameAnimation.

Returns the created Vector4KeyFrameAnimation object.

Creates an instance of CompositionViewBox.

Returns the created CompositionViewBox object.

Creates an instance of CompositionVisualSurface.

Returns the created CompositionVisualSurface object.

Retrieves a commit batch for the current commit cycle.

The batch type. Returns a CompositionCommitBatch representing the retrieved commit batch.

Attempts to initiate a commit cycle ansynchronously.

An ansynchronous action.

A node in the visual tree that can have children.

The children of the ContainerVisual.

The children of the ContainerVisual.

Represents a cubic-bezier function for interpolating between animation key frames.

The first control point for the cubic-bezier interpolation function.

The first control point for the cubic-bezier interpolation function.

The second control point for the cubic-bezier interpolation function.

The second control point for the cubic-bezier interpolation function.

An infinitely large distant light source that emits light in a single direction. For example, a distant light could be used to represent sunlight.

Color of the emitted DistantLight.

Color of the emitted DistantLight.

The Visual used to determine the light’s direction. The light's

The Visual used to determine the light’s direction. The light's

The direction in which the light is pointing, specified relative to its CoordinateSpace Visual.

The direction in which the light is cast.

Gets or sets the intensity of the light.

The intensity of the light.

A drop shadow cast by a SpriteVisual or LayerVisual.

The radius of the Gaussian blur used to generate the shadow. Animatable.

The radius of the Gaussian blur used to generate the shadow. Defaults to 9.0f. Specifying a value of 0 will result in no blur occurring.

The color of the shadow. Animatable.

The color of the shadow. Default color is Colors.Black.

Brush used to specify an opacity mask for the shadow. Defaults to the SpriteVisual's brush. Animatable.

Brush used to specify an opacity mask for the shadow. Defaults to the SpriteVisual's brush.

Offset of the shadow relative to its SpriteVisual. Animatable.

Offset of the shadow relative to its SpriteVisual.

The opacity of the shadow. Animatable.

The opacity of the shadow.

Used to define the shadow masking policy to be used for the shadow.

The masking policy to apply to the shadow.

A Composition Animation that uses a mathematical equation to calculate the value for an animating property every frame.

The mathematical equation specifying how the animated value is calculated each frame. The Expression is the core of an ExpressionAnimation and represents the equation the system will use to calculate the value of the animation property each frame. The equation is set on this property in the form of a string.

The mathematical equation specifying how the animated value is calculated each frame.

Represents an object that has properties that can be referenced by an animation.

Defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

Base class for composition animations.

Represents the content of a surface that can be used to paint the bounds of a SpriteVisual. All surface types that can be used to paint a SpriteVisual must implement this interface. The following classes implement this interface and can be set as content of a SpriteVisual (using a CompositionSurfaceBrush):

A collection of animations triggered when a condition is met.

The size of the collection.

The size of the collection.

Removes all animations from the collection.

Retrieves the first animation in the collection.

Retrieves the first animation in the collection.

Returns a map view of the collection.

Returns a map view of the collection.

Returns a boolean indicating whether the collection contains the specified key.

The key to check for. Returns true if the key is in the collection; otherwise returns false.

Inserts an animation into the collection.

The property the animation affects. The animation to insert. Boolean value indicating whether the animation was successfully inserted.

Retrieves the animation associated with the specified property.

The property to lookup. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes the specified animation from the collection.

The property the animation is assigned to.

A collection of values that specify where an animation will start.

Gets the size (count) of the collection.

The count of items in the collection.

Removes all items from the collection.

Retrieves the first item in the collection.

The first item in the collection.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Returns a value that indicates whether the collection contains the specified key.

The key to check for. **true** if the key is in the collection; otherwise, **false**.

Inserts an item into the collection.

The key to identify the item to insert. The item to insert. **true** if animation was successfully inserted; otherwise, **false**.

Retrieves the item associated with the specified key.

The key that identifies the item to retrieve. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes the specified item from the collection.

The key that identifies the item to remove.

Clips a portion of a visual. The visible portion of the visual is a rectangle defined as inset values from the edges of the visual. The portion of the visual outside the rectangle is clipped.

The offset from the bottom of the visual. The portion of the visual below the BottomtInset will be clipped. Animatable.

The offset from the bottom of the visual.

The offset from the left of the visual. The portion of the visual to the left of the LeftInset will be clipped. Animatable.

The offset from the left of the visual.

The offset from the right of the visual. The portion of the visual to the right of the RightInset will be clipped. Animatable.

The offset from the right of the visual.

The offset from the top of the visual. The portion of the visual above the TopInset will be clipped. Animatable.

The offset from the top of the visual.

Marks an object to indicate to the system that it can resolve to a CompositionVisual

A time-based animation with one or more key frames. These frames are markers, allowing developers to specify values at specific times for the animating property. KeyFrame animations can be further customized by specifying how the animation interpolates between keyframes.

The delay behavior of the key frame animation.

The delay behavior of the key frame animation.

Delay before the animation starts after CompositionObject.StartAnimation is called.

Delay before the animation starts after CompositionObject.StartAnimation is called.

The direction the animation is playing.

The direction the animation is playing.

The duration of the animation.

The duration of the animation. Minimum allowed value is 1ms and maximum allowed value is 24 days.

The iteration behavior for the key frame animation.

The iteration behavior for the key frame animation.

The number of times to repeat the key frame animation.

The number of times to repeat the key frame animation.

The number of key frames in the KeyFrameAnimation.

The number of key frames in the KeyFrameAnimation.

Specifies how to set the property value when StopAnimation is called.

Specifies how to set the property value when StopAnimation is called.

Inserts an expression key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The expression used to calculate the value of the key frame.

Inserts an expression keyframe.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The expression used to calculate the value of the key frame. The easing function to use when interpolating between frames.

A ContainerVisual whose children are flattened into a single layer.

The effect to be applied to the flattened representation of the children of a LayerVisual.

The effect to be applied to the flattened representation of the children of a LayerVisual.

The shadow to be applied to the flattened representation of the children of a LayerVisual.

Represents a linear function for interpolating between animation key frames.

Represents a physics-based animation that uses forces to dynamically move content.

The delay behavior of the NaturalMotionAnimation.

The delay behavior of the NaturalMotionAnimation.

Delay before the animation starts after CompositionObject.StartAnimation is called.

Delay before the animation starts after CompositionObject.StartAnimation is called.

Specifies how to set the property value when StopAnimation is called.

Specifies how to set the property value when StopAnimation is called.

Represents a time-based animation with one or more key frames where each key frame value is represented by a

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The path used to define the value of the key frame.

Inserts a key frame with the specified easing.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The path used to define the value of the key frame. The easing function to use when interpolating between frames.

A point source of light that emanates light in all directions.

Color of the light.

Color of the light.

The constant coefficient in the light's attenuation equation. Controls light intensity.

The constant coefficient in the light's attenuation equation. Controls light intensity. Range is from 0 to infinity.

The Visual used to determine the light's offset. The light's offset property is relative to this Visual's coordinate space.

The Visual used to determine the light's offset.

Gets or sets the intensity of the light.

The intensity of the light.

The linear coefficient in the light's attenuation equation that determines how the light falls-off with distance.

The linear coefficient in the light's attenuation equation that determines how the light falls-off with distance. Range is from 0 to infinity.

Gets or sets the maximum range at which this light is effective.

The maximum range at which this light is effective. The default is 0.0.

Gets or sets the minimum range at which this light is effective.

The minimum range at which this light is effective. The default is 0.0.

Offset of the light source relative to its coordinate space Visual.

Offset of the light source relative to its coordinate space Visual.

The quadratic portion of the attenuation equation that determines how the light falls off with distance.

The quadratic portion of the attenuation equation that determines how the light falls off with distance. Controls light intensity falloff based on distance squared. Range is from 0 to infinity.

A time-based animation that targets the Orientation property with one or more key frames.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a key frame with the specified easing function.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use to interpolate between key frames.

Represents a visual that gets its content from another visual.

Gets or sets the Visual that this RedirectVisual gets its content from.

The Visual that this RedirectVisual gets its content from. The default is **null**.

Arguments for the RenderingDeviceReplaced event.

The new graphics device.

The new graphics device.

A time-based animation that targets any Scalar-based property with one or more key frames.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a keyframe.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use to interpolate between key frames.

The base Scalar NaturalMotionAnimation used to target a Scalar property.

Gets or sets a value that indicates where the animation ends.

A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used.

Gets or sets a value that indicates where the animation starts.

A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used.

Gets or sets the velocity that the animation starts with.

The velocity that the animation starts with. The default is 0.

Represents a visual tree node that is the root of a CompositionShape.

Gets the collection of CompositionShapes that this shape visual tree is composed of.

The collection of CompositionShapes that this shape visual tree is composed of.

Gets or sets the CompositionViewBox that maps shape visual tree coordinates onto the visual.

The CompositionViewBox that maps shape visual tree coordinates onto the visual.

A light source that casts inner and outer cones of light. For example, a flashlight.

The constant coefficient in the light's attenuation equation. Controls light intensity. Animatable.

The constant coefficient in the light's attenuation equation. Controls light intensity. Range is from 0 to infinity.

The Visual used to determine the light's direction and offset. The light's offset and direction properties are relative to this Visual's coordinate space.

The visual the light's offset is relative to.

The direction in which the light is pointing, specified relative to its CoordinateSpace Visual.

The direction in which the light is pointing, specified relative to its coordinate space Visual.

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in radians. Animatable.

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in radians.

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in degrees. Animatable.

The SpotLight’s inner cone angle, expressed as a semi-vertical angle in degrees.

Color of the spotlight's inner cone. Animatable.

Color of the spotlight's inner cone.

Gets or sets the intensity of the light in the spotlight's inner cone.

The intensity of the light.

The linear coefficient in the light's attenuation equation that determines how the light falls off with distance. Animatable.

The linear coefficient in the light's attenuation equation that determines how the light falls off with distance. Range is from 0 to infinity.

Gets or sets the maximum range at which this light is effective.

The maximum range at which this light is effective. The default is 0.0.

Gets or sets the minimum range at which this light is effective.

The minimum range at which this light is effective. The default is 0.0.

Offset of the light source relative to its CoordinateSpace Visual. Animatable.

Offset of the light source relative to its coordinate space Visual.

The SpotLight’s outer cone angle, expressed as a semi-vertical angle in radians. Animatable.

The SpotLight’s outer cone angle, expressed as a semi-vertical angle in radians. The value must be between 0 and pi.

The semi-vertical angle, in degrees, of the SpotLight's outer cone. Animatable.

The semi-vertical angle, in degrees, of the SpotLight's outer cone.

The color of the spotlight's outer cone. Animatable.

The color of the spotlight's outer cone.

Gets or sets the intensity of the light in the spotlight's outer cone.

The intensity of the light.

The quadratic portion of the attenuation equation that determines how the light falls off with distance. Animatable.

The quadratic coefficient in the light's attenuation equation. Controls light intensity falloff based on distance squared. Range is from 0 to infinity.

A spring physics-based animation that targets any Scalar-based property.

Gets or sets a value that indicates how much damping is applied to the spring.

A value that indicates how much damping is applied to the spring.

Gets or sets the time for the Spring to complete a single oscillation.

The time for the Spring to complete a single oscillation.

A spring physics-based animation that targets any Vector2-based property.

Gets or sets a value that indicates how much damping is applied to the spring.

A value that indicates how much damping is applied to the spring.

Gets or sets the time for the Spring to complete a single oscillation.

The time for the Spring to complete a single oscillation.

A spring physics-based animation that targets any Vector3-based property.

Gets or sets a value that indicates how much damping is applied to the spring.

A value that indicates how much damping is applied to the spring.

Gets or sets the time for the Spring to complete a single oscillation.

The time for the Spring to complete a single oscillation.

Hosts 2D boxed content of type CompositionBrush. Any part of the visual not covered by pixels from the brush are rendered as transparent pixels. CompositionBrush can be either a CompositionBackdropBrush, CompositionColorBrush, a CompositionSurfaceBrush or a CompositionEffectBrush.

A CompositionBrush describing how the SpriteVisual is painted.

A CompositionBrush describing how the SpriteVisual is painted.

The shadow for the SpriteVisual.

The shadow for the SpriteVisual.

A step function for interpolating between animation key frames.

The step to end at.

The step to end at.

The step to start at.

The step to start at.

Indicates whether the final step should last the smallest possible duration.

Boolean indicating whether the final step should last the smallest possible duration (1 frame).

Indicates whether the initial step should last the smallest possible duration.

Boolean indicating whether the initial step should last the smallest possible duration (1 frame).

The number of steps between the starting value and the end value.

The number of steps between the starting value and the end value.

A time-based animation that targets any Vector2-based property with one or more key frames.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a keyframe with the specified easing function.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use when interpolating between frames.

The base Vector2 NaturalMotionAnimation used to target a Vector2 property.

Gets or sets a value that indicates where the animation ends.

A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used.

Gets or sets a value that indicates where the animation starts.

A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used.

Gets or sets the velocity that the animation starts with.

The velocity that the animation starts with. The default is 0.

A time-based animation that targets any Vector3-based property with one or more keyframes.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a key frame with the specified easing function.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use when interpolating between frames.

The base Vector3 NaturalMotionAnimation used to target a Vector3 property.

Gets or sets a value that indicates where the animation ends.

A value that indicates where the animation ends. The default is **null**. If left **null**, the ending value of the property being animated is used.

Gets or sets a value that indicates where the animation starts.

A value that indicates where the animation starts. The default is **null**. If left **null**, the beginning value of the property being animated is used.

Gets or sets the velocity that the animation starts with.

The velocity that the animation starts with. The default is 0.

A time-based animation that targets any Vector4-based property with one or more keyframes.

Inserts a key frame.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame.

Inserts a key frame with the specified easing function.

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. The value of the key frame. The easing function to use when interpolating between key frames.

The base visual object in the visual hierarchy.

The point on the visual to be positioned at the visual's offset. Value is normalized with respect to the size of the visual. Animatable.

The point on the visual to be positioned at the visual's offset. Value is normalized with respect to the size of the visual.

Specifies whether the back face of the visual should be visible during a 3D transform.

Whether the back face of the visual should be visible during a 3D transform.

Specifies how to compose the edges of bitmaps and clips associated with a visual, or with all visuals in the subtree rooted at this visual. Setting BorderMode at a parent Visual will affect all children visuals in the subtree and can be selectively turned off at each child visual.

How to compose the edges of bitmaps and clips associated with a visual, or with all visuals in the subtree rooted at this visual.

The point about which rotation or scaling occurs. Animatable

The point about which rotation or scaling occurs.

Specifies the clipping region for the visual. When a visual is rendered, only the portion of the visual that falls inside the clipping region is displayed, while any content that extends outside the clipping region is clipped (that is, not displayed).

Specifies the clipping region for the visual.

Specifies how a visual's bitmap is blended with the screen.

How a visual's bitmap is blended with the screen.

Indicates whether the visual and its entire subtree of child visuals is visible.

Indicates whether the visual and its entire subtree of child visuals is visible.

The offset of the visual relative to its parent or for a root visual the offset relative to the upper-left corner of the windows that hosts the visual. Animatable.

Offset of the visual relative to its parent.

The opacity of the visual. Animatable.

The opacity of the visual.

A quaternion describing an orientation and rotation in 3D space that will be applied to the visual. Animatable.

A Quaternion describing an orientation and rotation in 3D space that will be applied to the visual.

The parent of the visual.

The parent of the visual.

Visual specifying the coordinate system in which this visual is composed.

Visual specifying the coordinate system in which this visual is composed.

Specifies the offset of the visual with respect to the size of its parent visual.

The offset of the visual with respect to the size of its parent visual.

The size of the visual with respect to the size of its parent visual.

The size of the visual with respect to the size of its parent visual.

The rotation angle in radians of the visual. Animatable.

The rotation angle in radians of the visual.

The rotation angle of the visual in degrees. Animatable.

The rotation angle of the visual in degrees.

The axis to rotate the visual around. Animatable.

The axis to rotate the visual around. For example, a value of Vector3(1,0,0) indicates rotation along the x-axis.

The scale to apply to the visual.

The scale to apply to the visual. A value of Vector3 (1.0,1.0,1.0) is equivalent to 100%.

The width and height of the visual. Animatable.

The width and height of the visual.

The transformation matrix to apply to the visual. Animatable.

The transformation matrix to apply to the visual.

Represents a collection of visual instances.

Gets the number of visual instances in the collection.

The number of visual instances in the collection.

Retrieves an iterator with the first object at the bottom of the collection.

Returns an iterator with the first object at the bottom of the collection. VisualCollections are ordered from bottom to top.

Inserts a visual above the specified sibling visual in the visual collection.

The new visual to insert. The sibling to insert the visual above.

Inserts a new visual at the bottom of the visual collection.

The new visual to insert.

Inserts a new visual at the top of the visual collection.

The new visual to insert.

Insert a new visual below the specified visual in the visual collection.

The new visual to insert. The sibling visual to insert the new visual below.

Removes the specified visual instance from the collection.

The specified visual instance from the collection.

Removes all of the visual instances from the collection.

An unordered collection of visuals.

The number of visuals in the collection.

The nubmer of visuals in the collection.

Adds a visual to the collection.

The visual to add to the collection.

Retrieves the first visual in the collection.

The first visual in the collection.

Removes a visual from the collection.

Removes a visual from the collection.

Removes all visuals from the collection.

Represents a compositor on which intended composition changes must be explicitly committed.

Initializes a new instance of the CompositorController class.

Gets the compositor associated with this composition controller.

The compositor associated with this composition controller.

Occurs when the framework needs to call Commit in order for changes to Composition objects to be reflected onscreen.

Releases system resources that are used by the CompositorController.

Calls commit on the compositor associated with this CompositorController.

Ensures the previous commit was completed.

An asynchronous action.

Represents a window that is the target of a composition.

Gets a value that indicates whether the window is rendered on top of all other windows.

**true** if the window is rendered on top of all other windows; otherwise, **false**.

Represents heatmaps that show overdrawn areas of a composition UI.

Hides the heatmap for the specified subtree.

The part of the visual tree for which to hide the heatmap.

Shows a graphical representation of the GPU memory used by the app.

The part of the visual tree for which to show texture memory usage.

Highlights pixels affected by multiple visuals at the same time.

The part of the visual tree for which to show overdraw regions. An enumeration value that specifies what type of content is shown on the overdraw heatmap.

Highlights areas of the app UI that are producing updates.

The part of the visual tree for which to show redraw.

Defines constants that specify what kinds of content are shown on an overdraw heatmap.

All content kinds are shown.

Colors are shown.

Effects are shown.

Lights are shown.

No content kinds are shown.

Elements rendered offscreen are shown.

Shadows are shown.

Surfaces are shown.

SwapChains are shown.

Hosts diagnostic and debugging features such as heatmaps.

Gets the heatmaps for this debug settings instance.

The heatmaps for this debug settings instance.

Attempts to get an instance of CompositionDebugSettings for the specified compositor.

The compositor to get debug settings for. An instance of composition debug settings.

Controls the reflective properties of a SpriteVisual. A SceneLightingEffect will overwrite CompositionLight defaults. It is used to control the reflective properties of a SpriteVisual. A NormalMap can be used as an input source but is not required.

Creates an instance of SceneLightingEffect.

The proportion of predefined AmbientLight used by the effect.

The proportion of predefined AmbientLight used by the effect. Values must be set between 0.0 and 1.0.

Intensity of the diffuse light.

Intensity of the diffuse light.

Name of the light.

Name of the light.

The normal map for the effect.

The normal map for the effect.

Gets or sets a value that indicates how the reflectance of a SceneLightingEffect is modeled.

A value that indicates how the reflectance of a SceneLightingEffect is modeled.

Intensity of the specular light.

Intensity of the specular light.

Specular power for the Blinn-Phong lighting model.

Specular power for the Blinn-Phong lighting model. Value must be set between 1.0 and 128. The default value is 16.

Defines constants that specify how the reflectance of a SceneLightingEffect is modeled.

The BlinnPhong model is used.

The PhysicallyBasedBlinnPhong model is used.

Allows conditional modification of the position and scale of a visual interaction source.

The condition expression that determines when to apply modifiers to the visual interaction source.

The condition expression that determines when to apply modifiers to the visual interaction source.

The modified input expression to be applied when the condition is true.

The modified input expression to be applied when the condition is true.

Creates an instance of CompositionConditionalValue.

Returns the created CompositionConditionalValue.

A collection of interaction sources.

The number of interaction sources in the collection.

The number of interaction sources in the collection.

Adds an interaction source to the collection.

The interaction source to add to the collection.

Returns an iterator pointing to the first object in the collection.

Returns an iterator pointing to the first object in the collection.

Removes the specified interaction source from the collection.

The interaction source to remove from the collection.

Removes all interaction sources from the collection.

An object that is being tracked for interactions in the compositor.

Contains callbacks that will be triggered by InteractionTracker events.

Callback triggered when an InteractionTracker enters the custom animation state.

The InteractionTracker that triggered the callback. Arguments for the callback.

Callback triggered when an InteractionTracker enters the idle state.

The InteractionTracker that triggered the callback. Arguments for the callback.

Callback triggered when an InteractionTracker enters the inertia state.

The InteractionTracker that triggered the callback. Arguments for the callback.

Callback that is triggered when an InteractionTracker enters the interaction state.

The InteractionTracker that triggered the callback. Arguments for the callback.

Callback that is triggered when the InteractionTracker has ignored a request.

The InteractionTracker that triggered the callback. The arguments for the callback.

Callback that is triggered when the InteractionTracker 's output values have changed.

The InteractionTracker that triggered the callback. The new values for the InteractionTracker.

Defines constants that specify which axis is bound between two interaction trackers.

The binding does not affect any axis.

The binding affects the X axis.

The binding affects the Y axis.

The binding affects scale.

Defines the chaining behavior for a VisualInteractionSource. There are three options: Always chain, never chain or auto chain (let the system choose). If chaining is enabled, when an InteractionTracker reaches its minimum or maximum bounds, it will instead send the input to the next ancestor VisualInteractionSource.

Always continue the manipulation.

Automatically determine whether to continue the manipulation.

Never continue the manipulation.

Represents the configuration of a VisualInteractionSource input.

Gets or sets a value that indicates how interactions are processed for this VisualInteractionSource input on the X axis.

The source mode for the X axis. By default, it takes the value of VisualInteractionTracker.PositionXSourceMode.

Gets or sets a value that indicates how interactions are processed for this VisualInteractionSource input on the Y axis.

The source mode for the Y axis. By default, it takes the value of VisualInteractionTracker.PositionYSourceMode.

Gets or sets a value that indicates how interactions are processed for this VisualInteractionSource input on the scale axis.

The source mode for the scale axis. By default, it takes the value of VisualInteractionTracker.ScaleSourceMode.

Provides the various definitions for how a VisualInteractionSource will process interactions. Options available for the enumeration are

Interaction is disabled.

Interaction is enabled with inertia.

Interaction is enabled without inertia.

Defines constants that specify whether an input should be redirected to the InteractionTracker.

Redirection is off, all input goes to the UI thread.

Input is redirected to the InteractionTracker.

Handles the logic of input that can be used as targets in ExpressionAnimations—typically to drive the motion of visuals based on input.

A collection of objects that generate interactions.

A collection of objects that generate interactions.

Gets a value that indicates whether the inertia is the result of an impulse.

**true** if the inertia is the result of an impulse; otherwise, **false**.

Boolean value indicating whether position rounding is currently suggested.

Boolean value indicating whether position rounding is currently suggested.

The maximum position allowed for the InteractionTracker.

The maximum position allowed for the InteractionTracker.

The maximum scale for the InteractionTracker.

The maximum scale for the InteractionTracker.

The minimum position allowed for the InteractionTracker.

The minimum position allowed for the InteractionTracker.

The minimum scale for the InteractionTracker.

The minimum scale for the InteractionTracker.

Natural resting position for the InteractionTracker.

Natural resting position for the InteractionTracker.

Natural resting scale for the InteractionTracker.

Natural resting scale for the InteractionTracker.

The IInteractionTrackerOwner associated with the InteractionTracker.

The IInteractionTrackerOwner associated with the InteractionTracker.

The output position calculated by the InteractionTracker. The current position is a relative value. During the Idle and CustomAnimation states, it will always be between the values specified in the MinPosition and MaxPosition properties. The InteractionTracker’s position property can go outside this range during the Interacting and Inertia states in order to show a bounce or resistance at the boundary.

The output position calculated by the InteractionTracker.

Inertia decay rate for position. Range is from 0 to 1.

Inertia decay rate for position. Range is from 0 to 1.

The velocity currently applied to position.

The velocity currently applied to position.

The output scale calculated by the InteractionTracker. The current scale is a relative value that depends on the values specified in the MinScale and MaxScale properties.

The output scale calculated by the InteractionTracker.

Inertia decay rate, for scale. Range is from 0 to 1.

Inertia decay rate for scale. Range is from 0 to 1.

The rate of change for scale.

The rate of change for scale.

Adjusts the position x coordinate if it is greater than the specified threshold.

The amount to adjust the position x coordinate. The threshold for ajusting the position x coordinate.

Adjusts the position y coordinate if it is greater than the specified threshold.

The amount to adjust the position y coordinate. The threshold for ajusting the position y coordinate.

Takes an ordered list of CompositionConditionalValue. In a frame, while the tracker is in Inertia, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the zoom CenterPointX value the tracker uses with its “.Value”. If none evaluate to true, the CenterPointX is not replaced that frame.

Takes an ordered list of CompositionConditionalValue. In a frame, while the tracker is in Inertia, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the zoom CenterPointY value the tracker uses with its “.Value”. If none evaluate to true, the CenterPointY is not replaced that frame.

Applies a collection of InteractionTrackerInertiaModifier objects to the x inertia of an InteractionTracker.

The collection of InteractionTrackerInertiaModifier objects to apply to the x inertia of an InteractionTracker.

Applies a collection of InteractionTrackerInertiaModifier objects to the y inertia of an InteractionTracker.

The collection of InteractionTrackerInertiaModifier objects to apply to the y inertia of an InteractionTracker.

Applies a collection of InteractionTrackerInertiaModifier objects to the scale of an InteractionTracker.

The collection of InteractionTrackerInertiaModifier objects to apply to the scale of an InteractionTracker.

Applies a collection of InteractionTrackerInertiaModifier objects to the position of an InteractionTracker.

The collection of InteractionTrackerInertiaModifier objects to apply to the position of an InteractionTracker.

Creates an instance of InteractionTracker.

The compositor to use when creating the InteractionTracker. Returns the created InteractionTracker object.

Creates an instance of InteractionTracker with the specified owner.

The compositor to use to create the instance of InteractionTracker. The InteractionTracker owner to associate with the created InteractionTracker. Returns the created InteractionTracker object.

Retrieves the binding axis mode between two interaction trackers.

The first interaction tracker in the binding. The second interaction tracker in the binding.

Sets the binding axis mode between two interaction trackers.

The first interaction tracker in the binding. The second interaction tracker in the binding. The axis that is being bound.

Tries to update the InteractionTracker 's position.

The new position for the InteractionTracker. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the position of the InteractionTracker using the specified clamping option.

The new position for the InteractionTracker. A value that specifies how values are clamped to the maximum and minimum. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the position of the InteractionTracker using the specified clamping option.

The new position for the InteractionTracker. A value that specifies how values are clamped to the maximum and minimum. A value that specifies whether an already running custom scale animation should be allowed to continue running. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to adjust the InteractionTracker 's position by the specified amount.

The value to add to the current position. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to adjust the position of the InteractionTracker by the specified amount using the specified clamping option.

The value to add to the current position. A value that specifies how values are clamped to the maximum and minimum. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the InteractionTracker 's position by adding velocity.

The velocity to add in pixels per second. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the InteractionTracker 's position by applying an animation.

The animation to apply to the InteractionTracker. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the scale to the specified value.

The new value for scale. The new center point. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the scale by adding the specified velocity.

The velocity to add to the scale. The new center point. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Tries to update the scale with the specified animation.

The animation to apply to the scale. The new center point. Returns the request ID. On state transitions, the request which caused the change in state will be included in the args. These IDs will start at 1 and increase with each try call during the lifetime of the application.

Defines constants that specify how values are clamped when the InteractionTracker position is updated.

If the input value is greater (or less) than the max (or min) value, it is immediately clamped.

If the input value is greater (or less) than the max (or min) value, it is not immediately clamped. Instead, the max/min is enforced to the newly input value of Position (and potentially clamped) the next time InteractionTracker enters the Inertia state.

Arguments for the IInteractionTrackerOwner.CustomAnimationStateEntered callback.

Gets a value that indicates whether this state was entered through interaction with a tracker that this one is bound to.

**true** if this state was entered through interaction with a tracker that this one is bound to; **false** if the state was entered through interaction directly with this tracker.

The ID of the request that triggered the callback.

The ID of the request that triggered the callback.

Arguments for the IInteractionTrackerOwner.IdleStateEntered callback.

Gets a value that indicates whether this state was entered through interaction with a tracker that this one is bound to.

**true** if this state was entered through interaction with a tracker that this one is bound to; **false** if the state was entered through interaction directly with this tracker.

The ID of the request that triggered the callback.

The ID of the request that triggered the callback.

Base class for inertia modifiers.

An ExpressionAnimation that defines motion of InteractionTracker during its inertia state.

An ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation describing the modified motion for InteractionTracker if the expression in the Condition property is true.

An ExpressionAnimation describing the modified motion for InteractionTracker if the expression in the Condition property is true.

Creates an instance of InteractionTrackerInertiaMotion.

The compositor to use when creating the InteractionTrackerInertiaMotion object. Returns the created InteractionTrackerInertiaMotion object.

A ScalarNaturalMotionAnimation that defines motion of InteractionTracker during its inertia state.

Gets or sets an ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation describing when the modifier should be applied.

Gets or set a ScalarNaturalMotionAnimation that describes the modified motion for InteractionTracker if the expression in the Condition property is **true**.

A ScalarNaturalMotionAnimation that describes the modified motion for InteractionTracker if the expression in the Condition property is **true**.

Creates an instance of InteractionTrackerInertiaNaturalMotion.

The compositor to use when creating the InteractionTrackerInertiaNaturalMotion object. Returns the created InteractionTrackerInertiaNaturalMotion object.

An ExpressionAnimation that defines the rest position after an interaction.

An ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation to define the resting value of InteractionTracker if the expression in the Condition property is true.

An ExpressionAnimation to define the resting value if the expression in the Condition property is true.

Creates an instance of InteractionTrackerInertiaRestingValue.

The compositor to use when creating the InteractionTrackerInertiaRestingValue object. Returns the created InteractionTrackerInertiaRestingValue object.

Arguments for the IInteractionTrackerOwner.InertiaStateEntered callback.

Gets a value that indicates whether this state was entered through interaction with a tracker that this one is bound to.

**true** if this state was entered through interaction with a tracker that this one is bound to; **false** if the state was entered through interaction directly with this tracker.

Gets a value that indicates whether the inertia is the result of an impulse.

**true** if the inertia is the result of an impulse; otherwise, **false**.

The InteractionTracker 's resting position when inertia completes after InteractionTrackerInertiaModifier s and boundaries have been applied.

The InteractionTracker 's resting position when inertia completes after InteractionTrackerInertiaModifier s and boundaries have been applied.

The InteractionTracker 's resting scale when inertia completes, after InteractionTrackerInertiaModifiers and boundaries have been applied.

The InteractionTracker 's resting scale when inertia completes, after InteractionTrackerInertiaModifiers and boundaries have been applied.

The InteractionTracker 's resting position when inertia completes, without any modifiers or boundaries applied.

The InteractionTracker 's resting position when inertia completes, without any modifiers or boundaries applied.

The InteractionTracker 's resting scale when inertia completes, without accounting for InteractionTrackerInertiaModifier s or boundaries.

The InteractionTracker 's resting scale when inertia completes, without accounting for InteractionTrackerInertiaModifier s or boundaries.

The velocity of InteractionTracker 's position.

The velocity of InteractionTracker 's position.

The ID of the request that triggered the callback. Represents the ID of the request that caused InteractionTracker to enter the Inertia State (the InertiaStateEntered callback was triggered). Note that the RequestID property will be incremented each time a request tries to change the state of InteractionTracker.

The ID of the request that triggered the callback.

The velocity of InteractionTracker 's scale.

The velocity of InteractionTracker 's scale.

Arguments for the IInteractionTrackerOwner.InteractingStateEntered callback.

Gets a value that indicates whether this state was entered through interaction with a tracker that this one is bound to.

**true** if this state was entered through interaction with a tracker that this one is bound to; **false** if the state was entered through interaction directly with this tracker.

The ID of the request that triggered the callback.

The ID of the request that triggered the callback.

Defines constants that indicate whether an already running custom scale animation should be allowed to continue running.

An active scale animation will continue.

An active scale animation will stop.

Arguments for the IInteractionTrackerOwner.RequestIgnored callback.

The ID of the request that triggered the callback.

The ID of the request that triggered the callback.

Arguments for the IInteractionTrackerOwner.ValuesChanged callback.

The current position of the InteractionTracker.

The current position of the InteractionTracker.

The ID of the request that triggered the callback.

The ID of the request that triggered the callback.

The current scale of the InteractionTracker.

The current scale of the InteractionTracker.

Base class for InteractionTrackerVector2InertiaNaturalMotion.

A Vector2NaturalMotionAnimation that defines motion of InteractionTracker during its inertia state.

Gets or sets an ExpressionAnimation describing when the modifier should be applied.

An ExpressionAnimation describing when the modifier should be applied.

Gets or set a Vector2NaturalMotionAnimation that describes the modified motion for InteractionTracker if the expression in the Condition property is **true**.

A Vector2NaturalMotionAnimation that describes the modified motion for InteractionTracker if the expression in the Condition property is **true**.

Creates an instance of InteractionTrackerVector2InertiaNaturalMotion.

The compositor to use when creating the InteractionTrackerInertiaNaturalMotion object. Returns the created InteractionTrackerInertiaNaturalMotion object.

Object for configuring input to the InteractionTracker relative to a visual.

The amount of position change to be applied during the upcoming frame. Defaults to 0. Readable only via expression/animation.

The change in position of the interaction source.

The amount of scale change to be applied during the upcoming frame. Multiplicative. Defaults to 1. Readable only via expression/animation.

The change in scale of the visual interaction source.

Indicates whether panning on the x-axis is railed.

Boolean value indicating whether panning on the x-axis is railed.

Indicates whether panning on the y-axis is railed.

Boolean value indicating whether panning on the y-axis is railed.

Indicates what input should be redirected to the InteractionTracker.

Indicates what input should be redirected to the InteractionTracker.

Gets the configuration for pointer wheel input.

The configuration for pointer wheel input.

The total amount of position change since the start of the interaction. Defaults to 0. Readable only via expression/animation.

The position of the interaction source.

The instantaneous rate of change of position in the interaction, in pixels per second. Defaults to 0. Readble only via expression/animation.

The position velocity of the interaction source.

The PositionXChainingMode property defines the chaining behavior for an InteractionSource in the X direction. There are three types of InteractionChainingMode s:

Chaining mode for the X-axis.

Source mode for the X-axis.

Source mode for the X-axis.

The PositionYChainingMode property defines the chaining behavior for an InteractionSource in the Y direction. There are three types of InteractionChainingMode s:

Chaining mode for the Y-axis.

Source mode for the Y-axis.

Source mode for the Y-axis.

The total percentage-difference in scale since the start of the interaction. Multiplicative. Defaults to 1. Readable only via expression/animation.

The scale of the interaction source.

The ScaleChainingMode property defines the chaining behavior for an InteractionSource in the Scale direction. There are three types of InteractionChainingMode s: Auto, Always, Never. When Scale chaining is enabled, input will flow to the nearest ancestor’s VisualInteractionSource whenever the interaction (such as panning) would otherwise take InteractionTracker ’s position past it’s minimum or maximum Scale position.

Chaining mode for the scale axis.

Defines how interactions are processed for an VisualInteractionSource on the scale axis. There are 3 types of InteractionSourceMode s to choose from: Interactions are

Source mode for the scale axis.

The instantaneous rate of change of scale in the interaction, in percent per second. Additive. Defaults to 0. Readble only via expression/animation.

The scale velocity of the interaction source.

The visual that is used for hit-testing and defines the co-ordinate space for gesture recognition.

The visual that is used for hit-testing and defines the co-ordinate space for gesture recognition.

Takes an ordered list of CompositionConditionalValue. In a frame, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the zoom CenterPointX value the VisualInteractionSource provides with its “.Value”. If none evaluate to true, the CenterPointX is not replaced that frame.

Takes an ordered list of CompositionConditionalValue. In a frame, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the zoom CenterPointY value the VisualInteractionSource provides with its “.Value”. If none evaluate to true, the CenterPointY is not replaced that frame.

Takes an ordered list of CompositionConditionalValue. In a frame, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the DeltaPositionX value the VisualInteractionSource provides with its “.Value”. If none evaluate to true, the DeltaPositionX is not replaced that frame.

Takes an ordered list of CompositionConditionalValue. In a frame, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the DeltaPositionY value the VisualInteractionSource provides with its “.Value”. If none evaluate to true, the DeltaPositionY is not replaced that frame.

Takes an ordered list of CompositionConditionalValue. In a frame, the first CompositionConditionalValue to have its “.Condition” evaluate to true replaces the DeltaScale value the VisualInteractionSource provides with its “.Value”. If none evaluate to true, the DeltaScale is not replaced that frame.

Creates an instance of VisualInteractionSource.

The visual to use as the source of the interaction. Returns the created VisualInteractionSource object.

Creates an instance of VisualInteractionSource from an element that implements IVisualElement.

The element to use as the source of the interaction, typically a XAML UIElement. Returns the created VisualInteractionSource object.

Indicates that configured manipulations for the given pointer stream should be sent to the InteractionTracker, not the app's UI thread, starting at the given PointerPoint.

Indicates that configured manipulations for the given pointer stream should be sent to the InteractionTracker, not the app's UI thread, starting at the given PointerPoint.

Indicates what input should be redirected to the InteractionTracker.

Pointer input goes to the UI thread, Precision Touchpad input goes to the compositor.

Redirection is off, all input goes to the UI thread.

Defines constants that specify the alpha mode for a scene.

Defines constants that specify scene attribute semantics.

Represents a box that encloses a 3D scene.

Gets the center of the bounding box.

The center of the bounding box.

Gets the extents of the bounding box.

The extents of the bounding box.

Gets the maximum coordinates of the bounding box.

The maximum coordinates of the bounding box.

Gets the minimum coordinates of the bounding box.

The minimum coordinates of the bounding box.

Gets the size of the bounding box.

The size of the bounding box.

Represents a functional part of a scene.

Gets a value that indicates what kind of component this is.

A value of the enumeration that indicates what kind of component this is.

Represents a collection of SceneComponent objects that can be individually accessed by index.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The SceneComponent value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The zero-based index at which to insert the item. The object to insert into the collection.

Removes the item at the specified index.

The zero-based index of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the specified SceneComponent value.

The index at which to set the value. The value to set.

Defines constants that specify what kind a scene component is.

The component is a mesh renderer.

Represents an asset that describes how a surface is rendered.

Represents an input that influences a material.

Represents a mesh (the list of vertices that describe the polygons that make up a scene).

Gets the bounds of the mesh.

The bounds of the mesh.

Gets or sets a value that indicates how the vertex data is interpreted by the graphics pipeline and rendered on screen.

A value of the enumeration that indicates how the vertex data is interpreted.

Creates an instance of SceneMesh.

An instance of the Compositor class. Returns the created SceneMesh object.

Creates a copy of information about the mesh for use by this SceneMesh.

The attribute semantic. The pixel format. The memory buffer.

Represents a collection of material attributes for a scene mesh as key/value pairs.

Gets the number of items in the map.

The number of items in the map.

Removes all items from the map.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns an immutable view of the map.

The view of the map.

Determines whether the map contains the specified key.

The key associated with the item to locate. **true** if the key is found; otherwise, **false**.

Inserts or replaces an item in the map.

The key associated with the item to insert. The item to insert. **true** if an item with the specified key is an existing item that was replaced; otherwise, **false**.

Returns the item at the specified key in the map.

The key associated with the item to locate. The value, if an item with the specified key exists. Use the HasKey method to determine whether the key exists.

Removes an item from the map.

The key associated with the item to remove.

Represents a component that renders a SceneMesh.

Gets or sets the material that describes how the mesh surface is rendered.

The material that describes how the mesh surface is rendered.

Gets or sets the SceneMesh to be rendered.

The SceneMesh to be rendered.

Gets the UV mappings for the material to the mesh.

The UV mappings for the material to the mesh.

Creates an instance of SceneMeshRendererComponent.

An instance of the Compositor class. Returns the created SceneMeshRendererComponent object.

Represents a material that has that has the appearance of metal.

Gets or sets a value that indicates the base color.

A value that indicates the base color.

Gets or sets the input for material's base color.

The input for for material's base color.

Gets or sets a value that indicates how metallic the material appears.

A value that indicates how metallic the material appears.

Gets or sets the input for how rough or smooth the material is.

The input for how rough or smooth the material is.

Gets or sets a value that indicates how rough or smooth the material appears.

A value that indicates how rough or smooth the material appears.

Creates an instance of SceneMetallicRoughnessMaterial.

An instance of the Compositor class. Returns the created SceneMetallicRoughnessMaterial object.

Represents a group of 3-D transforms on a node, including rotation, scale, and translation.

Gets or sets the orientation of the node.

The orientation of the node.

Gets or sets the rotation angle applied to the node, in radians.

The rotation angle applied to the node, in radians.

Gets or sets the rotation angle applied to the node, in degrees.

The rotation angle applied to the node, in degrees.

Gets or sets the axes around which the node is rotated.

The axes around which the node is rotated.

Gets or sets the relative size of the node on the x, y, and z axes.

A vector that describes the relative size of the node on the x, y, and z axes.

Gets or sets the position of the node on the x, y, and z axes.

A vector that describes the position of the node on the x, y, and z axes.

Represents an element in the scene's visual tree.

Gets the collection of children of this node.

The collection of children of this node.

Gets the collection of components for this node.

The collection of components for this node.

Gets the node that this node is a child of.

The node that this node is a child of.

Gets the transform that describes the position, rotation, and scale of this node.

The transform that describes the position, rotation, and scale of this node.

Creates an instance of SceneNode.

An instance of the Compositor class. Returns the created SceneNode object.

Retrieves the first component of the specified kind.

The kind of component to find. The first component of the specified kind, if one is found.

Represents a collection of SceneNode objects that can be individually accessed by index.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The SceneNode value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the specified SceneNode value.

The index at which to set the value. The value to set.

The base class for objects that make up a 3D scene.

Represents a material that uses Physically Based Rendering (PBR).

Gets or sets the alpha cutoff for the material.

The alpha cutoff for the material.

Gets or sets the alpha mode for the material.

The alpha mode for the material.

Gets or sets the material's emissive value.

The material's emissive value.

Gets or sets the input for the material's emissive value.

The input for the material's emissive value.

Gets or sets a value that indicates whether the material has two sides.

**true** if the material has two sides, **false** if the material has one side.

Gets or sets the input for material's normal.

The input for for material's base normal.

Gets or sets the normal scale for the material.

The normal scale for the material.

Gets or sets the input for the material's occlusion.

The input for the material's occlusion.

Gets or sets the occlusion strength.

The occlusion strength.

Represents the base class for scene rendering components.

Represents an input to a composition surface.

Gets or sets the bitmap interpolation mode.

The bitmap interpolation mode.

Gets or sets the composition surface.

The composition surface.

Gets or sets a value that indicates how wrapping occurs on the U axis.

A value that indicates how wrapping occurs on the U axis.

Gets or sets a value that indicates how wrapping occurs on the V axis.

A value that indicates how wrapping occurs on the V axis.

Creates an instance of SceneSurfaceMaterialInput.

An instance of the Compositor class. Returns the created SceneSurfaceMaterialInput object.

Represents a container visual for the nodes of a 3D scene.

Gets or sets the root node for scene.

The root node for scene.

Creates an instance of SceneVisual.

An instance of the Compositor class. Returns the created SceneVisual object.

Defines constants that specify how wrapping occurs for a scene.

Provides the arguments returned by an accelerator key event callback.

Gets a unique ID for the input device that generated this key event.

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

Gets the type of the accelerator key event that invoked the callback.

The type of the accelerator key event that invoked the callback.

Gets or sets whether the accelerator key event was handled or not.

True if the accelerator key event has been handled; false if it has not.

Gets the status of the accelerator key for which the event was raised.

The status of the accelerator key.

Gets the virtual key code for the keypress in the accelerator key event.

The virtual key code of the key that was pressed.

Defines constants that specify whether the back button is shown in the system UI.

The back button is not shown and space is not reserved for it in the layout.

The back button is shown, but not enabled.

The back button is shown.

Provides the arguments returned by an automation provider request event callback.

Gets or sets the automation provider object returned by the request event callback.

The automation provider object returned by the callback.

Gets or sets whether the automation provider request event has been handled.

True if the automation provider request event has been handled; false if it has not.

Provides event data for the SystemNavigationManager.BackRequested event.

Gets or sets a value that indicates whether the app performed the requested back-navigation.

**true** if the app performed the requested back-navigation; otherwise, **false**. The default is **false**.

Provides the arguments returned by the event raised when a character is received by the input queue.

Gets or sets whether the character-received event was handled or not.

True if the character received event has been handled; false if it has not.

Gets the key code of the character received by the input queue.

The character in UTF-32 encoding.

Gets the status of the physical key press that raised the character-received event.

The status of the key that was pressed.

Provides event data for the **ClosestInteractiveBoundsRequested** event. Not intended for general use. See CoreComponentInputSource.ClosestInteractiveBoundsRequested and CoreWindow.ClosestInteractiveBoundsRequested.

Gets or sets the bounding rectangle of the interactive element that is within the SearchBounds and closest to the PointerPosition.

The bounding rectangle of the interactive element that is within the SearchBounds and closest to the PointerPosition.

Gets the client coordinates of the pointer.

The position of the pointer in device-independent pixel (DIP).

Gets or sets the bounding rectangle in which to search for interactive elements.

The bounding rectangle in which to search for interactive elements.

Specifies the set of possible accelerator key events that can invoke a callback.

A character key is pressed.

A dead character key is pressed. (A *dead character* key is a key that modifies the next keypress, like an accent character.)

A key is pressed down.

A key is raised.

A system character key is pressed.

A system dead character key is pressed.

A system key is pressed down.

A system key is raised.

A Unicode character key is pressed.

Provides the basic behavior for an accelerator key.

Fired when an accelerator key is pressed or activated.

Provides a mechanism to receive input for a XAML framework element hosted in another framework, such as a DirectX interop framework.

Gets the input event dispatcher for the hosted XAML framework element.

The CoreDispatcher for the hosted XAML framework element.

Gets the DispatcherQueue associated with this CoreComponentInputSource.

The DispatcherQueue for managing prioritized tasks that execute in a serial fashion on a thread.

Indicates whether the input device supports input capture.

**true** if the input device supports capture (recording of input data); **false** if it does not.

Gets whether the current hosted XAML control element has focus. If it does, keyboard input is delivered to that control.

**true** if the element has focus; **false** if it does not.

Gets or sets whether input is enabled for the hosted XAML framework element.

**true** if input is enabled; **false** if it is not.

Gets the pointer cursor behavior for interactions with the hosted XAML framework element.

The pointer cursor object.

Gets the current pointer position in the hosted XAML framework.

The current pointer position.

Raised when a character is received (such as from a completed key press sequence) by the hosted XAML element.

Occurs when a framework input manager requests the bounding rectangle of an interactive element within a specific bounding rectangle and closest to a specific pointer.

Raised when a hosted XAML element gets focus.

Raised when the hosted XAML control is enabled for input.

Raised when a key is pressed for the current active hosted XAML element.

Raised when a key press is released for the current active hosted XAML element.

Raised when a hosted XAML element loses focus.

Raised when the pointer input capture stream is lost.

Raised when the pointer enters the hosted XAML element.

Raised when the pointer exits the hosted XAML element.

Raised when the pointer is moved for the active hosted XAML element.

Raised when the pointer is "pressed" (such as a mouse button click or full screen press) for the active hosted XAML element.

Raised when the pointer is released (such as when a mouse button click or screen press is released) for the active hosted XAML element.

Raised when the mouse wheel is rotated for the active hosted XAML element.

Raised for a touch hit test on a hosted XAML element.

Retrieves the unique ID for the input device that generated this key event.

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

Gets the current status of a virtual key press.

The key from which to retrieve status. The flags indicating the current state of the supplied virtual key when the input event fired.

Stops the capture of pointer input data (if the pointing device supports input capture).

Starts the capture of pointer input data (if the pointing device supports input capture).

Defines a cursor (visual pointer) object.

Creates a new CoreCursor instance of the provided cursor type.

The type of the new cursor. The unique resource ID of the new cursor.

Gets the resource ID of the cursor.

The ID of the cursor.

Gets the type of the cursor.

The type of the cursor.

Specifies the set of cursor types.

The left-upward (northwest) arrow Windows cursor.

The "cross" Windows cursor.

A custom cursor.

The "hand" Windows cursor.

The left-upward (northwest) arrow Windows cursor with a question mark.

The "I"-shaped Windows cursor used for text selection.

The "hand" Windows cursor with a person symbol.

The "hand" Windows cursor with a pin symbol.

The "cross arrow" Windows cursor used for user interface (UI) element sizing.

The "right-upward, left-downward" dual arrow Windows cursor often used for element sizing.

The up-down dual arrow Windows cursor often used for vertical (height) sizing.

The "left-upward, right-downward" dual arrow Windows cursor often used for element sizing.

The left-right dual arrow Windows cursor often used for horizontal (width) sizing.

The red "circle slash" Windows cursor often used to indicate that a UI behavor cannot be performed.

The up arrow Windows cursor.

The cycling Windows "wait" cursor often used to indicate that an element or behavior is in a wait state and cannot respond at the time.

Provides the Windows Runtime core event message dispatcher. Instances of this type are responsible for processing the window messages and dispatching the events to the client.

Gets and sets the priority of the current task.

A CoreDispatcherPriority enumeration value that specifies the priority of the current task.

Gets a value that specifies whether the event dispatcher provided by this instance of CoreWindow has access to the current thread or not.

True if the event dispatcher has thread access; false it does not.

Fired when an accelerator key is activated (pressed or held down).

Starts the dispatcher processing the input event queue for this instance of CoreWindow.

Determines how many events to process, and if this method should block.

Schedules the provided callback on the UI thread from a worker thread, and returns the results asynchronously.

Specifies the priority for event dispatch. Set this to CoreDispatcherPriority.Normal. The callback on which the dispatcher returns when the event is dispatched. The object that provides handlers for the completed async event dispatch.

Schedules a callback on the UI thread from a worker thread at idle priority, and returns the results asynchronously.

The callback on which the idle priority dispatcher returns when the event is dispatched. Object that contains the results of the asynchronous action.

Queries whether the caller should yield if there are items in the task queue of higher priority than the current task.

**true** if the current work item should yield to higher priority work; **false** if it should not.

Queries whether the caller should yield if there are items in the task queue of the specified priority or higher.

The minimum priority level for which the current work item should yield. **true** if the current work item should yield to higher priority work; **false** if it should not.

Stops the dispatcher from processing any queued events.

Attempts to schedule the specified callback on the UI thread from a worker thread, and returns the results asynchronously.

Specifies the priority for event dispatch. Set this to CoreDispatcherPriority.Normal. The callback on which the dispatcher returns when the event is dispatched. The asynchronous operation.

Attempts to schedule a callback on the UI thread from a worker thread at idle priority, and returns the results asynchronously.

The callback on which the idle priority dispatcher returns when the event is dispatched. The asynchronous operation.

Defines the priority for window event dispatches.

High priority. Delegates are invoked immediately for all synchronous requests. Asynchronous requests are queued and processed before any other request type.

Lowest priority. Use this priority for background tasks. Delegates are processed when the window's main thread is idle and there is no input pending in the queue.

Low priority. Delegates are processed if there are no higher priority events pending in the queue.

Normal priority. Delegates are processed in the order they are scheduled.

Surfaces core input API for interoperation scenarios.

Gets the event dispatcher for the window.

The CoreDispatcher for the window.

Gets the DispatcherQueue associated with this CoreIndependentInputSource.

The DispatcherQueue for managing prioritized tasks that execute in a serial fashion on a thread.

Gets a value that reports whether the window has pointer capture.

**true** if the window has pointer capture; otherwise, **false**.

Gets or sets a value that indicates whether input is enabled for the UWP app.

**true** if input is enabled for the app; **false** if it is disabled.

Gets or sets the cursor used by the UWP app.

The app's cursor.

Gets the client coordinates of the pointer.

The position of the pointer in device-independent pixel (DIP).

Occurs when input is enabled or disabled for the UWP app.

Occurs when a pointer moves to another UWP app. This event is raised after PointerExited and is the final event received by the app for this pointer.

Occurs when a pointer moves into the bounding box of the UWP app.

Occurs when the pointer moves outside the bounding box of the UWP app.

Occurs when a pointer moves within the bounding box of the UWP app.

Occurs when a mouse button is clicked, or a touch or pen contact is detected, within the bounding rectangle of the UWP app.

Occurs when a mouse button is released, or a touch or pen contact is lifted, within the bounding rectangle of the UWP app.

Occurs when the wheel button is rotated.

Disables pointer capture for the UWP app.

Enables pointer capture for the UWP app.

Specifies user input modalities. These values can be combined.

Expose mouse input events.

No input.

Expose pen input events.

Expose touch input events.

Specifies the set of physical key status items that can be obtained.

Whether the key that was pressed maps to an extended ASCII character.

Whether a key has moved from a pressed to a released status.

Whether the menu key is currently pressed down.

The number of times a key was pressed.

The scan code for a key that was pressed.

Whether a key is currently pressed down.

Specifies the set of exclusive event-processing options passed to ProcessEvents.

Dispatch all events currently pending in the queue. If no events are pending, do not wait for a new event to be raised but instead return immediately. This option is provided specifically for view provider implementations with IFrameworkView, and to be used in UWP app using DirectX with C++.

Dispatch all currently available events in the queue. If no events are pending, wait for the next new event.

Dispatch one event if it is currently pending in the queue. If no events are pending, do not wait for a new event to be raised but instead return immediately.

Wait for new events and dispatch all available events. Continue this behavior until the window is closed or the application calls the Close method on the CoreWindow instance.

Contains the rank of an object as the probable target of the touch contact area.

Adjusted touch point that hits the closest object identified by the value of **Score**.

Rank of an object as the probable target compared to the other objects that intersect the touch contact area. The value is a CoreProximityEvaluationScore.

Specifies the rank of an object as the probable target, relative to other objects that intersect the touch contact area.

The object is the most probable target.

The object is the least probable target.

Specifies flags for indicating the possible states of a virtual key.

The key is pressed down for the input event.

The key is in a toggled or modified state (for example, Caps Lock) for the input event.

The key is up or in no specific state.

Represents the UWP app with input events and basic user interface behaviors.

Gets a value that indicates the activation state of the window.

A value that indicates the activation state of the window.

Gets the automation provider assigned to this window.

The automation provider for this window.

Gets the bounding rectangle of the window.

The bounding rectangle of the window, in device-independent pixels (DIPs).

Gets the set of custom properties for the window.

The set of custom properties for the window, represented as tuples.

Gets the event dispatcher for the window.

The event dispatcher for the window.

Gets the **DispatcherQueue** for the window.

The **DispatcherQueue**.

Gets or sets the horizontal origin of the window's reading order alignment. If the language specified by the user interface is right-aligned (such as in Arabic or Hebrew), the horizontal origin of the reading layout for the window is on the right edge.

The flow direction of the window's reading layout.

Gets or sets a value that indicates whether input is enabled for the app.

True if input is enabled for the app; false if it is disabled.

Gets or sets the cursor used by the app.

The app's cursor.

Gets the client coordinates of the pointer.

The position of the pointer in device-independent pixel (DIP).

Gets the context identifier for the core window.

The context identifier for the core window.

Gets a value that indicates whether the window is visible.

True if the window is visible on the screen; false if it is not.

Is fired when the window completes activation or deactivation.

Is fired when a request for an automation handler is generated.

Is fired when a new character is received by the input queue.

Is fired when the app terminates.

Occurs when a framework input manager requests the bounding rectangle of an interactive element within a specific bounding rectangle and closest to a specific pointer.

Occurs when input is enabled or disabled for the app.

Is fired when a non-system key is pressed.

Is fired when a non-system key is released after a press.

Occurs when a pointer moves to another app. This event is raised after PointerExited and is the final event received by the app for this pointer.

Occurs when a pointer moves into the bounding box of the app.

Occurs when the pointer moves outside the bounding box of the app.

Occurs when a pointer moves within the bounding box of the app.

Occurs when a mouse button is clicked, or the digitizer surface has been touched by a finger or pen, within the bounding rectangle of the app.

Occurs when a pressed mouse button is released, or a touch or pen contact is lifted from the digitizer surface, within the bounding rectangle of the app (or outside the bounding rectangle, if the pointer is captured).

Occurs on the process receiving input when the pointer input is routed to another process.

Occurs on a process associated with, but not currently receiving input from, a pointer that fires a PointerReleased event on a different process.

Occurs on the process not currently receiving input, but designated to begin receiving input from another process.

Occurs when the wheel button is rotated.

Occurs when a user finishes resizing the window.

Occurs when a user starts to resize the window.

Occurs when the window size is changed.

Occurs when a touch contact area intersects the bounding rectangle (or polygon) of a window that is registered for touch hit testing.

Is fired when the window visibility is changed.

Activates the window. This method is called to present the window on the screen.

Closes a secondary window and exits the message loop.

Asynchronously retrieves the state of a virtual key.

The virtual key for which state is returned. The flags indicating the current state of the supplied virtual key when the input event fired.

Retrieves the unique ID for the input device that generated this key event.

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

Gets the CoreWindow instance for the currently active thread.

The CoreWindow for the currently active thread.

Retrieves the state of a virtual key.

The virtual key for which state is returned. The flags indicating the current state of the supplied virtual key when the input event fired.

Dissociates pointer input from the app, if previously associated through SetPointerCapture, and restores normal pointer input processing.

Associates pointer input with the app. Once a pointer is captured, all subsequent events associated with that pointer are fired by the app.

Defines constants that specify the activation state of a window.

The window is activated and in the foreground.

The window is activated, but not in the foreground.

The window is deactivated.

No state is specified.

Specifies the set of reasons that a CoreWindow 's Activated event was raised.

The window was activated by a call to Activate.

The window was deactivated.

The window was activated by pointer interaction.

Contains the set of arguments returned to an app after a window input or behavior event.

Specifies the property that gets or sets whether the event was handled.

True if the event has been handled by the appropriate delegate; false if it has not.

Specifies the flow order for text in a window.

Text is flowed from left to right.

Text is flowed from right to left. (For example, this can be used with Arabic script or other RTL languages.)

Defines a type used to manage CoreWindow.SizeChanged events. This type is used by frameworks (such as XAML) or apps that implement their own IFrameWorkView to synchronize the handover between shell drawn placholder (such as a splash screen) and the apps first drawn frame, so that there is no gap in the transition from one to the other. If your app does not implement the IFrameWorkView itself you should not participate in this synchronization as the framwork will do it for you.

Gets or sets whether the caller should wait for the new layout to complete.

**true** if the caller should wait for the new layout to complete; **false** if it should not.

Gets an instance of CoreWindowResizeManager for the running app's current CoreWindow.

An instance of CoreWindowResizeManager for the running app's current CoreWindow.

Notifies the parent CoreWindow object that the new layout has completed.

Represents the method that handles CoreWindow dispatch events.

Provides an interface that defines the basic behavior for an accelerator key.

Defines the event that is fired when an accelerator key is pressed or activated.

Defines the base interface for an input source used by a CoreWindow.

Gets the event dispatcher for the window.

The event dispatcher for the window.

Gets or sets a value that indicates whether input is enabled for the UWP app.

True if input is enabled for the app; false if it is disabled.

Occurs when input is enabled or disabled for the UWP app.

Defines the behavior of pointer input (for processing on a worker thread).

Occurs if the pointer input source has capture functionality.

True if the pointer input source has capture functionality; false if it does not.

Gets or sets the current pointer cursor type.

The current pointer cursor.

Gets the current position of the pointer in screen coordinates.

The current position of the pointer, in screen coordinates.

Occurs when the pointer input capture stream fails or is lost.

Occurs when the pointer enters a UI element.

Occurs when the pointer exits a UI element.

Occurs when the pointer is moved.

Occurs when a press action (such as a screen press or mouse click) is received for the pointer.

Occurs when a release action (such as a screen press-release or mouse click-release) is received for the pointer.

Occurs when the pointer wheel (mouse or virtual) has changed position.

Stops the capture of pointer input data.

Starts the capture of pointer input data, if the pointer input device supports it.

Defines the behavior of pointer input (for processing on a worker thread).

Gets the DispatcherQueue associated with a platform object.

The DispatcherQueue for managing prioritized tasks that execute in a serial fashion on a thread.

Defines pointer events for cross-process input handling.

Occurs on the process receiving input when the pointer input is routed to another process.

Occurs on all processes ever associated with, but not currently receiving input from, a pointer that fires a PointerReleased event on the current process.

Occurs on the process not currently receiving pointer input when ongoing pointer input, for an existing pointer ID, transitions from one process to another.

Specifies an interface for a window object and its input events as well as basic user interface behaviors.

Specifies the property that gets the automation provider assigned to this window.

The automation provider for this window.

Specifies the property that gets the bounding rectangle of the window.

The bounding rectangle of the window, in device-independent pixel (DIP).

Specifies a property that gets the set of custom properties for the window.

The set of custom properties for the window, represented as tuples.

Specifies a property that gets the event dispatcher for the window.

The event dispatcher for the window.

Specifies the property that gets or sets the horizontal origin of the window's reading order alignment. If the language specified by the user interface is right-aligned (such as in Arabic or Hebrew), the horizontal origin of the reading layout for the window is on the right edge.

The flow direction of the window's reading layout.

Specifies a property that gets or sets whether input is enabled for the window.

True if input is enabled for the window; false if it is disabled.

Specifies a property that gets or sets the cursor used by the window.

The window's cursor.

Specifies a property that gets the position of the pointer.

The current position of the cursor in device-independent pixels (DIPs).

Specifies the property that gets whether the window is visible or not.

True if the window is visible on the screen; false if it is not.

Specifies the event that is fired when the window completes activation or deactivation.

Specifies the event that is fired when a request for an automation handler is generated.

Specifies the event that is fired when a new character is received by the input queue.

Specifies the event that is fired when a window is closed (or the app terminates altogether).

Specifies an event that occurs when input is enabled or disabled for the window.

Specifies the event that is fired when a non-system key is pressed down.

Specifies the event that is fired when a non-system key is released after a press.

Specifies the event that occurs when a pointer moves to another window. This event is fired after PointerExited and is the final pointer event that is raised for a window.

Specifies the event that occurs when a pointer moves into the bounding box of the window.

Specifies the event that occurs when the pointer moves outside the bounding box of the window.

Specifies the event that occurs when a pointer moves within the bounding box of the window.

Occurs when a mouse button is clicked, or the digitizer surface has been touched by a finger or pen, within the bounding rectangle of the app.

Occurs when a pressed mouse button is released, or a touch or pen contact is lifted from the digitizer surface, within the bounding rectangle of the app (or outside the bounding rectangle, if the pointer is captured).

Specifies the event that occurs when the mouse wheel is rotated.

Specifies the event that raises when the window size is changed.

Specifies the event that occurs when a touch contact area falls within a window that is registered for touch hit testing.

Specifies the event that occurs when the window visibility is changed.

Specifies a method that activates the window. This method is called to present the window on the screen.

Specifies the method that closes the window and exits the message loop.

Specifies a method that returns the state of a virtual key asynchronously.

The virtual key for which state will be returned. The state of the supplied virtual key when the input event was raised.

Specifies a method that gets the state of a key.

The virtual key for which state will be returned. The state of the supplied virtual key when the input event was raised.

Specifies a method that dissociates pointer input from the app, if previously associated through SetPointerCapture, and restores normal pointer input processing.

Specifies a method that associates pointer input with the app. Once a pointer is captured, all subsequent events associated with that pointer are fired by the app.

Defines the set of arguments returned to an app after a window input or behavior event.

Specifies the property that gets or sets whether the event was handled.

True if the event has been handled by the appropriate delegate; false if it has not.

Represents the method that handles CoreWindow idle priority dispatch events. It is invoked when CoreDispatcher.RunIdleAsync is called.

The set of arguments returned by the callback.

Defines the arguments returned by a IdleDispatchedHandler callback.

Gets a value that indicates whether the event dispatcher's message queue is empty or not.

**true** if the event dispatcher's message queue is empty; **false** if it is not.

Defines the initialization behavior for apps that use CoreWindow.

Specifies the method that provides the initial CoreWindow instance for an app.

The new app window.

Contains the window input state returned by the CoreWindow.InputEnabled event.

Gets or sets whether the input enable event was handled.

True if the input enable event was handled by the appropriate delegate; false if it was not.

Gets whether the window is enabled for input.

True if the window is enabled for input; false if it is not.

Contains the arguments returned by a virtual key event.

Gets a unique ID for the input device that generated this key event.

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

Gets or sets whether the key press event was handled.

True if the key press event has been handled by the appropriate delegate; false if it has not.

Gets the status of a key at the time the event is fired.

The status of the key.

Gets the virtual key that maps to the key that was pressed.

The virtual key value.

Contains the arguments returned by the last pointer event.

Gets the pointer data of the last pointer event.

Information about the state and screen position of the pointer.

Gets or sets whether the pointer event was handled.

True if the pointer event has been handled by the appropriate delegate; false if it has not.

Gets the keyboard key or keys used to modify the pointer input, such as the "Ctrl" key when pressed in conjunction with another key, as in Ctrl+C.

The active key modifiers.

Retrieves the pointer data for up to the last 64 pointer locations since the last pointer event.

The data for each pointer.

Provides a way for an app to respond to system provided back-navigation events.

Gets or sets a value that indicates whether a back button is shown in the system UI.

One of the enumeration values that specifies whether a back button is shown in the system UI. The default is **Collapsed**.

Occurs when the user invokes the system provided button, gesture, or voice command for back-navigation.

Returns the SystemNavigationManager object associated with the current window.

The SystemNavigationManager object associated with the current window.

Contains the arguments returned by the TouchHitTesting event.

Gets the bounding rectangle of the touch contact area.

Bounding rectangle of the touch contact area.

Gets or sets a value indicating whether the TouchHitTesting event was handled.

True if the event is handled; otherwise, false.

Gets the screen coordinates of the touch point reported by the touch digitizer.

Screen position of the input pointer, in device-independent pixel (DIP).

Gets or sets the proximity evaluation score for an object relative to the touch contact area.

Proximity evaluation of an object.

Returns a ranking for the polygon as the probable touch target and an adjusted touch point within the polygon. The rank is determined through a comparison of targeting heuristics for all polygons that intersect the touch contact area.

The array of x-y screen coordinates that define the shape of the UI element (the number of vertices in the polygon). This value must be greater than or equal to 3. The CoreProximityEvaluation structure that holds the rank and adjusted touch point data.

Returns a ranking for the rectangle as the probable touch target and an adjusted touch point within the rectangle. The rank is determined through a comparison of targeting heuristics for all rectangles that intersect the touch contact area.

The Rect that defines the bounding box of the UI element. The CoreProximityEvaluation structure that holds the rank and adjusted touch point data.

Contains the arguments returned by the event fired when a CoreWindow instance's visibility changes.

Gets or sets a value indicating whether the VisibilityChanged event was handled.

True if the event is handled; otherwise, false.

Gets whether the window is visible or not.

True if the window is visible; otherwise, false.

Contains the windows activation state information returned by the CoreWindow.Activated event.

Specifies the property that gets or sets whether the window activation event was handled.

True if the window activation event has been handled by the appropriate delegate; false if it has not.

Gets the activation state of the window at the time the Activated event was raised.

The activation state.

Contains the argument returned by a window size change event.

Gets or sets whether the window size event was handled.

True if the window size event has been handled by the appropriate delegate; false if it has not.

Gets the new size of the window in units of effective (view) pixels.

The new size of the window.

Represents an app window and its thread.

Retrieves the ID from the specified app window.

The app window to get the ID from. The ID from the specified app window.

Provides event data for the SystemNavigationManagerPreview.CloseRequested event.

Gets or sets a value that indicates whether the close request is handled by the app.

**true** if the app has handled the close request; otherwise, **false**. The default is **false**.

Returns a Deferral object for the CloseRequested event.

A Deferral object for the CloseRequested event.

Provides a way for an app to respond to system provided close events.

Occurs when the user invokes the system button for close (the 'x' button in the corner of the app's title bar).

Returns the SystemNavigationManagerPreview object associated with the current window.

The SystemNavigationManagerPreview object associated with the current window.

Base class for an InputActivationListener object associated with a window, view, or other visual element.

Terminates the AttachableInputObject instance.

Contains the distance thresholds for a CrossSliding interaction.

The distance, in device-independent pixel (DIP), from the initial point of contact until the rearrange action is initiated.

The distance, in device-independent pixel (DIP), from the initial point of contact until the selection action is initiated.

The distance, in device-independent pixel (DIP), from the initial point of contact until the end of the speed bump.

The distance, in device-independent pixel (DIP), from the initial point of contact until the speed bump is initiated.

Contains event data for the CrossSliding event.

Gets the number of contact points at the time the CrossSliding event is recognized.

The number of contact points.

Gets the state of the CrossSliding event.

State of the CrossSliding event.

Gets the device type of the input source.

The device type.

Gets the location of the touch contact.

The screen coordinates, in device-independent pixel (DIP).

Specifies the possible states of the CrossSliding event.

The swipe or slide gesture has stopped, the CrossSliding interaction has been completed, and the touch contact lifted.

A CrossSliding interaction has started but the swipe or slide gesture has not crossed the minimum distance threshold for a selection action. (See the Remarks section for a diagram showing the CrossSliding distance thresholds.)

The swipe or slide gesture has crossed the minimum distance threshold of the rearrange action. This state is valid only when RearrangeStart is enabled in a GestureRecognizer.

The swipe or slide gesture has crossed the minimum distance threshold for a selection action but has not crossed the minimum distance threshold of the rearrange action. This state is valid only when SpeedBumpStart is disabled in a GestureRecognizer.

The swipe or slide gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when both SpeedBumpStart and SelectionStart are enabled in a GestureRecognizer.

The swipe or slide gesture has crossed the minimum distance threshold for a selection action (and the selection speed bump) but has not crossed the maximum distance threshold of the selection speed bump. This state is valid only when SpeedBumpStart is enabled and SelectionStart is disabled in a GestureRecognizer.

A CrossSliding interaction has been detected.

Contains event data for the Dragging event.

Gets the number of contact points at the time the Dragging event is recognized.

The number of contact points.

Gets the state of the Dragging event.

State of the Dragging event.

Gets the device type of the input source.

The device type.

Gets the location of the mouse or pen/stylus contact.

The screen coordinates, in device-independent pixel (DIP).

Specifies the possible states of the Dragging event.

The mouse or pen/stylus contact is lifted and inertia has concluded.

The dragging interaction is in progress.

A dragging interaction has been detected.

Provides access to the events that notify an app of triggers to its edge-based UI.

Fires when a user cancels a show or hide action for an edge-based UI.

Fires to indicate that the user has successfully summoned or dismissed the edge-based UI. This occurs either when the user lifts his or her finger from a touch-enabled screen or when the user presses Win+Z on the keyboard.

Fires when a user begins an action to summon or dismiss edge-based UI.

Gets an instance of the EdgeGesture class that is used to add and remove event delegate handlers for the current view.

The currently relevant instance of the EdgeGesture object.

Provides access to the type of user input that triggered the edge gesture event.

Gets the type of user input that triggered the edge gesture event.

The user input type.

Specifies the type of user input that triggered the edge gesture event.

The user entered the Win+Z key sequence on the keyboard.

The user performed a right mouse click.

The user made a swipe gesture on a touch-enabled screen.

Specifies the permission state for tracking the user's gaze.

The user has given permission for the app to to track their gaze.

The system has denied permission for the app to track the user's gaze.

The user has denied permission for the app to track their gaze.

The user has not specified whether the app can track their gaze.

Provides gesture and manipulation recognition, event listeners, and settings.

Initializes a new instance of a GestureRecognizer object.

Gets or sets a value that indicates whether manipulations during inertia are generated automatically.

True if manipulations are generated automatically; otherwise false. The default value is true.

Gets or sets a value that indicates whether the exact distance from initial contact to end of the cross-slide interaction is reported.By default, a small distance threshold is subtracted from the first position reported by the system for cross-slide interactions. If this flag is set, the distance threshold is not subtracted from the initial position.

True if the distance threshold is not subtracted; otherwise false. The default value is false.

Gets or sets a value that indicates whether the cross-slide axis is horizontal.

True if the cross-slide axis is horizontal; otherwise false. The default value is false.

Gets or sets values that indicate the distance thresholds for a CrossSliding interaction.

By default, every value in CrossSlideThresholds is set to 0.0 (CrossSliding functionality is disabled).

Gets or sets a value that indicates the gesture and manipulation settings supported by an application.

The gesture settings supported by an application. The value of this property is a bitwise OR of members of GestureSettings enumeration.

Gets or sets the maximum number of contact points needed to recognize a Windows.UI.Input.GestureRecognizer.Holding event.

The number of contact points.

Gets or sets the minimum number of contact points needed to recognize a Windows.UI.Input.GestureRecognizer.Holding event.

The number of contact points.

Gets or sets the radius of the contact points recognized for the Windows.UI.Input.GestureRecognizer.Holding event.

The radius of the contact points, in device-independent pixels (DIP).

Gets or sets the time threshold at which the contacts are recognized for the Windows.UI.Input.GestureRecognizer.Holding event.

The TimeSpan.

Gets or sets a value that indicates the relative change in size of an object from the start of inertia to the end of inertia (when resizing, or scaling, is complete).

The relative change in size, in device-independent pixel (DIP).

Gets or sets a value that indicates the rate of deceleration from the start of inertia to the end of inertia (when the resizing, or expansion, manipulation is complete).

The rate of deceleration, in device-independent pixel (DIP)/ms².

Gets or sets a value that indicates the final angle of rotation of an object at the end of inertia (when the rotation manipulation is complete).

The relative change in angle of rotation, in degrees.

Gets or sets a value that indicates the rate of deceleration from the start of inertia to the end of inertia (when the rotation manipulation is complete).

The rate of deceleration, in degrees/ms².

Gets or sets a value that indicates the rate of deceleration from the start of inertia to the end of inertia (when the translation manipulation is complete).

The rate of deceleration, in device-independent pixel (DIP)/ms².

Gets or sets a value that indicates the relative change in the screen location of an object from the start of inertia to the end of inertia (when the translation manipulation is complete).

The relative change in screen location, in device-independent pixel (DIP).

Gets a value that indicates whether an interaction is being processed.

True if the interaction (including inertia) is still being processed; otherwise false. The default value is false.

Gets a value that indicates whether a manipulation is still being processed during inertia (no input points are active).

True if the manipulation is still being processed during inertia; otherwise false. The default value is false.

Gets or sets a value that indicates whether the exact distance from initial contact to end of the interaction is reported.By default, a small distance threshold is subtracted from the first delta reported by the system. This distance threshold is intended to account for slight movements of the contact when processing a tap gesture. If this flag is set, the distance threshold is not subtracted from the first delta.

True if the distance threshold is subtracted; otherwise false. The default value is false.

Gets a set of properties that are associated with the wheel button of a mouse device.

The collection of wheel button properties. The system defaults should be checked to ensure the best user experience for your app.

Gets or sets the center point for a rotation interaction when single pointer input is detected.

The screen location for the center of rotation, in device-independent pixel (DIP).

Gets or sets the radius, from the PivotCenter to the pointer input, for a rotation interaction when single pointer input is detected.

The offset between the PivotCenter point and the single pointer input, in device-independent pixel (DIP).

Gets or sets a value that indicates whether visual feedback is displayed during an interaction.

True if feedback is displayed; otherwise false. The default is true.

Gets or sets the maximum number of contact points needed to recognize a Windows.UI.Input.GestureRecognizer.Tapped event.

The number of contact points.

Gets or sets the minimum number of contact points needed to recognize a Windows.UI.Input.GestureRecognizer.Tapped event.

The number of contact points.

Gets or sets the maximum number of contact points needed to recognize a translation (or panning) event.

The number of contact points.

Gets or sets the minimum number of contact points needed to recognize a translation (or panning) event.

The number of contact points.

Occurs when a user performs a slide or swipe gesture (through a single touch contact) within a content area that supports panning along a single axis only. The gesture must occur in a direction that is perpendicular to this panning axis.

Occurs when a user performs a slide or swipe gesture with a mouse or pen/stylus (single contact).

Occurs when a user performs a press and hold gesture (with a single touch, mouse, or pen/stylus contact).

Occurs when the input points are lifted and all subsequent motion (translation, expansion, or rotation) through inertia has ended.

Occurs when all contact points are lifted during a manipulation and the velocity of the manipulation is significant enough to initiate inertia behavior (translation, expansion, or rotation continue after the input pointers are lifted).

Occurs when one or more input points have been initiated and subsequent motion (translation, expansion, or rotation) has begun.

Occurs after one or more input points have been initiated and subsequent motion (translation, expansion, or rotation) is under way.

Occurs when the pointer input is interpreted as a right-tap gesture, regardless of input device.

Occurs when the pointer input is interpreted as a tap gesture.

Identifies whether a tap can still be interpreted as the second tap of a double tap gesture.

The last input pointer. True if a UI element supports the double tap gesture and the time threshold to complete the gesture has not been crossed; otherwise false.

Causes the gesture recognizer to finalize an interaction.

Processes pointer input and raises the GestureRecognizer events appropriate to a pointer down action for the gestures and manipulations specified by the GestureSettings property.

The input point.

Performs inertia calculations and raises the various inertia events.

Processes pointer input and raises the GestureRecognizer events appropriate to a mouse wheel action for the gestures and manipulations specified by the GestureSettings property.

The input point. True if the Shift key is pressed; otherwise false. True if the Ctrl key is pressed.

Processes pointer input and raises the GestureRecognizer events appropriate to a pointer move action for the gestures and manipulations specified by the GestureSettings property.

The pointer location history based on the PointerId . If no history is available then the value is the current location of the input pointer.

Processes pointer input and raises the GestureRecognizer events appropriate to a pointer up action for the gestures and manipulations specified by the GestureSettings property.

The input point.

Specifies the interactions that are supported by an application.

Enable support for the CrossSliding interaction when using the slide or swipe gesture through a single touch contact.This gesture can be used for selecting or rearranging objects.

Enable support for the double-tap gesture.

Enable support for the slide or swipe gesture with a mouse or pen/stylus (single contact). The Dragging event is raised when either gesture is detected.This gesture can be used for text selection, selecting or rearranging objects, or scrolling and panning.

Enable support for the press and hold gesture (from a single touch or pen/stylus contact). The Holding event is raised if a time threshold is crossed before the contact is lifted, an additional contact is detected, or a gesture is started.

Enable support for the press and hold gesture through the left button on a mouse. The Holding event is raised if a time threshold is crossed before the left button is released or a gesture is started.This gesture can be used to display a context menu.

Enable panning and disable zoom when two or more touch contacts are detected.Prevents unintentional zoom interactions when panning with multiple fingers.

Enable support for the rotation gesture through pointer input. The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.

Enable support for rotation inertia after the rotate gesture (through pointer input) is complete. The ManipulationInertiaStarting event is raised if inertia is enabled.

Enable support for the pinch or stretch gesture through pointer input.These gestures can be used for optical or semantic zoom and resizing an object. The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.

Enable support for scaling inertia after the pinch or stretch gesture (through pointer input) is complete. The ManipulationInertiaStarting event is raised if inertia is enabled.

Enable support for translation inertia after the slide gesture (through pointer input) is complete. The ManipulationInertiaStarting event is raised if inertia is enabled.

Enable support for the slide gesture through pointer input, on the horizontal axis using rails (guides). The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.This gesture can be used for rearranging objects.

Enable support for the slide gesture through pointer input, on the vertical axis using rails (guides). The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.This gesture can be used for rearranging objects.

Enable support for the slide gesture through pointer input, on the horizontal axis. The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.This gesture can be used for rearranging objects.

Enable support for the slide gesture through pointer input, on the vertical axis. The ManipulationStarted, ManipulationUpdated, and ManipulationCompleted events are all raised during the course of this interaction.This gesture can be used for rearranging objects.

Disable support for gestures and manipulations.

Enable support for a right-tap interaction. The RightTapped event is raised when the contact is lifted or the mouse button released.

Enable support for the tap gesture.

Contains event data for the Holding event.

Gets the number of contact points at the time the Holding event is recognized.

The number of contact points.

Gets the current number of contact points for the ongoing Windows.UI.Input.GestureRecognizer.Holding event.

The number of contact points.

Gets the state of the Holding event.

State of the Holding event.

Gets the device type of the input source.

The device type.

Gets the location of the touch, mouse, or pen/stylus contact.

The screen coordinates, in device-independent pixel (DIP).

Specifies the state of the Holding event.

An additional contact is detected, a subsequent gesture (such as a slide) is detected, or the CompleteGesture method is called.

The single contact is lifted.

A single contact has been detected and a time threshold is crossed without the contact being lifted, another contact detected, or another gesture started.

Provides the ability to access and observe changes to the activation state of a window, view, or other visual element.

Gets the activation state of the window, view, or other visual element.

The activation state of the window, view, or other visual element.

Occurs when the window, view, or other visual element completes transition to a new activation state.

Contains event data for the InputActivationChanged event.

Gets the activation state of a window, view, or other visual element.

The activation state of the window, view, or other visual element.

Specifies all possible activation states for a view, window, or other user interface element.

The window is activated and in the foreground.

The window is activated, but not in the foreground.

The window is deactivated.

No state is specified.

Provides generalized transformation functions.

Gets the inverse of the specified transformation.

The inverse of the pointer transformation.

Transforms the specified bounding rectangle.

The bounding rectangle to transform. The smallest, axis-aligned bounding box that encloses *rect* after the transformation. (An axis-aligned bounding box is one which has all sides parallel to the coordinate axes.)

Attempts to perform the transformation on the specified input point.

The original input point. The transformed input point. True if *inPoint* was transformed successfully; otherwise, false.

Enables an app to override the system processing of raw keyboard input, including key combinations such as shortcut keys, access keys (or hot keys), accelerator keys, and application keys.

Gets or sets whether the app overrides the system processing of raw keyboard input, including key combinations such as shortcut keys, access keys (or hot keys), accelerator keys, and application keys.

True if the app processes raw keyboard input instead of the system. Otherwise, false.

Occurs when a keyboard key is pressed. State info and event data is routed through this event instead of CoreWindow.KeyDown.

Occurs when a pressed keyboard key is released. State info and event data is routed through this event instead of CoreWindow.KeyUp.

Retrieves a KeyboardDeliveryInterceptor object associated with the current app view.

The KeyboardDeliveryInterceptor object associated with the current app.

Contains event data for the ManipulationCompleted event.

Gets the number of contact points at the time the ManipulationCompleted event is recognized.

The number of contact points.

Gets values that indicate the accumulated transformation deltas (translation, rotation, scale) of a completed manipulation (from the start of the manipulation to the end of inertia).

The accumulated transformation values since a ManipulationStarted event.

Gets the current number of contact points for the ongoing Windows.UI.Input.GestureRecognizer.ManipulationCompleted event.

The number of contact points.

Gets the device type of the input source.

The device type.

Gets the location of the pointer associated with the manipulation for the last manipulation event.

The screen coordinates, in device-independent pixel (DIP).

Gets values that indicate the velocities of the transformation deltas (translation, rotation, scale) for a manipulation at the ManipulationCompleted event.

The velocities of the accumulated transformations since a ManipulationStarted event.

Contains the accumulated transformations for the current manipulation.

The change in distance between touch contacts, as device-independent pixel (DIP). For example, if the distance between two contacts changes from 100 device-independent pixel (DIP) to 200 device-independent pixel (DIP) during a manipulation, the value of **Expansion** would be 100.0.

The change in angle of rotation, in degrees.

The change in distance between touch contacts, as a percentage. For example, if the distance between two contacts changes from 100 device-independent pixel (DIP) to 200 device-independent pixel (DIP) during a manipulation, the value of **Scale** would be 1.0.

The change in x-y screen coordinates, in device-independent pixel (DIP).

Contains event data for the GestureRecognizer.ManipulationInertiaStartingEvent.

Gets the number of contact points at the time the ManipulationInertiaStarting event is recognized.

The number of contact points.

Gets values that indicate the accumulated transformation deltas (translation, rotation, scale) for a manipulation before inertia begins.

The accumulated transformation values up to the ManipulationInertiaStarting event.

Gets values that indicate the changes in the transformation deltas (translation, rotation, scale) of a manipulation since the last manipulation event.

The changes in transformation values since the last event.

Gets the device type of the input source.

The device type.

Gets the location of the pointer associated with the manipulation for the last manipulation event.

The screen coordinates, in device-independent pixel (DIP).

Gets values that indicate the velocities of the transformation deltas (translation, rotation, scale) for a manipulation at the ManipulationInertiaStarting event.

The velocities of the transformations before inertia begins.

Contains event data for the ManipulationStarted event.

Gets the number of contact points at the time the ManipulationStarted event is recognized.

The number of contact points.

Gets values that indicate the accumulated transformation deltas (translation, rotation, scale) for a manipulation before the ManipulationStarted event.

The accumulated transformation values up to the ManipulationStarted event.

Gets the device type of the input source.

The device type.

Gets the location of the pointer associated with the manipulation for the last manipulation event.

The screen coordinates, in device-independent pixel (DIP).

Contains event data for the ManipulationUpdated event.

Gets the number of contact points at the time the ManipulationUpdated event is recognized.

The number of contact points.

Gets values that indicate the accumulated transformation deltas (translation, rotation, scale) for a manipulation from the beginning of the interaction to the ManipulationUpdated event.

The accumulated transformation values up to the ManipulationUpdated event.

Gets the current number of contact points for the ongoing ManipulationUpdated event.

The number of contact points.

Gets values that indicate the changes in the transformation deltas (translation, rotation, scale) of a manipulation since the last manipulation event.

The changes in transformation values since the last event.

Gets the device type of the input source.

The device type.

Gets the location of the pointer associated with the manipulation for the last manipulation event.

The screen coordinates, in device-independent pixel (DIP).

Gets values that indicate the velocities of the transformation deltas (translation, rotation, scale) for a manipulation at the ManipulationUpdated event.

The velocities of the accumulated transformations since a ManipulationStarted event.

Contains the velocities of the accumulated transformations for the current interaction.

The rotational velocity in degrees per millisecond.

The expansion, or scaling, velocity in device-independent pixel (DIP) per millisecond.

The straight line velocity in device-independent pixel (DIP) per millisecond.

Provides properties associated with the button wheel of a mouse device.

Gets or sets the conversion factors for both character width and line height units, in device-independent pixel (DIP).

The conversion factors for the character width (x) and line height (y).

Gets or sets a value that indicates the change in the angle of rotation associated with input from the wheel button of a mouse.

A value between 0.0 and 359.0 in degrees of rotation. The default value is 0.0.

Gets or sets a value that indicates the change in scale associated with input from the wheel button of a mouse.

The relative change in scale, in degrees.

Gets or sets the conversion factors for both page width and height units, in device-independent pixel (DIP).

The conversion factors for the page width (x) and height (y).

Provides basic properties for the input pointer associated with a single mouse, pen/stylus, or touch contact.

Gets the ID of an input frame.

The frame ID.

Gets a value that indicates whether the input device (touch, pen/stylus) is touching the digitizer surface, or a mouse button is pressed down.

True if pressed down; false otherwise.

Gets information about the device associated with the input pointer.

The input device.

Gets a unique identifier for the input pointer.

A unique value that identifies the input pointer.

Gets the location of the pointer input in client coordinates.

The client coordinates, in device-independent pixel (DIP).

Gets extended information about the input pointer.

The extended properties exposed by the input device.

Gets the client coordinates of the input pointer as reported by the input device.

The client coordinates, in device-independent pixels (DIP).

Gets the time when the input occurred.

The time, relative to the system boot time, in microseconds.

Retrieves position and state information for the specified pointer.

The ID of the pointer. The pointer property values.

Retrieves the transformed information for the specified pointer.

The ID of the pointer. The transform to apply to the pointer. The pointer property values.

Retrieves position and state information for the specified pointer, from the last pointer event up to and including the current pointer event.

The ID of the pointer. The transformed pointer properties (current and historic).

Retrieves the transformed position and state information for the specified pointer, from the last pointer event up to and including the current pointer event.

The ID of the pointer. The transform to apply to the pointer. The transformed pointer properties (current and historic).

Provides extended properties for a PointerPoint object.

Gets the bounding rectangle of the contact area (typically from touch input).

The bounding rectangle of the contact area, using client window coordinates in device-independent pixel (DIP).

Gets the bounding rectangle of the raw input (typically from touch input).

The bounding rectangle of the raw input, in device-independent pixel (DIP)

Gets a value that indicates whether the barrel button of the pen/stylus device is pressed.

True if the barrel button is pressed; otherwise false.

Gets a value that indicates whether the input was canceled by the pointer device.

True if the input was canceled; otherwise false.

Gets a value that indicates whether the input is from a pen eraser.

True if the input is from a pen eraser; otherwise false.

Gets a value that indicates whether the input is from a mouse tilt wheel.

True if the input is from a mouse tilt wheel; otherwise false.

Gets a value that indicates whether the pointer device is within detection range of a sensor or digitizer (the pointer continues to exist).

True if touch or pen is within detection range or mouse is over; otherwise false.

Gets a value that indicates whether the digitizer pen is inverted.

True if inverted; otherwise false.

Gets a value that indicates whether the pointer input was triggered by the primary action mode of an input device.

True if the primary action mode; otherwise false.

Gets a value that indicates whether the pointer input was triggered by the tertiary action mode of an input device.

True if the tertiary action mode; otherwise false.

Gets a value that indicates whether the input is from the primary pointer when multiple pointers are registered.

True if the input is from the pointer designated as primary; otherwise false.

Gets a value that indicates whether the pointer input was triggered by the secondary action mode (if supported) of an input device.

True if the secondary action mode; otherwise false.

Gets a value that indicates whether the pointer input was triggered by the first extended mouse button (XButton1).

True if the first extended mouse button is pressed; otherwise false.

Gets a value that indicates whether the pointer input was triggered by the second extended mouse button (XButton2).

True if the second extended mouse button is pressed; otherwise false.

Gets a value (the raw value reported by the device) that indicates the change in wheel button input from the last pointer event.

The number of notches or distance thresholds crossed since the last pointer event. The default value is 0.

Gets the counter-clockwise angle of rotation around the major axis of the pointer device (the z-axis, perpendicular to the surface of the digitizer). A value of 0.0 degrees indicates the device is oriented towards the top of the digitizer.

A value between 0.0 and 359.0 in degrees of rotation. The default value is 0.0.

Gets the kind of pointer state change.

One of the values from PointerUpdateKind.

Gets a value that indicates the force that the pointer device (typically a pen/stylus) exerts on the surface of the digitizer.

A value from 0 to 1.0. The default value is 0.5.

Gets a value that indicates whether the pointer device rejected the touch contact.

True if the touch contact was accepted; otherwise false.

Gets the clockwise rotation in degrees of a pen device around its own major axis (such as when the user spins the pen in their fingers).

A value between 0.0 and 359.0 in degrees of rotation. The default value is 0.0.

Gets the plane angle between the Y-Z plane and the plane that contains the Y axis and the axis of the input device (typically a pen/stylus).

The value is 0.0 when the finger or pen is perpendicular to the digitizer surface, between 0.0 and 90.0 when tilted to the right of perpendicular, and between 0.0 and -90.0 when tilted to the left of perpendicular. The default value is 0.0.

Gets the plane angle between the X-Z plane and the plane that contains the X axis and the axis of the input device (typically a pen/stylus).

The value is 0.0 when the finger or pen is perpendicular to the digitizer surface, between 0.0 and 90.0 when tilted towards the user, and between 0.0 and -90.0 when tilted away from the user. The default value is 0.0.

Gets the z-coordinate (or distance) of the pointer from the screen surface, in device-independent pixels.

The value is null when the pointer is not within detection range or when MaxPointersWithZDistance is zero. The default value is null.

Gets the Human Interface Device (HID) usage value of the raw input.

The Human Interface Device (HID) usage page of the pointer device. Usage pages specify the class of device. For example, touch digitizers (0x0D) and generic input (0x01). Indicates a usage in a usage page.Usage ID specify a device or property in the **usagePage**. For example, for touch digitizers this includes tip switch (0x42) to indicate finger contact or tip pressure (0x30). The extended usage of the raw input pointer.

Gets a value that indicates whether the input data from the pointer device contains the specified Human Interface Device (HID) usage information.

The Human Interface Device (HID) usage page of the pointer device. Usage pages specify the class of device. For example, touch digitizers (0x0D) and generic input (0x01). Indicates a usage in a usage page.Usage ID specify a device or property in the **usagePage**. For example, for touch digitizers this includes tip switch (0x42) to indicate finger contact or tip pressure (0x30). True if the input data includes usage information; otherwise false.

Specifies the types of pointer updates that are supported by an application.

Left button pressed.

Left button released.

Middle button pressed.

Middle button released.

Pointer updates not identified by other PointerUpdateKind values.

Right button pressed.

Right button released.

XBUTTON1 pressed.

XBUTTON1 released.

XBUTTON2 pressed.

XBUTTON2 released.

Provides access to the visual feedback settings for pointer input.

Gets or sets a value that indicates whether visual feedback is enabled for pen/stylus input when the barrel button is pressed.

True if feedback is enabled; otherwise false. The default value is true.

Gets or sets a value that indicates whether visual feedback is enabled when a pointer contact is detected.

True if feedback is enabled; otherwise false. The default value is true.

Gets a PointerVisualizationSettings object associated with the current app.

The PointerVisualizationSettings object associated with the current app.

Represents a wheel input device or accessory such as the Surface Dial.

Gets a reference to the menu associated with the RadialController object.

The integrated menu of contextual app commands associated with the RadialController object.

Gets or sets the minimum rotational value required for the RadialController object to fire a RotationChanged event.

The minimum rotational value required to fire a RotationChanged event.

Gets or sets whether haptic feedback is enabled on the wheel device for each RotationChanged event fired by the RadialController.

**true** if haptic feedback is enabled; otherwise **false**.

Occurs when the wheel device is pressed and then released while a custom RadialController tool is active.

Occurs when the user presses and holds down the wheel device.

Occurs when the wheel device is pressed.

Occurs when the wheel device is pressed and then released.

Occurs when a custom RadialController tool (defined by an app) is selected from the menu, or when an app associated with the RadialController object is brought to the foreground while a custom RadialController tool is active.

Occurs while a custom RadialController tool (defined by an app) is active, and either the app associated with the RadialController object is sent to the background, or the user activates the RadialController menu.

Occurs when the wheel device is rotated while a custom RadialController tool is active.

Occurs only when the wheel device is moved while in contact with the digitizer surface, and a custom RadialController tool is active.

Occurs when a wheel device that is in contact with the digitizer surface is removed (or is no longer detected), and a custom RadialController tool is active.

Occurs when initial contact is detected between a wheel device and the digitizer surface, and a custom RadialController tool is active.

Instantiates a RadialController object for the wheel device and binds it to the active application.

The RadialController object to bind to the active application.

Retrieves a value that indicates whether wheel devices are supported by the system.

**true** if wheel devices are supported by the system; otherwise **false**.

Contains event data for the ButtonClicked event (fired only while a custom RadialController tool is active).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Contains event data for the ButtonHolding event (fired only when IsMenuSuppressed is **true**).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Contains event data for the ButtonPressed event.

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Contains event data for the ButtonReleased event.

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Provides configuration details for the RadialController menu.

Gets or sets the RadialController to activate when the RadialController menu is suppressed.

Gets or sets whether the RadialController object is bound to the main application process rather than a specific app view (or top-level window).

The RadialController object to bind to the active application.

Gets or sets whether the RadialController object is enabled as an AppController and controller events can be handled by your app.

**true** if enabled. Otherwise, **false**. The default is **false**.

Gets or sets whether the RadialController menu can be displayed.

**true** if the menu is suppressed. Otherwise, **false**.

Retrieves a RadialControllerConfiguration object bound to the active application.

The RadialControllerConfiguration object bound to the active application.

Restores the RadialController menu to the default configuration.

Specifies which built-in tools are shown on the RadialController menu.

The default set of commands (RadialControllerSystemMenuItemKind ) available on a RadialController menu.

Attempts to select and activate a tool from the collection of built-in RadialController tools supported for the current app context.

The built-in tool to select and activate. **true** if the tool can be selected; otherwise **false**.

Contains event data for the ControlAcquired event when a custom tool is selected from the RadialController menu, or when an app associated with the RadialController object is brought to the foreground (fired only while a custom RadialController tool is active).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets whether the wheel device is pressed.

**true** if pressed. Otherwise, **false**.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Represents the integrated menu of contextual tools associated with the RadialController object.

Gets or sets whether custom tools are displayed on the RadialController menu.

**true** if the menu displays custom tools; otherwise **false**.

Gets the collection of custom tools on the RadialController menu. Built-in tools are not included.

The collection of custom tools (RadialControllerMenuItem ) on the RadialController menu.

Retrieves the active custom tool from the RadialController menu .

The active custom tool. Null if a custom tool is not active.

Selects and activates the specified custom tool from the RadialController menu.

The custom tool to select.

Attempts to select and activate the previously selected tool from the RadialController menu.

**true** if the previously selected tool can be selected and activated; otherwise **false**.

Represents a single custom tool from the RadialController menu.

Gets the text string of the custom tool on the RadialController menu.

The text string of the custom tool.

Gets or sets an object used to identify custom tools on the RadialController menu.

Identifies custom tools on the RadialController menu.

Occurs when a custom tool is selected from the RadialController menu.

Creates a custom tool (using the specified text string and font glyph) on the RadialController menu.

The text string to display for the custom tool. The font glyph to display for the custom tool. The font family that contains the glyph to display for the custom tool. The custom tool.

Creates a custom tool (using the specified text string and font glyph) on the RadialController menu.

The text string to display for the custom tool. The font glyph to display for the custom tool. The font family that contains the glyph to display for the custom tool. The Uniform Resource Identifier (URI) that identifies the location of the font used for rendering the glyph. The custom tool.

Creates a custom tool (using the specified text string and custom icon) on the RadialController menu.

The text string to display for the custom tool. The custom icon to display for the custom tool. The custom tool.

Creates a custom tool (using the specified text string and system icon) on the RadialController menu.

The text string to display for the custom tool. The system icon to display for the custom tool. The custom tool.

Specifies the set of system icons available for a custom RadialController tool on the RadialControllerMenu.

Icon for the InkToolbar color palette.

Icon for the InkToolbar stroke size setting.

Icon for the Next/Previous track media commands.

Icon for the InkToolbar  PenButton.

Icon for the InkToolbar  RulerButton.

Icon for the Scroll command.

Icon for the Undo/Redo commands.

Icon for the Volume command.

Icon for the Zoom command.

Contains event data for the RotationChanged event (fired only while a custom RadialController tool is active).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom RadialController tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets whether the wheel device is pressed.

**true** if pressed. Otherwise, **false**.

The rotational change of the wheel device, while a custom RadialController tool is active.

The rotational change in degrees.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Provides contact details for the wheel device when placed on the digitizer surface, while a custom RadialController tool is active.

The bounding rectangle of the wheel device when in contact with the digitizer surface, while a custom RadialController tool is active.

The bounding rectangle, in device-independent pixel (DIP), relative to the application window.

The center point of the wheel device (relative to the application window) when in contact with the digitizer surface, and while a custom RadialController tool is active.

The center point of the wheel device, in device-independent pixel (DIP), relative to the application window.

Contains event data for the ScreenContactContinued event (fired only while a custom RadialController tool is active).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom RadialController tool is active.

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets whether the wheel device is pressed.

**true** if pressed. Otherwise, **false**.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Contains event data for the ScreenContactEnded event (fired only while a custom RadialController tool is active).

Gets whether the wheel device is pressed.

**true** if pressed. Otherwise, **false**.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Contains event data for the ScreenContactStarted event (fired only while a custom RadialController tool is active).

Gets the location and bounding area of the wheel device on the digitizer surface, while a custom RadialController tool is active..

The location and bounding area, in device-independent pixel (DIP), of the wheel device on the digitizer surface.

Gets whether the wheel device is pressed.

**true** if pressed. Otherwise, **false**.

Gets a reference to the SimpleHapticsController object associated with the RadialController.

The SimpleHapticsController object associated with the RadialController.

Specifies the set of built-in RadialController tools available on the RadialControllerMenu.

Next and Previous track selection media commands.

Scroll command.

Undo and Redo commands.

System volume command.

Zoom command.

Contains event data for the RightTapped event.

Gets the number of contact points at the time the RightTapped event is recognized.

The number of contact points.

Gets the device type of the input source.

The device type.

Gets the location of the touch, mouse, or pen/stylus contact.

The screen coordinates, in device-independent pixel (DIP).

Enables an application to handle events generated by system keyboard buttons (such as the Function keys).

Occurs when a Function (also know as Function Shift) key is pressed.

Occurs when a Function (also know as Function Shift) key, which is currently pressed, is released.

Occurs on changes to the state of the Function (also know as Function Shift) key lock.

Occurs on changes to the state of the visual indicator for the Function (also know as Function Shift) key lock.

Creates a SystemButtonEventController object on the specified dispatcher queue.

The DispatcherQueue for managing prioritized tasks that execute in a serial fashion on a thread. A SystemButtonEventController.

Contains event data for the SystemFunctionButtonPressed and SystemFunctionButtonReleased events.

Gets or sets a value that marks the SystemFunctionButtonPressed and SystemFunctionButtonReleased events as handled.

If false (default), the event bubbles up to the next event handler. Otherwise, the event does not bubble up to the next event handler.

Gets the date and time of the SystemFunctionButtonPressed and SystemFunctionButtonReleased events.

The date and time of the SystemFunctionButtonPressed and SystemFunctionButtonReleased events.

Contains event data for the SystemFunctionLockChanged event.

Gets or sets a value that marks the SystemFunctionLockChanged event as handled.

If false (default), the event bubbles up to the next event handler. Otherwise, the event does not bubble up to the next event handler.

Gets the state of the Function key lock for the SystemFunctionLockChanged event.

True, if the Function key lock is on. Otherwise, false.

Gets the date and time of the SystemFunctionLockChanged event.

The date and time of the SystemFunctionLockChanged event.

Contains event data for the SystemFunctionLockIndicatorChanged event.

Gets or sets a value that marks the SystemFunctionLockIndicatorChanged event as handled.

If false (default), the event bubbles up to the next event handler. Otherwise, the event does not bubble up to the next event handler.

Gets the state of the Function key lock indicator for the SystemFunctionLockIndicatorChanged event.

True, if the indicator is on. Otherwise, false.

Gets the date and time of the SystemFunctionLockIndicatorChanged event.

The date and time of the SystemFunctionLockIndicatorChanged event.

Contains event data for the Tapped event.

Gets the number of contact points at the time the Tapped event is recognized.

The number of contact points.

Gets the device type of the input source.

The device type.

Gets the location of the touch, mouse, or pen/stylus contact.

The screen coordinates, in device-independent pixel (DIP).

Gets the number of times the tap interaction was detected.

The total number of taps.

Enables an app to handle radial controller input on the background thread.

Gets a reference to a wheel input device or accessory such as the Surface Dial.

The wheel input device.

Gets the event message dispatcher associated with the current view.

The event message dispatcher.

Gets the DispatcherQueue associated with this RadialControllerIndependentInputSource.

The DispatcherQueue for managing prioritized tasks that execute in a serial fashion on a thread.

Gets an instance of RadialControllerIndependentInputSource for the running app's current CoreWindow.

The app window and its thread. The radial controller input manager.

Specifies the handwriting space available when using ink for text input in a text control (when HandwritingView is enabled).

Approximately 1.5" of handwriting space per line.

Approximately 1" of handwriting space per line.

Approximately 0.5" of handwriting space per line.

Defines the implementation for a type that generates InkPoint objects used in the construction of an InkStroke.

Generates an InkPoint object that includes position and pressure information used in the construction of an InkStroke.

The screen coordinates for the InkPoint object. The pressure of the contact on the digitizer surface. The default is 0.5. A single point.

Defines the implementation for a type that generates InkPresenterRuler objects used in the construction of an InkPresenter.

Generates an InkPresenterRuler object that includes information used in the construction of an InkPresenter.

Provides properties, methods, and events for managing the input, processing, and rendering of ink input (standard and modified) for an InkCanvas control. Represents a visual stencil, displayed as an semi-transparent overlay on an InkCanvas.

Represents a visual stencil, displayed as an semi-transparent overlay on an InkCanvas.

Gets or sets the background color of the IInkPresenterStencil object.

The background color of the stencil as an ARGB value. The default is (255, 230, 230, 230).

Gets or sets the color of the foreground elements on an IInkPresenterStencil object.

The foreground color of the stencil as an ARGB value. The default is (255, 0, 0, 0).

Gets or sets whether the IInkPresenterStencil object is visible.

**true** if the stencil is visible. Otherwise, **false**.

Gets the type of IInkPresenterStencil object to display on the InkCanvas.

The type of stencil.

Gets or sets the position and rotation angle of the IInkPresenterStencil object within the 2-D coordinate space of the InkCanvas.

The position and angle of the stencil as a 3*2 floating point matrix.The default position is the origin of the InkCanvas. The default rotation angle is 45 degrees.

Represents one or more InkRecognizer objects.

Gets the collection of installed handwriting recognizers.

The installed handwriting recognizers as a collection of InkRecognizer objects.

Performs handwriting recognition on one or more InkStroke objects.

The set of strokes on which recognition is performed. One of the values from the InkRecognitionTarget enumeration. The results of the recognition as a collection of InkRecognitionResult objects.Each item in the collection represents a written word. For example, the string "this is a test" contains four words that are stored as a collection of four items.

Sets the default InkRecognizer used for handwriting recognition.

The InkRecognizer.

Represents a manager for the collection of InkStroke objects rendered by the InkPresenter.

Gets the bounding rectangle of the InkStroke collection managed by the InkStrokeContainer.

The bounding rectangle of the InkStroke collection.

Adds an InkStroke object to the collection managed by the InkStrokeContainer.

The ink stroke to be added.

Identifies whether content on the clipboard can be added to the InkStroke collection managed by the InkStrokeContainer.

True if content can be pasted from the clipboard; otherwise, false.

Copies the selected InkStroke objects (from the InkStroke collection managed by the InkStrokeContainer ) to the clipboard in Ink Serialized Format (ISF) format.

Deletes the selected InkStroke objects from the InkStroke collection managed by the InkStrokeContainer.

The bounding rectangle of the selected ink strokes, or the invalidated rectangle (0, 0, 0, 0) if no strokes were removed (no selected strokes).

Gets the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

The results of the recognition as a collection of InkRecognitionResult objects.

Retrieves all ink strokes in the collection managed by the InkStrokeContainer.

The ink strokes managed by the InkStrokeContainer as a collection of InkStroke objects.

Asynchronously loads all InkStroke objects from the specified stream to the InkStroke collection that is managed by the InkStrokeContainer.

The stream that contains the stroke collection. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The status of the asynchronous operation as the number of bytes fetched. For more information, see [ReadAsync](https://docs.microsoft.com/previous-versions/hh438388(v=vs.85)) method.

Moves the selected strokes. All affected strokes are re-rendered.

The destination screen coordinates for the upper-left corner of the bounding rectangle of the selected strokes. The bounding rectangle of the selected ink strokes.

Adds the InkStroke content from the clipboard to the InkStroke collection that is managed by the InkStrokeContainer and renders the new strokes.

The screen coordinates for the upper-left corner of the bounding rectangle of the clipboard content. The invalidated bounding rectangle of the InkStroke collection.

Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkStrokeContainer to the specified stream.

The target stream. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The size of the saved stream and the status of the asynchronous operation as the number of bytes sent. For more information, see [WriteAsync](https://docs.microsoft.com/previous-versions/hh438392(v=vs.85)) method.

Selects all strokes intersected by the new stroke.

The start of the line. The end of the line. The bounding rectangle of the selected ink strokes.

Selects all strokes contained entirely within the polyline.

The points of the polyline. The bounding rectangle of the selected ink strokes.

Updates the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

The updated collection of InkRecognitionResult objects.

Provides properties associated with the drawing of an InkStroke.

Creates a new InkDrawingAttributes object that is used to specify InkStroke attributes.

Gets or sets a value that indicates the color of an InkStroke.

The ink color as an ARGB value. The default is black (0, 0, 0, 0).

Gets or sets a value that indicates whether the InkStroke is rendered as a highlighter overlay. The stroke is typically set to a bright color, such as yellow.

**true** to render the stroke as a highlighter; otherwise **false**. The default value is **false**.

Gets or sets a value that indicates whether a Bezier curve or a collection of straight line segments is used to draw an InkStroke.

**true** if a Bezier curve is used; otherwise **false**. The default value is **true**.

Gets or sets a value that indicates whether the pressure of the contact on the digitizer surface is ignored when you draw an InkStroke.

**true** if pressure is ignored; otherwise **false**. The default value is **false**.

Gets or sets a value that indicates whether the tilt (tiltx, tilty ) of the contact on the digitizer surface is ignored when you draw an InkStroke.

**true** if tilt is ignored; otherwise **false**. The default value is **false**.

Gets the InkDrawingAttributes that describe the characteristics of a specific type of InkStroke.

The attributes associated with the InkStroke.

Gets an instance of a ModelerAttributes object for accessing modeler properties of an ink stroke.

A ModelerAttributes object used to process ink stroke rendering properties.

Gets an instance of an InkDrawingAttributesPencilProperties object for setting properties characteristic to a pencil stroke.

An InkDrawingAttributesPencilProperties used to set pencil stroke properties.

Gets or sets a value that indicates the shape of the pen tip when you draw an InkStroke.

The shape of the pen/stylus tip. The default is Circle.

Gets or sets an affine transformation matrix applied to the PenTipShape used for an InkStroke.

The 2-D affine transformation matrix. The default is the identity matrix.

Gets or sets a value that indicates the dimensions of the pen tip (PenTip ) used to draw an InkStroke.

The Width and Height of the pen tip in . The default value for each is 2.The shape of the PenTip can be specified as a Rectangle or a Circle.

Creates an InkDrawingAttributes object for rendering an ink stroke with pencil characteristics.

An InkDrawingAttributes object that supports the following properties:

Specifies the type of InkDrawingAttributes associated with the InkStroke.

Supports attributes associated with a pen or highlighter.

Supports attributes associated with a pencil.

Provides a set of static InkDrawingAttributes properties for rendering a pencil stroke on an InkCanvas.

Gets or sets the level of transparency used for rendering a pencil stroke on an InkCanvas.

A value between 0.01 and 5.0 that specifies the opacity factor, with 5.0 indicating full opacity. The default value is 1.0.

Specifies how the InkPresenter object handles input (standard and modified) from the associated InkCanvas control when system is in high contrast mode.

For standard strokes, use the selected color.

For standard strokes, use system color.

For standard strokes, use selected color if contrast is sufficient against the background. Otherwise, use system color.

Manages which types of secondary input can be processed by the InkPresenter object.

Gets or sets whether input from a pen's eraser tip is processed by the InkPresenter object.

True, if input from the eraser tip is processed; otherwise, false.

Gets or sets whether input from a pen's primary barrel button is processed by the InkPresenter object.

True, if input from the primary barrel button is processed; otherwise, false.

Manages how input is processed by the InkPresenter object.

Gets or sets how the InkPresenter object renders secondrary input from a pen barrel button, pen eraser tip, right mouse button, or similar on its associated InkCanvas control.

The input behavior.

Gets or sets how the InkPresenter object handles secondary input from a pen barrel button, pen eraser tip, right mouse button, or similar.

The input behavior when modified with a secondary affordance.

Specifies how the InkPresenter object interprets input from it's associated InkCanvas control.

Input is treated as erase.

Input is treated as ink.

All input events are passed to the app and are not processed by the InkPresenter.

Specifies how the InkPresenter object handles secondary input from a pen barrel button, pen eraser tip, right mouse button, or similar.

All input is unmodified by a secondary affordance and is processed as standard ink input by the InkPresenter.

All input is UnprocessedInput. This passes all input through to the app for custom processing.

Manages the input, manipulation, and processing (including handwriting recognition) of one or more InkStroke objects.

Creates a new InkManager object that is used to manage InkStroke objects.

Gets the bounding rectangle of the InkStroke collection that is managed by the InkManager.

The bounding rectangle of the InkStroke collection.

Gets or sets the ink input mode.

The mode.

Adds one or more InkStroke objects to the collection managed by the InkManager.

The ink stroke to be added.

Identifies whether content on the clipboard can be added to the InkStroke collection that is managed by the InkManager.

True if content can be pasted from the clipboard; otherwise, false.

Copies the selected InkStroke objects (from the InkStroke collection managed by the InkManager ) to the clipboard in Ink Serialized Format (ISF) format.

Deletes the selected InkStroke objects from the InkStroke collection managed by the InkManager.

The bounding rectangle of the selected ink strokes, or the invalidated rectangle (0, 0, 0, 0) if no strokes were removed (no selected strokes).

Retrieves the collection of words returned by handwriting recognition.

The words returned by the handwriting recognizer as a collection of InkRecognitionResult objects.

Gets the collection of installed handwriting recognizers.

The installed handwriting recognizers as a collection of InkRecognizer objects.

Retrieves all ink strokes in the collection managed by the InkManager.

The ink strokes managed by the InkManager as a collection of InkStroke objects.

Asynchronously loads all InkStroke objects from the specified stream to the InkStroke collection that is managed by the InkManager.

The stream that contains the stroke collection. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The status of the asynchronous operation as the number of bytes fetched. For more information, see [ReadAsync](https://docs.microsoft.com/previous-versions/hh438388(v=vs.85)) method.

Moves the selected strokes. All affected strokes are re-rendered.

The destination screen coordinates for the upper-left corner of the bounding rectangle of the selected strokes. The bounding rectangle of the selected ink strokes.

Adds the InkStroke content from the clipboard to the InkStroke collection that is managed by the InkManager and renders the new strokes..

The screen coordinates for the upper-left corner of the bounding rectangle of the clipboard content. The invalidated bounding rectangle of the InkStroke collection.

Processes information about the position and features of the contact point, like pressure and tilt, on initial down contact. You must call this method before you call ProcessPointerUpdate, and then ProcessPointerUp.

Information about the position and features of the contact point.

Processes information about the position and features of the contact point, like pressure and tilt, on up contact. You must call this method after you call ProcessPointerUpdate.

Information about the position and features of the contact point. For Inking and Selecting modes, this is the bounding box for the stroke (invalidated rectangle). For Erasing mode, the invalidated rectangle is (0,0,0,0).

Processes position and state properties, such as pressure and tilt, for the specified pointer, from the last pointer event up to and including the current pointer event.Call this method after ProcessPointerDown and before ProcessPointerUp.

The input pointer for which updates are to be processed. When the current InkManipulationMode is **Inking** or **Selecting**, this method returns the Point (screen position in ink space) associated with the last ProcessPointerUpdate of *pointerPoint*.

Performs handwriting recognition on one or more InkStroke objects.

One of the values from the InkRecognitionTarget enumeration. The results of the recognition as a collection of InkRecognitionResult objects. Each item in the results returned by recognition represents one written word. Each word is associated with a ranked list of text strings (retrieved through a call to GetTextCandidates ) as potential matches for the word.

Performs handwriting recognition on one or more InkStroke objects.

The set of strokes on which recognition is performed. One of the values from the InkRecognitionTarget enumeration. The results of the recognition as a collection of InkRecognitionResult objects.Each item in the results returned by recognition represents one written word. Each word is associated with a ranked list of text strings (retrieved through a call to GetTextCandidates ) as potential matches for the word.

Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkManager to the specified stream.

The target stream. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The size of the saved stream and the status of the asynchronous operation as the number of bytes sent. For more information, see [WriteAsync](https://docs.microsoft.com/previous-versions/hh438392(v=vs.85)) method.

Selects all strokes intersected by the new stroke.

The start of the stroke. The end of the stroke. The bounding rectangle of the selected ink strokes.

Selects all strokes contained entirely within the polyline.

The points of the polyline. The bounding rectangle of the selected ink strokes.

Sets the default InkDrawingAttributes for all new InkStroke objects added to the InkStroke collection managed by the InkManager.

The default attributes applied to a new ink stroke.

Sets the default InkRecognizer used for handwriting recognition.

The InkRecognizer.

Updates the collection of potential text matches from handwriting recognition.

The results returned by recognition, where each InkRecognitionResult object represents one written word.

Specifies the modes of ink input.

All strokes are hit tested against all strokes in the stroke collection. If there is an intersection, InkManager deletes the stroke automatically and returns an invalidated rectangle for processPointerUpdate calls.

All points are passed to the InkStrokeBuilder and an InkStroke is created. The stroke is appended to the stroke collection of the InkManager or InkStrokeContainer.

All points are used to create a polyline. When you call processPointerUp, the polyline is hit tested against entire stroke collection and all strokes within the polyline are marked as selected.

Manages which types of ink modeler attributes can be processed by the InkPresenter object.

Gets or sets the amount of time into the future used to predict the expected location of the input pointer.

The time in milliseconds. The default is 15 ms, with a valid range between 0 to 20 ms.

Gets or sets the scale transform for the coordinate space of the ink stroke.

The scale factor in himetric units (one thousandth of a centimeter, and independent of the display or screen resolution).

Gets or sets whether pen velocity is used in combination with pressure on the inking surface to calculate final pressure value.

True, if pen velocity is used. Otherwise, false.

Specifies the formats for saving ink input.

Ink is saved as a GIF file with embedded Ink Serialized Format (ISF) format data.

Ink is saved as Ink Serialized Format (ISF) format data.

Provides raw input data for a single point used in the construction of an InkStroke.

Creates a basic InkPoint object used in the construction of an InkStroke.

The screen coordinates for the InkPoint object. The pressure of the contact on the digitizer surface. The default is 0.5.

Creates a complex InkPoint object used in the construction of an InkStroke.

The screen coordinates for the InkPoint object. The pressure of the contact on the digitizer surface. The default is 0.5. The plane angle between the Y-Z plane and the plane containing the Y axis and the axis of the input device. The default is 0. The plane angle between the X-Z plane and the plane containing the X axis and the axis of the input device. The default is 0. The timestamp for the first InkPoint of an InkStroke, or when an entire InkStroke is pasted or loaded.

The X, Y coordinates of the InkPoint, in device-independent pixel (DIP) relative to the upper left-hand corner of the inking area.

The X, Y coordinates relative to the upper left-hand corner of the inking area.

The pressure of the contact on the digitizer surface for the InkPoint.

The pressure of the contact.

Gets the plane angle between the Y-Z plane and the plane containing the Y axis and the axis of the input device.

A value in the range of -90 to +90 degrees. A positive X tilt is to the right.

Gets the plane angle between the X-Z plane and the plane containing the X axis and the axis of the input device.

A value in the range of -90 to +90 degrees. A positive Y tilt is toward the user.

Gets the timestamp for the first InkPoint of an InkStroke, or when an entire InkStroke is pasted or loaded.

The time, relative to the system boot time, in microseconds.

Provides properties, methods, and events for managing the input, processing, and rendering of ink input (standard and modified) for an InkCanvas control.

Gets or sets how the InkPresenter object handles input (standard and modified) from the associated InkCanvas control when system is in high contrast mode.

The ink color (selected or system) that works best against the background color.

Gets which types of secondary input can be processed by the InkPresenter object.

The types of secondary input that can be processed.

Gets or sets the input device type from which input data is collected by the InkPresenter to construct and render an InkStroke. The default is Pen.

The input device types.

Gets how input is processed by the InkPresenter object.

The input behavior.

Gets or sets whether input is enabled for inking.

**true** if input is enabled for inking. Otherwise, **false**.

Gets or sets an InkStrokeContainer object to store and manage the collection of InkStroke objects rendered by the InkPresenter.

Stores and manages one or more InkStroke objects.

Gets an InkStrokeInput object for managing ink input events.

The ink input.

Gets input (standard or modified) from the associated InkCanvas control and passes the data through for custom processing by the app. The data is not processed by the InkPresenter.

The input from the InkCanvas control.

Occurs when one or more ink strokes are processed ("wet" to "dry") by the application thread.

Occurs when an InkStroke object is removed from an InkCanvas control using the pen eraser or the pen tip when Mode is set to Erasing.

Indicates that your app requires complete control of ink input rendering.

The object used for custom ink stroke rendering.

Retrieves the InkDrawingAttributes used by the InkPresenter when rendering a new InkStroke on an InkCanvas control.

The drawing attributes applied to a new ink stroke.

Sets the inking behavior of one or more contact points on the associated InkCanvas control.

The inking behavior of one or more contact points. The default is SimpleSinglePointer.

Sets the InkDrawingAttributes used by the InkPresenter when rendering a new InkStroke on an InkCanvas control.

The drawing attributes for new ink strokes.

Specifies the inking behavior of one or more contact points. Used with SetPredefinedConfiguration.

Each contact point is used to draw an InkStroke.

A single, primary contact point is used to draw an InkStroke.

Represents a visual stencil, in the form of a protractor for drawing arcs and curves, displayed as a semi-transparent overlay on an InkCanvas.

Initializes a new instance of the InkPresenterProtractor class.

The ink presenter associated with the pen input.

Gets or sets the color of the rays and horizontal marks for the protractor stencil.

The specified color.

Gets or sets whether the rays are displayed on the protractor stencil.

**true**, if the rays are visible. Otherwise, **false**.

Gets or sets whether the tick marks are displayed on the protractor stencil.

**true**, if the tick marks are visible. Otherwise, **false**.

Gets or sets the background color of the InkPresenterProtractor.

The background color of the protractor as an ARGB value. The default is (255, 230, 230, 230).

Gets or sets the color of the foreground elements on an InkPresenterProtractor.

The foreground color of the protractor as an ARGB value. The default is (255, 0, 0, 0).

Gets or sets whether the numerical angle is displayed on the protractor stencil.

**true**, if the angle readout is visible. Otherwise, **false**.

Gets or sets whether the center mark is displayed on the protractor stencil.

**true**, if the center mark is visible. Otherwise, **false**.

Gets or sets whether the protractor stencil can be resized.

**true**, if the stencil can be resized. Otherwise, **false**.

Gets or sets whether the protractor stencil is visible.

**true** if the ruler is visible. Otherwise, **false**.

Gets the type of stencil to display on the InkCanvas.

The type of stencil.

Gets or sets the radial size of the protractor.

The radial size, in Device Independent Pixels (DIPs).

Gets or sets the position and rotation angle of the protractor stencil within the 2-D coordinate space of the InkCanvas.

The position and angle of the stencil as a 3*2 floating point matrix.The default position is the origin of the InkCanvas. The default rotation angle is 0 degrees.

Represents a visual stencil, in the form of a straight rule for drawing straight lines, displayed as a semi-transparent overlay on an InkCanvas.

Initializes a new instance of the InkPresenterRuler class.

The ink presenter associated with the pen input.

Gets or sets whether the tick marks are displayed on the ruler stencil.

**true**, if the tick marks are visible. Otherwise, **false**.

Gets or sets the background color of the InkPresenterRuler.

The background color of the ruler as an ARGB value. The default is (255, 230, 230, 230).

Gets or sets the color of the foreground elements on an InkPresenterRuler.

The foreground color of the ruler as an ARGB value. The default is (255, 0, 0, 0).

Gets or sets whether a compass is displayed on the ruler stencil.

**true**, if the compass is visible. Otherwise, **false**.

Gets or sets whether the InkPresenterRuler is visible.

**true** if the ruler is visible. Otherwise, **false**.

Gets the type of stencil to display on the InkCanvas.

The type of stencil.

Gets or sets the length of the InkPresenterRuler.

The length in device-independent pixel (DIP).

Gets or sets the position and rotation angle of the ruler stencil within the 2-D coordinate space of the InkCanvas.

The position and angle of the ruler as a 3*2 floating point matrix.The default position is the origin of the InkCanvas. The default rotation angle is 45 degrees.

Gets or sets the width of the InkPresenterRuler.

The width in device-independent pixels (DIPs).

Specifies the type of stencil that can be displayed on an InkCanvas.

A custom stencil.

A stencil in the form of a protractor for drawing arcs and curves.

A stencil in the form of a straight rule for drawing straight lines.

Provides properties and methods to manage InkStroke handwriting recognition data.

Gets the bounding rectangle of the InkStroke data used for handwriting recognition.

The bounding rectangle of the ink strokes.

Retrieves all ink strokes used for handwriting recognition.

The ink strokes used for handwriting recognition as a collection of InkStroke objects.

Retrieves the collection of strings identified as potential matches for each word returned by handwriting recognition.

The recognition matches as a collection of String objects. The most likely candidate is topmost in the collection.

Indicates which strokes you want to include in handwriting recognition.

All strokes in the stroke collection are passed to the recognizer.

All strokes added after the last recognition pass (Recognized is false) are passed to the recognizer.This is useful in incremental recognition scenarios, such as direct tracking of ink input (no indirect controls are used to start recognition).

Selected (Selected ) strokes are passed to the recognizer.

Manages all aspects of handwriting recognition.

Gets the name of the InkRecognizer object.

The name.

Provides properties and methods to manage one or more InkRecognizer objects used for handwriting recognition.

Creates a new InkRecognizerContainer object to manage InkRecognizer objects used for handwriting recognition.

Gets the collection of installed handwriting recognizers.

The installed handwriting recognizers as a collection of InkRecognizer objects.

Performs handwriting recognition on one or more InkStroke objects.

The set of strokes on which recognition is performed. One of the values from the InkRecognitionTarget enumeration. The results of the recognition as a collection of InkRecognitionResult objects.Each item in the collection represents a written word. For example, the string "this is a test" contains four words that are stored as a collection of four items.

Sets the default InkRecognizer used for handwriting recognition.

The InkRecognizer.

A single ink stroke, including the Bézier curve parameters used for final rendering of the stroke.

Gets the bounding box for the InkStroke.

The bounding box.

Gets or sets the properties associated with an InkStroke.

The drawing attributes.

Gets the ink stroke identifier.

The identifier for the ink stroke.

Gets or sets an affine transformation matrix to apply to the InkStroke object.

The 2-D transformation matrix.

Gets whether the stroke is recognized.

True if the stroke is recognized; otherwise, false.

Gets whether the stroke is selected.

True if the stroke is selected; otherwise, false.

Gets or sets the time taken by the user to draw a single ink stroke.

The time period expressed in 100-nanosecond units.

Gets or sets the date and time when the InkStroke was started.

The date and time of day.

Copies the InkStroke to another InkManager (or InkStrokeContainer ).

The new stroke.

Gets the collection of InkPoint objects used to construct the InkStroke.

The collection of InkPoint objects used to construct the InkStroke.

Gets the rendering segments of the stroke.

The collection of InkStrokeRenderingSegment objects.

Builds strokes from raw pointer input.

Creates a new InkStrokeBuilder object that is used to construct InkStroke objects.

Adds a new segment to the ink stroke.

The end point of the new segment. The previous end point. This end point can be used when rendering the stroke.

Starts building the ink stroke.

The first point for the stroke.

Creates a stroke from an array of Point coordinates.

An array of Point coordinates. The new stroke.

Creates a basic ink stroke from collection of InkPoint objects.

The collection of InkPoint objects. A 2-D transformation matrix. The ink stroke, including the Bézier curve parameters used for final rendering of the stroke.

Creates a rich ink stroke from collection of InkPoint objects.

The collection of InkPoint objects. A 2-D transformation matrix. Typically, this is just the identity matrix. The date and time when the InkStroke was started. Gets or sets the time taken by the user to draw a single ink stroke. The ink stroke, including the Bézier curve parameters used for final rendering of the stroke.

Stops building the ink stroke.

The last point for the stroke. The stroke built from the points.

Sets the default InkDrawingAttributes for all new ink strokes created after the current stroke.

The default attributes.

Provides properties and methods to store and manage the collection of InkStroke objects rendered by the InkPresenter.

Initializes a new InkStrokeContainer object that is used to manage InkStroke objects.

Gets the bounding rectangle of the InkStroke collection managed by the InkStrokeContainer.

The bounding rectangle of the InkStroke collection.

Adds an InkStroke object to the collection managed by the InkStrokeContainer.

The ink stroke to be added.

Adds one or more ink strokes to the collection managed by the InkStrokeContainer.

The ink strokes to be added as a collection of InkStroke objects.Each *stroke* must be created using the Clone method, or through a call to EndStroke or ProcessPointerUp. Empty or existing strokes are not valid.

Identifies whether content on the clipboard can be added to the InkStroke collection managed by the InkStrokeContainer.

True if content can be pasted from the clipboard; otherwise, false.

Deletes all InkStroke objects from the collection managed by the InkStrokeContainer.

Copies the selected InkStroke objects (from the InkStroke collection managed by the InkStrokeContainer ) to the clipboard in Ink Serialized Format (ISF) format.

Deletes the selected InkStroke objects from the InkStroke collection managed by the InkStrokeContainer.

The bounding rectangle of the selected ink strokes, or the invalidated rectangle (0, 0, 0, 0) if no strokes were removed (no selected strokes).

Gets the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

The results of the recognition as a collection of InkRecognitionResult objects.

Retrieves the single InkStroke with the specified ID.

The Global Unique Identifier (GUID) used to identify a single ink stroke. The single ink stroke.

Retrieves all ink strokes in the collection managed by the InkStrokeContainer.

The ink strokes managed by the InkStrokeContainer as a collection of InkStroke objects.

Asynchronously loads all InkStroke objects from the specified stream to the InkStroke collection that is managed by the InkStrokeContainer.

The target stream. The status of the asynchronous operation as the number of bytes fetched. For more information, see [ReadAsync](https://docs.microsoft.com/previous-versions/hh438388(v=vs.85)) method.

Moves the selected strokes. All affected strokes are re-rendered.

The destination screen coordinates for the upper-left corner of the bounding rectangle of the selected strokes. The bounding rectangle of the selected ink strokes.

Adds the InkStroke content from the clipboard to the InkStroke collection that is managed by the InkStrokeContainer and renders the new strokes..

The screen coordinates for the upper-left corner of the bounding rectangle of the clipboard content. The invalidated bounding rectangle of the InkStroke collection.

Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkStrokeContainer to the specified stream.

The target stream. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The status of the asynchronous operation as the number of bytes sent. For more information, see [WriteAsync](https://docs.microsoft.com/previous-versions/hh438392(v=vs.85)) method.

Asynchronously saves all InkStroke objects in the InkStroke collection that is managed by the InkStrokeContainer to the specified stream and in the specified format.

The target stream. An IRandomAccessStream (requires IOutputStream ) object can be specified instead. The format in which to save the ink input. The status of the asynchronous operation as the number of bytes sent. For more information, see [WriteAsync](https://docs.microsoft.com/previous-versions/hh438392(v=vs.85)) method.

Selects all strokes intersected by the new stroke.

The start of the line. The of the line. The bounding rectangle of the selected ink strokes.

Selects all strokes contained entirely within the polyline.

The points of the polyline. The bounding rectangle of the selected ink strokes.

Updates the collection of recognition matches previously processed by an InkRecognizer and stored in an InkRecognizerContainer.

The updated collection of InkRecognitionResult objects.

Provides properties and events for StrokeInput associated with an InkPresenter object.

Gets the InkPresenter object associated with the ink input data.

The ink presenter associated with the ink input.

Occurs when ink input bubbles up to another system event handler, such as a context menu.

Occurs when stroke input has started (StrokeStarted ) and continues to be captured by an InkPresenter object.

Occurs when stroke input has stopped being detected by an InkPresenter object.

Occurs when stroke input is first detected by an InkPresenter object.

A single segment of a complete ink stroke.

Gets the first control point for the Bézier curve.

The control point.

Gets the second control point for the Bézier curve.

The control point.

Gets the end point of the segment.

The end point.

Gets the pressure of the contact on the digitizer surface.

The pressure of the contact.

Gets the tilt of the contact along the x axis.

The tilt along the x axis.

Gets the tilt of the contact along the y axis.

The tilt along the y axis.

Gets the twist of the contact along the rotational axis.

The twist of the contact along the rotational axis.

Contains event data for the StrokesCollected event of the InkPresenter associated with an InkCanvas control.

Gets the collection of processed ink strokes ("wet" to "dry") associated with the StrokesCollected event.

The processed ink strokes as a collection of InkStroke objects.

Contains event data for the StrokesErased event of the InkPresenter associated with an InkCanvas control.

Gets the collection of ink strokes associated with the StrokesErased event.

The erased ink strokes as a collection of InkStroke objects.

Manages the synchronization of ink input and provides methods for rendering it to the Direct2D device context of your Universal Windows app, instead of the default InkCanvas control. This requires an IInkD2DRenderer object to manage the ink input (see the Complex ink sample ).

Initiates a custom "dry" of ink input to the Direct2D device context of your app, instead of the default InkCanvas control. This requires an IInkD2DRenderer object to manage the ink input (see the Complex ink sample ).

The collection of "wet" ink strokes to pass to the IInkD2DRenderer object .

Finalizes a custom "dry" of ink input to the Direct2D device context of your app, instead of the default InkCanvas control, and notifies the system that "wet" ink can be removed. This requires an IInkD2DRenderer object to manage the ink input (see the Complex ink sample ).

Provides properties and events for custom processing of ink data from an InkCanvas control. The data is not processed by the InkPresenter.

Gets the InkPresenter object associated with the InkCanvas control capturing the InkStroke data. The InkPresenter does not process the input, instead the data is passed through for custom processing by the app.

The ink presenter associated with the pen input.

Occurs when a pointer enters the hit test, or bounding, area of an InkCanvas control.

Occurs when a pointer leaves the hit test, or bounding, area of an InkCanvas control.

Occurs when a pointer is detected over, but not down or in contact with, the hit test, or bounding, area of an InkCanvas control.

Occurs when a pointer is no longer detected in, or over, the hit test, or bounding, area of an InkCanvas control.

Occurs when a pointer moves within the hit test, or bounding, area of an InkCanvas control.

Occurs when a pointer registers contact within the hit test, or bounding, area of an InkCanvas control. This can be when a mouse button is pressed or the digitizer surface is touched by a finger or pen.

Can occur when a pointer associated with a PointerPressed event is lifted, or released, while within the hit test, or bounding, area of an InkCanvas control.

Provides access to user settings related to accepting and converting ink to text input in a text control (when HandwritingView is enabled).

Gets the font used for converting ink to text input in a text control (when HandwritingView is enabled).

One of the fonts from the *Font when using handwriting* ListBox on the **Pen & Windows Ink** settings screen. The default is Segoe UI.

Gets the handwriting space available when using ink for text input in a text control (when HandwritingView is enabled).

One of Small, Medium (default), or Large.

Gets whether ink can be used for text input in a text control (when HandwritingView is enabled).

True if ink can be used for text input. Otherwise, false.

Gets whether touch inking can be used for text input in a text control (when HandwritingView is enabled).

True if touch inking can be used for text input. Otherwise, false.

Gets whether the user prefers to write with their left or right hand.

The user's preferred writing hand. The default is Right.

Gets whether ink/handwriting input telemetry data can be collected and sent to Microsoft for improving recognition and suggestion capabilities.

True if consent has been granted. Otherwise, false.

Creates a PenAndInkSettings object with default property values.

A PenAndInkSettings object with default property values.

Identifies the preferred writing hand, as specified by the user in **Settings -> Devices -> Pen & Windows Ink -> Choose which hand you write with**.

The user prefers to write with their left hand.

The user prefers to write with their right hand.

Identifies the shape of the PenTip.

Circular or elliptical pen tip. Use Size to specify the dimensions.

Square or rectangular pen tip. Use Size to specify the dimensions.

Represents a single node from the tree of objects generated by the ink analysis process.

Gets the position and size of a single node belonging to the IInkAnalysisNode object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the IInkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of a single node belonging to the IInkAnalysisNode object.

Gets the unique identifier of a single node belonging to the IInkAnalysisNode object.

Gets the kind of ink input identified by ink analysis for the IInkAnalysisNode object.

Gets the parent node of the IInkAnalysisNode object.

Gets the oriented and snapped, bounding rectangle of a single node belonging to the IInkAnalysisNode object.

The X, Y coordinates for each vertex point of the bounding box for the IInkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the IInkAnalysisNode object.

Type: IVectorView<uint>

Represents a factory for generating InkAnalyzer objects used in ink analysis.

Retrieves a new instance of an InkAnalyzer object.

Specifies the shapes that an InkAnalyzer can recognize when InkAnalysisNode.Kind is set to InkDrawing.

Drawing is recognized as a circle.

Drawing is recognized as a diamond.

Drawing is not recognized as one of the shapes listed.

Drawing is recognized as an ellipse.

Drawing is recognized as an equilateral triangle.

Drawing is recognized as a hexagon.

Drawing is recognized as an isosceles triangle.

Drawing is recognized as a parallelogram.

Drawing is recognized as a pentagon.

Drawing is recognized as a quadrilateral.

Drawing is recognized as a right rectangle.

Drawing is recognized as a right angle triangle.

Drawing is recognized as a square.

Drawing is recognized as a trapezoid.

Drawing is recognized as a triangle.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.InkBullet.

Gets the bounding rectangle of the InkAnalysisInkBullet object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkBullet object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisInkBullet object.

Gets the unique identifier of the InkAnalysisInkBullet object.

Gets the kind of ink input identified by the InkAnalysisInkBullet object.

Gets the parent node of the InkAnalysisInkBullet object.

Gets the recognized text associated with the InkAnalysisInkBullet object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkBullet object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkBullet object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkBullet object.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.InkDrawing.

Gets the bounding rectangle of the InkAnalysisInkDrawing object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkDrawing object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets the X, Y coordinates of the of the InkAnalysisInkDrawing object, in device-independent pixel (DIP), relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisInkDrawing object.

Gets the shape of the ink input identified by ink analysis of the InkAnalysisInkDrawing object.

Gets the unique identifier of the InkAnalysisInkDrawing object.

Gets the kind of ink input identified by the InkAnalysisInkDrawing object.

Gets the parent node of the InkAnalysisInkDrawing object.

Gets the collection of X, Y coordinates for all points used to specify the shape of the InkAnalysisInkDrawing object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkDrawing object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkDrawing object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkDrawing object.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.InkWord.

Gets the bounding rectangle of the InkAnalysisInkWord object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisInkWord object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisInkWord object.

Gets the unique identifier of the InkAnalysisInkWord object.

Gets the kind of ink input identified by the InkAnalysisInkWord object.

Gets the parent node of the InkAnalysisInkWord object.

Gets the recognized text associated with the InkAnalysisInkWord object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisInkWord object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisInkWord object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets the collection of strings identified as potential matches of the InkAnalysisInkWord object.

The recognition matches as a collection of String objects. The most likely candidate is topmost in the collection.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisInkWord object.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.Line.

Gets the bounding rectangle of the InkAnalysisLine object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisLine object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisLine object.

Gets the unique identifier of the InkAnalysisLine object.

Gets the indent level (based on the number of levels from the ink input that are recognized by ink analysis) of the InkAnalysisLine object.

Gets the kind of ink input identified by the InkAnalysisLine object.

Gets the parent node of the InkAnalysisLine object.

Gets the recognized text associated with the InkAnalysisLine object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisLine object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisLine object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisLine object.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.ListItem.

Gets the bounding rectangle of the InkAnalysisListItem object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisListItem object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisListItem object.

Gets the unique identifier of the InkAnalysisListItem object.

Gets the kind of ink input identified by the InkAnalysisListItem object.

Gets the parent node of the InkAnalysisListItem object.

Gets the recognized text associated with the InkAnalysisListItem object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisListItem object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisListItem object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisListItem object.

Provides access to a single node from the tree of objects generated by the ink analysis process.

Gets the bounding rectangle of the InkAnalysisNode object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisNode object.

Gets the unique identifier of the InkAnalysisNode object.

Gets the kind of ink input identified by the InkAnalysisNode object.

Gets the parent node of the InkAnalysisListItem object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisNode object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisNode object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisNode object.

Specifies the types of nodes (or categories of ink input) that ink analysis can differentiate and recognize.

Node is for a list item bullet.

Node is for one of the recognized shapes specified in InkAnalysisDrawingKind.

Node is for a single word of text.

Node is for a single line of text.

Node is for a list item.

Node is for a paragraph of text.

Node is the first, or topmost, in the collection of nodes.

Node is for unrecognized ink.

Node is for a generic writing region.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.Paragraph.

Gets the bounding rectangle of the InkAnalysisParagraph object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisParagraph object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisParagraph object.

Gets the unique identifier of the InkAnalysisParagraph object.

Gets the kind of ink input identified by the InkAnalysisParagraph object.

Gets the parent node of the InkAnalysisParagraph object.

Gets the recognized text associated with the InkAnalysisParagraph object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisParagraph object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisParagraph object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisParagraph object.

Provides access to the results generated by the ink analysis process.

Gets the status of the ink analysis operation, such as whether any changes were applied.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.Root.

Gets the bounding rectangle of the InkAnalysisRoot object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisRoot object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisRoot object.

Gets the unique identifier of the InkAnalysisRoot object.

Gets the kind of ink input identified by the InkAnalysisRoot object.

Gets the parent node of the InkAnalysisRoot object.

Gets the recognized text associated with the InkAnalysisRoot object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisRoot object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisRoot object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the collection of child nodes belonging to the InkAnalysisRoot object.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisRoot object.

Specifies the various states of the ink analysis process.

Ink input has not changed since last ink analysis.

Ink input has changed since last ink analysis.

Specifies the types of ink strokes that can be recognized by the ink analysis process.

Indicates a non-specific ink stroke.

Indicates a non-handwriting ink stroke.

Indicates a handwriting ink stroke.

Provides access to an InkAnalysisNode of type InkAnalysisNodeKind.WritingRegion.

Gets the bounding rectangle of the InkAnalysisWritingRegion object.

The X, Y coordinates (top left) and dimensions (length and width) of the bounding box for the InkAnalysisWritingRegion object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Gets all child nodes of the InkAnalysisWritingRegion object.

Gets the unique identifier of the InkAnalysisWritingRegion object.

Gets the kind of ink input identified by the InkAnalysisWritingRegion object.

Gets the parent node of the InkAnalysisWritingRegion object.

Gets the recognized text associated with the InkAnalysisWritingRegion object.

Gets the oriented and snapped, bounding rectangle of the InkAnalysisWritingRegion object.

The X, Y coordinates for each vertex point of the bounding box for the InkAnalysisWritingRegion object, in device-independent pixels (DIPs) relative to the upper left-hand corner of the inking area.

Retrieves the unique identifiers of all nodes belonging to the InkAnalysisWritingRegion object.

Provides access to an object that can categorize ink strokes into either writing or drawing strokes, and recognize text, shapes, and basic layout structures.

Creates a new InkAnalyzer object to manage InkAnalysisNode objects generated from ink analysis.

Gets the root node of the ink analysis results.

Gets the state of the ink analysis process.

Adds data for a single ink stroke to the ink analysis results.

The ink stroke from which to extract the data to add to the ink analysis results.

Adds data for multiple ink strokes to the ink analysis results.

The collection of ink strokes from which to extract the data to add to the ink analysis results.

Aynchronously generates the tree of objects for the ink analysis process.

The results of the analysis as an InkAnalysisResult object.

Delete all nodes from the last ink analysis process.

Delete all nodes for the specified ink stroke from the last ink analysis process.

The unique identifier of the ink stroke.

Delete all nodes for the specified ink strokes from the last ink analysis process.

The collection of unique ink stroke identifiers.

Update all nodes for the specified ink stroke from the last ink analysis process.

Sets the ink analysis category for the InkAnalysisNode associated with the ink stroke.

The unique identifier for the ink stroke being categorized. The InkAnalysisStrokeKind category to assign to the InkAnalysisNode.

Represents a single ink stroke that can be rendered incrementally, using individual InkPoint objects.

Initializes a new instance of the CoreIncrementalInkStroke class.

The ink stroke attributes associated with the drawing of a CoreIncrementalInkStroke. An affine transformation matrix to apply to the CoreIncrementalInkStroke object.

Gets the bounding rectangle of the CoreIncrementalInkStroke.

The bounding rectangle of the CoreIncrementalInkStroke.

Gets the ink stroke attributes associated with the drawing of a CoreIncrementalInkStroke.

The ink stroke attributes.

Gets or sets an affine transformation matrix to apply to the CoreIncrementalInkStroke object.

The position and angle of the stroke as a 3*2 floating point matrix.

Appends one or more InkPoint objects to the collection of InkPoint objects that compose the CoreIncrementalInkStroke.

The collection of InkPoint objects to append. The bounding rectangle of the appended InkPoint objects.

Creates a new ink stroke.

The new ink stroke.

Provides properties, methods, and events for handling pointer input prior to processing by an InkPresenter object.

Gets the InkPresenter object that manages the input, processing, and rendering of ink stroke data.

Object that manages the input, processing, and rendering of ink stroke data for an InkCanvas control.

Occurs as a pointer is detected entering the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Occurs as a pointer is detected leaving the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Occurs as a pointer is detected over, but not down or in contact with, the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Occurs as a pointer is no longer detected in, or over, the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Occurs as a pointer moves within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Occurs as a pointer registers contact within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object. This can be when a mouse button is pressed or the digitizer surface is touched by a finger or pen.

Can occur as a pointer associated with a PointerPressing event is lifted, or released, while within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

Retrieves a CoreInkIndependentInputSource object for handling pointer input prior to processing by an InkPresenter object.

Object that manages the input, processing, and rendering of InkStroke data for an InkCanvas control. Object that handles the pointer input for an InkPresenter object.

Represents an object that hosts an InkPresenter without the need for an InkCanvas control.

Initializes a new CoreInkPresenterHost object that is used to manage an InkPresenter.

Gets a reference to the InkPresenter associatiated with this CoreInkPresenterHost.

The InkPresenter associatiated with this CoreInkPresenterHost.

Gets or sets the root visual container that the CoreInkPresenterHost draws to.

A node in the composition visual tree that can have children.

Defines constants that specify the pre-rendered state (Disposition ) of the "wet" ink stroke.

Ink stroke is to be canceled.

Ink stroke is to be completed.

Ink stroke is underway.

Contains ink stroke event data for an InkPresenter object.

Gets or sets the pre-rendered state of the "wet" ink stroke.

The pre-rendered state of the "wet" ink stroke.

Gets the collection of InkPoint objects processed since the last event.

The collection of InkPoint objects.

Gets a unique identifier for the input pointer.

A unique value that identifies the input pointer.

Represents the InkPresenter that manages the input, processing, and rendering of ink stroke data.

Gets the InkPresenter object that manages the input, processing, and rendering of ink stroke data.

Object that manages the input, processing, and rendering of ink stroke data.

Occurs when the InkPresenter stops processing an ink stroke in an unexpected way, CoreWetStrokeDisposition is set to Canceled, or the input is invalid, indicating the stroke was not completed.

Occurs after the InkPresenter stops processing an ink stroke (WetStrokeStopping ) or CoreWetStrokeDisposition is set to Completed, indicating the stroke is complete.

Occurs after the InkPresenter starts processing an ink stroke and before it stops processing the same stroke, indicating ink data continues to be captured.

Occurs when the InkPresenter starts processing an ink stroke.

Occurs when the InkPresenter stops processing an ink stroke, but before the stroke is finalized (WetStrokeCompleted ).

Retrieves a CoreWetStrokeUpdateSource object for handling "wet" ink strokes prior to processing by an InkPresenter object.

Object that manages the input, processing, and rendering of InkStroke data. Object that handles the "wet" ink data for an InkPresenter object.

Provides functionality to support palm rejection around an inking region.

Releases all system resources associated with the PalmRejectionDelayZonePreview object.

Creates a palm rejection region based on the specified inking panel.

The visual object associated with the inking panel. The region where palm rejection is to be enabled, relative to the coordinate space of the *inputPanelVisual*. Returns the palm rejection region.

Creates a palm rejection region based on the specified inking panel and viewport.

The visual object associated with the inking panel. The region where palm rejection is to be enabled, relative to the coordinate space of the *inputPanelVisual*. The visual object associated with the viewport within which *inputPanelVisual* is located. The viewport that contains the region where palm rejection is to be enabled, relative to the coordinate space of the *viewportVisual*. Returns a PalmRejectionDelayZonePreview object.

Provides the ability to access and observe changes to the activation state of a window, view, or other visual element.

Instantiates an InputActivationListenerPreview object for the specified AppWindow.

Specifies the changes in state of a button associated with a pointer.

Indicates a fifth action is initiated.

Indicates a fifth action is complete.

Indicates a primary action is initiated.

Indicates a primary action is complete.

Indicates a fourth action is initiated.

Indicates a fourth action is complete.

No change in button state. Default.

Indicates a secondary action is initiated.

Indicates a secondary action is complete.

Indicates a third action is initiated.A touch pointer does not use this flag.

Indicates a third action is complete.

Represents programmatically generated gamepad input.

Creates a new InjectedInputGamepadInfo object that is used to specify the gamepad input to inject.

Creates a new InjectedInputGamepadInfo object that is used to specify the gamepad input to inject based on the current state of the gamepad.

The current state of the gamepad.

Gets or sets the gamepad buttons used for input injection.

One or more gamepad buttons used for input injection.

Gets or sets the position of the left stick on the X-axis.

A value between -1.0 (pressed to the left) and 1.0 (pressed to the right).

Gets or sets the position of the left stick on the Y-axis.

A value between -1.0 (pressed towards the user) and 1.0 (pressed away from the user).

Gets or sets the position of the left trigger.

A value between 0.0 (not depressed) and 1.0 (fully depressed).

Gets or sets the position of the right stick on the X-axis.

A value between -1.0 (pressed to the left) and 1.0 (pressed to the right).

Gets or sets the position of the right stick on the Y-axis.

A value between -1.0 (pressed towards the user) and 1.0 (pressed away from the user).

Gets or sets the position of the right trigger.

A value between 0.0 (not depressed) and 1.0 (fully depressed).

Represents programmatically generated keyboard input.

Creates a new InjectedInputKeyboardInfo object that is used to specify the keyboard input to inject.

Gets or sets the various options, or modifiers, used to simulate input from physical or virtual keyboards.

The options, or modifiers, for the keyboard input.

Gets or sets an OEM, device-dependent identifier for a key on a physical keyboard.

The device-dependent identifier for the key on the keyboard.

Gets or sets a device-independent identifier mapped to a key on a physical or software keyboard.

The device-independent identifier for the key on the keyboard.

Specifies the various options, or modifiers, used to simulate input from physical or virtual keyboards through InjectedInputKeyboardInfo.

The key is an extended key, such as a function key or a key on the numeric keypad.

The key is released.

No keystroke modifier. Default.

The OEM, device-dependent identifier for the key on the keyboard.A keyboard generates two scan codes when the user types a key—one when the user presses the key and another when the user releases the key.

The key is a Unicode value.

Represents programmatically generated mouse input.

Creates a new InjectedInputMouseInfo object that is used to specify the mouse input to inject.

Gets or sets the change in value of an x-coordinate since the last mouse wheel event.

The number of notches or distance thresholds crossed since the last pointer event. The default value is 0.

Gets or sets the change in value of an x-coordinate since the last mouse wheel event.

The number of notches or distance thresholds crossed since the last pointer event. The default value is 0.

Gets or sets a value used by other properties. The value is based on the MouseOptions flags set.

The value used by other properties.

Gets or sets the various options, or modifiers, used to simulate mouse input.

The options, or modifiers, for the mouse input.

Gets or sets the baseline, or reference value, for timed input events such as a double click/tap.

The reference value for timed input events in milliseconds. If TimeOffsetInMilliseconds is set to 0, the current tick count is used.

Specifies the various options, or modifiers, used to simulate mouse input through InjectedInputMouseInfo.

Normalized absolute coordinates between 0 and 65,535. If the flag is not set, relative data (the change in position since the last reported position) is used.

Mouse tilt wheel.

Left mouse button pressed.

Left mouse button released.

Middle mouse button pressed.

Middle mouse button released.

Move (coalesce move messages). If a mouse event occurs and the application has not yet processed the previous mouse event, the previous one is thrown away. See **MoveNoCoalesce**.

Move (do not coalesce move messages). The application processes all mouse events since the previously processed mouse event. See **Move**.

No mouse modifier. Default.

Right mouse button pressed.

Right mouse button released.

Map coordinates to the entire virtual desktop.

Mouse wheel.

XBUTTON pressed.

XBUTTON released.

Specifies the pen options used to simulate pen input through InjectedInputPenInfo.

The barrel button is pressed.

The eraser button is pressed.

The pen is inverted.

No pen buttons are pressed. Default.

Represents programmatically generated pen input.

Creates a new InjectedInputPenInfo object that is used to specify the pen input to inject.

Gets or sets the pen button options.

The pen button states.

Gets or sets the pen states used to simulate pen input.

The pen states used to simulate pen input.

Gets or sets basic pointer info common to pen input.

The pointer info.

Gets or sets the force exerted by the pointer device on the surface of the digitizer.

The pen contact force exerted on the digitizer surface, normalized to a range between 0 and 1024. The default is 0.

Gets or sets the clockwise rotation, or twist, of the pointer.

The clockwise rotation, or twist, of the pointer normalized to a range between 0 and 359. The default is 0.

Gets or sets the angle of tilt of the pointer along the x-axis.

The angle of tilt of the pointer along the x-axis in a range of -90 to +90, with a positive value indicating a tilt to the right. The default is 0.

Gets or sets the angle of tilt of the pointer along the y-axis.

The angle of tilt of the pointer along the y-axis in a range of -90 to +90, with a positive value indicating a tilt toward the user. The default is 0.

Specifies the pen states used to simulate pen input through InjectedInputPenInfo.

No pen state reported. Default.

The pen contact pressure on the digitizer surface, normalized to a range between 0 and 1024. The default is 0 if the device does not report pressure.

The clockwise rotation, or twist, of the pointer normalized in a range of 0 to 359. The default is 0.

The angle of tilt of the pointer along the x-axis in a range of -90 to +90, with a positive value indicating a tilt to the right. The default is 0.

The angle of tilt of the pointer along the y-axis in a range of -90 to +90, with a positive value indicating a tilt toward the user. The default is 0.

Contains the screen coordinates of the pointer in device-independent pixel (DIP).

The x-coordinate of the pointer in device-independent pixel (DIP).

The y-coordinate of the pointer in device-independent pixel (DIP).

Contains basic pointer information common to all pointer types.

A high resolution (less than one microsecond) time stamp used for time-interval measurements.

The screen coordinates of the pointer in device-independent pixel (DIP).

A unique identifier for the lifetime of the pointer. A pointer is created when it enters detection range and destroyed when it leaves detection range. If a pointer goes out of detection range and then returns, it is treated as a new pointer and might be assigned a new identifier.

The various options, or modifiers, used to simulate pointer input through InjectedInputMouseInfo, InjectedInputPenInfo, and InjectedInputTouchInfo.

The baseline, or reference value, in milliseconds, for timed input events such as a double click/tap.

Specifies the various options, or modifiers, used to simulate pointer input through InjectedInputMouseInfo, InjectedInputPenInfo, and InjectedInputTouchInfo.

Indicates that the pointer is departing in an abnormal manner, such as when the system receives invalid input for the pointer or when a device with active pointers departs abruptly. If the application receiving the input is in a position to do so, it should treat the interaction as not completed and reverse any effects of the pointer.

Indicates that this pointer was captured by (associated with) another element and the original element has lost capture.

Indicates a suggestion from the source device about whether the pointer represents an intended or accidental interaction, which is especially relevant for touch pointers where an accidental interaction (such as with the palm of the hand) can trigger input. The presence of this flag indicates that the source device has high confidence that this input is part of an intended interaction.

Indicates a primary action.

Indicates that the pointer is in contact with the digitizer surface or area. When this flag is not set, it indicates a hovering pointer.

Indicates that the pointer continues to exist. When this flag is not set, it indicates the pointer has left detection range.

Indicates the arrival of a new pointer.

No pointer modifier. Default.

Indicates that this pointer made contact with the digitizer surface. A touch pointer has this flag set when it is in contact with the digitizer surface.

Indicates that this pointer ended contact with the digitizer surface. A touch pointer has this flag set when it ends contact with the digitizer surface.

Indicates that the pointer can perform actions beyond those available to non-primary pointers. For example, when a primary pointer makes contact with a window’s surface, it might provide the window an opportunity to activate.

Indicates a secondary action.

Indicates a simple update that does not include pointer state changes.

The offsets, from the injected pointer, for the bounding box that represents the touch contact area.

The location of the bottom side of the rectangle, in device-independent pixel (DIP).

The location of the left side of the rectangle, in device-independent pixel (DIP).

The location of the left side of the rectangle, in device-independent pixel (DIP).

The location of the top side of the rectangle, in device-independent pixel (DIP).

Specifies the system shortcuts for InjectShortcut.

Indicates traversal through a back stack.

Indicates traversal to a search screen.

Indicates traversal to a start, or home, screen.

Represents programmatically generated touch input.

Creates a new InjectedInputTouchInfo object that is used to specify the touch input to inject.

Gets or sets the bounding box that represents the touch contact area.

The contact area in device-independent pixel (DIP). The default is a 0-by-0 rectangle, centered around the pointer PixelLocation.

Gets or sets the counter-clockwise angle of rotation around the major axis of the pointer device (the z-axis, perpendicular to the surface of the digitizer).

The pointer orientation, with a value between 0 and 359, where 0 indicates a touch pointer aligned with the x-axis and pointing from left to right; increasing values indicate degrees of rotation in the counter-clockwise direction. The default is 0.

Gets or sets basic pointer info common to touch input.

The pointer info.

Gets or sets the force exerted by the pointer device on the surface of the digitizer.

The touch contact force exerted on the digitizer surface, normalized to a range between 0 and 1024. The default is 0.

Gets or sets the touch states used to simulate touch input.

The touch states used to simulate touch input.

Specifies the touch states used to simulate touch input through InjectedInputTouchInfo.

The screen coordinates of the bounding box that represents the touch contact area.

No touch state reported. Default.

The counter-clockwise angle of rotation around the major axis of the pointer device (the z-axis, perpendicular to the surface of the digitizer).

The force exerted by the pointer device on the surface of the digitizer.

Specifies the type of visual feedback displayed for the injected input type.

Indicates default system visual feedback for the type of injected input.

Indicates indirect visual feedback for the type of injected input (pen and touch only, typically for projection to an external monitor).

Indicates no visual feedback for the injected input. Default.

Represents the virtual input device for sending the input data.

Initializes a virtual gamepad device that can synthesize input events and provide corresponding input data to the system.

Initializes a virtual pen device that can synthesize input events and provide corresponding input data to the system.

The visual feedback mode for pen input injection.

Initializes a virtual touch device that can synthesize input events and provide corresponding input data to the system.

The type of visual feedback displayed for touch input injection.

Sends programmatically generated gamepad input to the system.

The gamepad input specified by InjectedInputGamepadInfo.

Sends programmatically generated keyboard input to the system.

The keyboard input specified by InjectedInputKeyboardInfo.

Sends programmatically generated mouse input to the system.

The mouse input specified by InjectedInputMouseInfo.

Sends programmatically generated pen input to the system.

The pen input specified by InjectedInputPenInfo.

Sends programmatically generated system shortcuts to the system.

The system shortcuts.

Sends programmatically generated touch input to the system.

The touch input specified by InjectedInputTouchInfo.

Attempts to create a new instance of the InputInjector class.

If successful, returns a new instance of the InputInjector class. Otherwise, returns null.

Attempts to create a new instance of the InputInjector class.

If successful, returns a new instance of the InputInjector class. Otherwise, returns null.

Shuts down the virtual gamepad device created with InitializeGamepadInjection.

Shuts down the virtual pen device created with InitializePenInjection.

Shuts down the virtual touch device created with InitializeTouchInjection.

Interprets user interactions from hands, motion controllers, and system voice commands to surface spatial gesture events, which users target using their gaze or a motion controller's pointing ray.

Initializes a new SpatialGestureRecognizer with the specified gesture settings.

The gesture settings for the new recognizer.

Gets the current SpatialGestureSettings for this recognizer.

The gesture settings.

Occurs when a Hold gesture is canceled.

Occurs when a Hold gesture completes.

Occurs when an interaction becomes a Hold gesture.

Occurs when a Manipulation gesture is canceled.

Occurs when a Manipulation gesture is completed.

Occurs when an interaction becomes a Manipulation gesture.

Occurs when a Manipulation gesture is updated due to hand movement.

Occurs when a Navigation gesture is canceled.

Occurs when a Navigation gesture is completed.

Occurs when an interaction becomes a Navigation gesture.

Occurs when a Navigation gesture is updated due to hand or motion controller movement.

Occurs when gesture recognition ends, due to completion or cancellation of a gesture (this is the last event to fire).

Occurs when gesture recognition begins (this is the first event to fire).

Occurs when a Tap or DoubleTap gesture is recognized.

Cancels all in-progress gestures and abandons any captured interactions.

Track all input events that occur as part of the specified interaction.

The interaction to capture from the InteractionDetected event.

Attempts to change the gesture settings for this recognizer.

The new SpatialGestureSettings to switch to. True if the switch was successful; otherwise, false.

This enumeration represents the set of gestures that may be recognized by a SpatialGestureRecognizer.

Enable support for the double-tap gesture.

Enable support for the hold gesture.

Enable support for the manipulation gesture, tracking changes to the hand's position.

Enable support for the navigation gesture, in the horizontal axis using rails (guides).

Enable support for the navigation gesture, in the vertical axis using rails (guides).

Enable support for the navigation gesture, in the depth axis using rails (guides).

Enable support for the navigation gesture, in the horizontal axis.

Enable support for the navigation gesture, in the vertical axis.

Enable support for the navigation gesture, in the depth axis.

Disable support for gestures.

Enable support for the tap gesture.

Provides data for the SpatialGestureRecognizer.HoldCanceled event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Provides data for the SpatialGestureRecognizer.HoldCompleted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Provides data for the SpatialGestureRecognizer.HoldStarted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointing ray, for use in targeting this gesture.

The coordinate system in which to express the pointer poses. The pointer poses.

Represents an interaction caused by a hand, motion controller, or the user's voice.

Gets the state associated with the source update that triggered this gesture.

The state.

Represents the specifics of a motion controller.

Gets whether the motion controller has a thumbstick.

Whether the controller has a thumbstick.

Gets whether the motion controller has a touchpad.

Whether the controller has a touchpad.

Gets the product identifier for this motion controller.

The product identifier.

Provides access to the motion controller's ability to vibrate in the user's hand.

The simple haptics controller.

Gets the vendor identifier for this motion controller.

The vendor identifier.

Gets the version, or revision, number for this motion controller.

The version number.

Gets information about the motion controller's current battery state.

Information about the motion controller's current battery state, if available; otherwise, null.

Gets a renderable model stream for this controller, which can be unpacked and rendered to represent this controller.

Operation that triggers once the renderable model stream is loaded, yielding the stream or null if there is no model available.

Represents state specific to motion controllers.

Gets whether a motion controller is experiencing a thumbstick press.

Whether the source is experiencing a thumbstick press.

Gets whether a motion controller is experiencing a touchpad press.

Whether the source is experiencing a touchpad press.

Gets whether a motion controller is experiencing a touchpad touch.

Whether the source is experiencing a touchpad touch.

Gets a value between -1.0 and 1.0 representing the horizontal position of the thumbstick.

The thumbstick X value.

Gets a value between -1.0 and 1.0 representing the vertical position of the thumbstick.

The thumbstick Y value.

Gets a value between -1.0 and 1.0 representing the horizontal position of the user's finger on the touchpad.

The touchpad X value.

Gets a value between -1.0 and 1.0 representing the vertical position of the user's finger on the touchpad.

The touchpad Y value.

Provides data for the SpatialInteractionManager.InteractionDetected event.

Gets the detected interaction, for routing to a SpatialGestureRecognizer.

The interaction.

Gets the specific source associated with the detected interaction.

The interaction source.

Gets the kind of source associated with the detected interaction.

The interaction source kind.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in routing this interaction to a SpatialGestureRecognizer.

The coordinate system in which to express the pointer poses. The pointer poses.

Provides access to user input from hands, motion controllers, and system voice commands.

Occurs when a new interaction is available for routing to a SpatialGestureRecognizer.

Occurs when a new hand, motion controller, or speech source has been detected.

Occurs when a hand, motion controller, or speech source is no longer available.

Occurs when a hand, motion controller, or speech source has entered a pressed state.

Occurs when a hand, motion controller, or speech source has exited a pressed state.

Occurs when a hand, motion controller, or speech source has experienced a change to its SpatialInteractionSourceState.

Get the state of all interaction sources detected for the specified timestamp.

The time to query the state of interaction sources. The source states detected.

Get the SpatialInteractionManager associated with the current CoreWindow.

The spatial interaction manager.

Gets whether the specified interaction source is supported on this device.

The interaction source. Whether the interaction source is supported.

Specifies the kind of press represented by a SourcePressed or SourceReleased event.

For motion controllers, a grasp represents the user squeezing their fist tightly. This may be detected by grip buttons or a palm trigger.

For motion controllers, a Menu press represents the controller's Menu button being pressed.

This is a SourceDetected, SourceLost or SourceUpdated event, which does not represent a press or a release.

Select represents the primary press for a spatial interaction source:

For motion controllers, a thumbstick press represents the user clicking down on the thumbstick.

For motion controllers, a touchpad press represents the user clicking down on the touchpad.

Represents one detected instance of a hand, motion controller, or speech source that can cause interactions and gestures.

Represents the specifics of a detected motion controller.

The motion controller, or null if the source is not a motion controller.

Gets whether the interaction source represents the user's left hand or right hand.

The handedness.

Gets the identifier for the hand, motion controller, or speech source.

The ID.

Gets whether the source supports grasps.

True for some motion controllers, and false for other interaction sources.

Gets whether the source supports Menu presses.

Whether the source supports Menu presses.

Gets whether the source can provide pointer poses.

Returns true for motion controllers that support positional tracking and false for other interaction sources.

Gets the interaction source type.

The interaction source type.

Synchronously requests a HandMeshObserver to provide mesh updates for each frame that tracks the detected shape of a hand.

A hand mesh observer if this source supports hand meshes; otherwise, null.

Requests a HandMeshObserver to provide mesh updates for each frame that tracks the detected shape of a hand.

An operation that triggers with a hand mesh observer (if this source supports hand meshes); otherwise, an operation that returns null.

Get the state of this source as of the specified timestamp.

The time to query for the state of this interaction source. The state.

Provides data for the SpatialInteractionSource Source events.

Gets the kind of press or release associated with the event.

The press kind.

Gets the interaction source state associated with the event.

The interaction source state.

Specifies whether the interaction source represents the user's left hand or right hand.

The interaction source represents the user's left hand.

The interaction source represents the user's right hand.

The interaction source does not represent a specific hand.

Specifies the kind of an interaction source.

The interaction source is a motion controller.

The interaction source is one of the user's hands.

The interaction source is of a kind not known in this version of the API.

The interaction source is the user's speech, when speaking a system command such as "Select".

Represents the grip pose and pointer pose of a hand or motion controller.

Gets the angular velocity of a hand or motion controller.

The angular velocity.

Gets the grip pose orientation, representing the orientation of the user's hand as it holds a motion controller.

The orientation.

Gets the grip pose position, representing the position of the user's hand, either directly or where it holds a motion controller.

The position.

Gets the accuracy of an interaction source's positional tracking.

The position accuracy.

Gets the pointer pose for a particular spatial interaction source, such as a motion controller, at a given timestamp.

The interaction source pointer pose.

Gets the velocity of a hand or motion controller.

The velocity.

Specifies the accuracy of an interaction source's positional tracking.

The interaction source's position is only being tracked approximately, with either an inferred or body-locked position.

The interaction source's position is being tracked at its nominal accuracy.

Represents advanced state of a hand or motion controller.

Gets the risk that detection of a hand or motion controller will be lost as a value from 0.0 to 1.0.

The source loss risk.

Get the position, orientation and velocity of the hand or motion controller, expressed in the specified coordinate system.

The coordinate system in which to express the hand's location. The location.

Gets the direction you should suggest that the user move their hand or motion controller if it is nearing the edge of the detection area.

The coordinate system in which to express the mitigation direction. The mitigation direction vector, or null if there is no mitigation direction.

Represents a snapshot of the state of a spatial interaction source (hand, motion controller, or speech) at a given time.

Gets state specific to motion controllers.

The motion controller properties.

Gets whether an input device detects a grasp/grab action (how users take direct action on objects in order to manipulate them).

True, if the source detects a grasp/grab action. Otherwise, false.

Gets whether a motion controller is experiencing a Menu press.

Whether the source is experiencing a Menu press.

Gets whether a hand or motion controller is experiencing any press.

Whether the source is experiencing any press.

Gets whether a hand or motion controller is experiencing a primary Select press.

Whether the source is experiencing a Select press.

Gets advanced state of the interaction source.

The properties.

Gets the amount to which a hand or motion controller is experiencing a primary Select press, as a value between 0.0 and 1.0.

The amount to which the source is experiencing a Select press.

Gets the interaction source that this state describes.

The source.

Gets the timestamp at which this state snapshot was taken.

The timestamp.

Gets the poses of the user's joints for this hand.

The poses of the user's hand joints if supported for this source; otherwise null.

Gets the available pointer poses, such as the user's head gaze, eye gaze and each motion controller's pointer pose, for the timestamp when this state snapshot was taken.

The coordinate system in which to express the pointer poses. The pointer poses.

Provides data for the SpatialGestureRecognizer.ManipulationCanceled event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Provides data for the SpatialGestureRecognizer.ManipulationCompleted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Get the relative motion of the hand since the start of the Manipulation gesture.

The coordinate system in which to express the delta. The delta.

Represents the relative motion of the hand since the start of a Manipulation gesture.

Get the relative translation of the hand since the start of a Manipulation gesture.

The translation.

Provides data for the SpatialGestureRecognizer.ManipulationStarted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in targeting this gesture.

The coordinate system in which to express the pointer poses. The pointer poses.

Provides data for the SpatialGestureRecognizer.ManipulationUpdated event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Get the relative motion of the hand since the start of the Manipulation gesture.

The coordinate system in which to express the delta. The delta.

Provides data for the SpatialGestureRecognizer.NavigationCanceled event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Provides data for the SpatialGestureRecognizer.NavigationCompleted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Gets the normalized offset of the hand or motion controller within the unit cube for all axes for this Navigation gesture.

The normalized offset.

Provides data for the SpatialGestureRecognizer.NavigationStarted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Gets whether the navigation gesture the user is performing involves motion on the horizontal axis.

Whether the gesture involves horizontal navigation.

Gets whether the navigation gesture the user is performing involves motion on the vertical axis.

Whether the gesture involves vertical navigation.

Gets whether the navigation gesture the user is performing involves motion on the depth axis.

Whether the gesture involves depth navigation.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in targeting this gesture.

The coordinate system in which to express the pointer poses. The pointer poses.

Provides data for the SpatialGestureRecognizer.NavigationUpdated event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Gets the normalized offset of the hand or motion controller within the unit cube for all axes for this Navigation gesture.

The normalized offset.

Represents a motion controller's pointer pose in relation to its surroundings.

Gets the forward direction of the motion controller's pointer pose in the specified coordinate system, as a unit vector.

The forward direction unit vector.

Gets the orientation of the motion controller's pointer pose in the specified coordinate system.

The orientation.

Gets the position of the motion controller's pointer pose in the specified coordinate system.

The position.

Gets the accuracy of an interaction source's positional tracking.

The position accuracy.

Gets the up direction that orients the motion controller's pointer pose in the specified coordinate system, as a unit vector.

The up direction unit vector.

Represents the available spatial pointer poses, such as the user's head gaze, eye gaze and each motion controller's pointer pose, for use in targeting hand gestures, motion controller presses, and speech interactions.

Gets the user's eye gaze for this timestamp.

The eye gaze if supported by the current headset; otherwise, null.

Gets the user's head gaze for this timestamp.

The head gaze.

Gets whether the user's head gaze is being captured by system UI at the moment (preventing gaze-driven presses from being delivered to the view associated with this SpatialPointerPose ).

Whether head gaze is being captured by the system.

Gets the timestamp when the pointing rays are determined.

The timestamp.

Gets the head gaze and motion controller pointer poses for the specified timestamp.

The coordinate system in which to express the pointer poses. The timestamp, past or future. The pointer poses, or null if the specified coordinate system cannot be located.

Gets the pointer pose for a particular spatial interaction source, such as a motion controller, at a given timestamp.

The spatial interaction source for which a pointer pose should be determined. The interaction source pointer pose.

Provides data for the SpatialGestureRecognizer.RecognitionEnded event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Provides data for the SpatialGestureRecognizer.RecognitionStarted event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

Returns whether the specified gesture is possible, given the capabilities of the relevant interaction source. For example, Voice cannot be used for Manipulation gestures.

The specific single gesture to test for. Whether the gesture is still possible.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in targeting this gesture.

The coordinate system in which to express the pointer poses. The pointer poses.

Provides data for the SpatialGestureRecognizer.Tapped event.

Gets the kind of interaction source associated with this gesture.

The interaction source kind.

The tap number represented by this gesture, either 1 or 2.

The tap count.

Gets the available pointer poses, such as the user's head gaze and each motion controller's pointer pose, for use in targeting this gesture.

The coordinate system in which to express the pointer poses. The pointer poses.

Specifies the type of content contained in the adaptive notification.

Text content.

Represents the text content of an adaptive notification.

Creates a new instance of the AdaptiveNotificationText class.

Specifies hints for formatting the notification, such as the text style, text wrapping, and alignment. For a complete list of hints, see the text element entry of the Adaptive notifications schema.

A collection of name-value pairs that provide hints for formatting the notification, such as the text style, text wrapping, and alignment. For a complete list of hints, see the text element entry of the Adaptive notifications schema.

Specifies the type of content the notification contains. This property always returns AdaptiveNotificationContentKind.Text.

A value that specifies the type of content the notification contains. This property always returns AdaptiveNotificationContentKind.Text.

Gets or sets the language of the text content.

The language of the text content. See the National Language Support (NLS) API Reference for a list of valid values.

Gets or sets the text content to display.

The text content to display.

Defines the content, associated metadata, and expiration time of an update to a tile's badge overlay. A badge can display a number from 1 to 99 or a [status glyph](https://docs.microsoft.com/previous-versions/windows/apps/hh779719(v=win.10)).

Creates and initializes a new instance of the BadgeNotification.

The XML content that defines the badge update.

Gets the XML that defines the value or glyph used as the tile's badge.

The object that contains the XML.

Gets or sets the time that Windows will remove the badge from the tile. By default, local badge notifications do not expire and push, periodic, and scheduled badge notifications expire after three days. It is a best practice to explicitly set an expiration time to avoid stale content.

The date and time that the notification should be removed.

Specifies the template to use for a tile's badge overlay. Used by BadgeUpdateManager.getTemplateContent.

A system-provided glyph image. For more information, see [Badge overview](https://docs.microsoft.com/previous-versions/windows/apps/hh779719(v=win.10)).

A numerical value from 1 to 99. Values greater than 99 are accepted, but in those cases "99+" is displayed instead of the actual number. In scenarios where your numbers are expected to be greater than 99, you should consider using a glyph instead.

Creates BadgeUpdater objects that you use to manipulate a tile's badge overlay. This class also provides access to the XML content of the system-provided badge templates so that you can customize that content for use in updating your badges.

Creates and initializes a new instance of the BadgeUpdater, which lets you change the appearance or content of the badge on the calling app's tile.

The object you will use to send changes to the app tile's badge.

Creates and initializes a new instance of the BadgeUpdater for a specified app tile's badge, usually the tile of another app in the package. The BadgeUpdater lets you change the appearance or content of that badge.

The unique ID of the tile whose badge you want to update. The object you will use to send changes to the application tile's badge.

Creates and initializes a new instance of the BadgeUpdater, which enables you to change the appearance or content of a badge on a secondary tile. The tile can belong to the calling app or any other app in the same package.

The unique ID of the tile. The object you will use to send badge updates to the tile identified by *tileID*.

Creates and initializes a new BadgeUpdateManagerForUser for the specified user, which lets you change the appearance or content of the badge on a tile for a specific user.

The user who will receive the tile badge updates. An object that will update tile badges for the specified user.

Gets the XML content of one of the predefined badge templates so that you can customize it for a badge update.

The type of badge template, either a glyph or a number. The object that contains the template XML.

Creates BadgeUpdater objects that you use to manipulate a tile's badge overlay for a specific user. This class also provides access to the XML content of the system-provided badge templates so that you can customize that content for use in updating your badges.

Gets the user targeted by the badge update manager.

The user targeted by the badge update manager.

Creates and initializes a new instance of the BadgeUpdater, which lets you change the appearance or content of the badge for the bound user on the calling app's tile.

A BadgeUpdater for the current app and user.

Creates a new BadgeUpdater for the bound user and the specified app tile's badge, usually the tile of another app in the package. The BadgeUpdater lets you change the appearance or content of that badge.

The ID of the app that owns the tile to update. A BadgeUpdater for the current user and the specified app.

Creates a BadgeUpdater, which enables you to change the appearance or content of a badge on a secondary tile for the bound user. The tile can belong to the calling app or any other app in the same package.

The ID of the secondary tile. A BadgeUpdater for the secondary tile of the current app for the current user.

Updates a badge overlay on the specific tile that the updater is bound to.

Removes the badge from the tile that the updater is bound to.

Begins a series of timed updates for the badge from a web resource that the updater is bound to. Updates begin at a specified time. Note that only web resources (http/https) are allowed in a periodic update.

The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. The time at which the Uniform Resource Identifier (URI) should first be polled for new badge content. The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content, following the initial update at *startTime*.

Begins a series of timed updates for the badge from a web resource that the updater is bound to, beginning immediately. Note that only web resources (http/https) are allowed in a periodic update.

The Uniform Resource Identifier (URI) from which the XML content of the badge update will be retrieved. The frequency with which the Uniform Resource Identifier (URI) is polled for new badge content.

Cancels the current series of timed updates for the badge that the updater is bound to.

Applies a change to the badge's glyph or number.

The object that supplies the new XML definition for the badge.

Defines the content for an adaptive notification.

Specifies hints for formatting the notification, such as the text style, text wrapping, and alignment. For a complete list of hints, see the text element entry of the Adaptive notifications schema.

A collection of name-value pairs that provide hints for formatting the notification, such as the text style, text wrapping, and alignment. For a complete list of hints, see the text element entry of the Adaptive notifications schema.

Specifies the type of content the notification contains.

A value that specifies the type of content the notification contains.

Specifies the types of hints available to adaptive notifications.

Gets a string representation of the align hint for adaptive notifications.

The string representation of the align hint.

Gets a string representation of the max-lines hint for adaptive notifications.

The string representation of the max-lines hint.

Gets a string representation of the min-lines hint for adaptive notifications.

The string representation of the min-lines hint.

Gets a string representation of the style hint for adaptive notifications.

The string representation of the style hint.

Gets a string representation of the text-stacking hint for adaptive notifications.

The string representation of the text-stacking hint.

Gets a string representation of the wrap hint for adaptive notifications.

The string representation of the wrap hint.

Specifies the text styles available for adaptive notifications.

Gets the string that represents the Base text style.

The string that represents the Base text style.

Gets the string that represents the BaseSubtle text style.

The string that represents the BaseSubtle text style.

Gets the string that represents the Body text style.

The string that represents the Body text style.

Gets the string that represents the BodySubtle text style.

The string that represents the BodySubtle text style.

Gets the string that represents the Caption text style.

The string that represents the Caption text style.

Gets the string that represents the CaptionSubtle text style.

The string that represents the CaptionSubtle text style.

Gets the string that represents the Header text style.

The string that represents the Header text style.

Gets the string that represents the HeaderNumeral text style.

The string that represents the HeaderNumeral text style.

Gets the string that represents the HeaderNumeralSubtle text style.

The string that represents the HeaderNumeralSubtle text style.

Gets the string that represents the HeaderSubtle text style.

The string that represents the HeaderSubtle text style.

Gets the string that represents the Subheader text style.

The string that represents the Subheader text style.

Gets the string that represents the SubheaderNumeral text style.

The string that represents the SubheaderNumeral text style.

Gets the string that represents the SubheaderNumeralSubtle text style.

The string that represents the SubheaderNumeralSubtle text style.

Gets the string that represents the SubheaderSubtle text style.

The string that represents the SubheaderSubtle text style.

Gets the string that represents the Subtitle text style.

The string that represents the Subtitle text style.

Gets the string that represents the SubtitleSubtle text style.

The string that represents the SubtitleSubtle text style.

Gets the string that represents the Title text style.

The string that represents the Title text style.

Gets the string that represents the TitleNumeral text style.

The string that represents the TitleNumeral text style.

Gets the string that represents the TitleSubtle text style.

The string that represents the TitleSubtle text style.

Specifies the binding templates available for adaptive notifications.

Gets the string representation of the ToastGeneric binding.

The string representation of the ToastGeneric binding.

Represents a notification.

Creates a new instance of the Notification class.

Gets or sets the notification's expiration.

The notification's expiration.

Gets or sets the visual for the notification.

The visual for this notification.

Represents the binding element of an adaptive notification.

Gets the formatting hints for the notification binding.

A collection of property/value pairs.

Gets or sets the language for this notification binding.

The language of the text content. See the National Language Support (NLS) API Reference for a list of valid values.

Gets or sets the template for this binding visual.

The template for this binding visual. You can use the properties of the KnownNotificationBindings class to retrieve the string for each of the available template types.

Retrieves the text elements of this binding.

A collection of the text elements in this binding.

Stores data for display in a toast notification.

Creates a new NotificationData.

Creates a new NotificationData that contains the specified values.

A collection of keys and values for the new NotificationData, such as "progressValue", "0".

Creates a new NotificationData that contains the specified values and the specified sequence number.

A collection of keys and values for the new NotificationData, such as "progressValue", "0". A value greater than or equal to 0 that specifies the sequence number of the new notification data. When multiple NotificationData objects are received, the system displays the NotificationData with the greatest non-zero number. Setting this value to 0 causes it to always displays.

Gets or sets the sequence number of this notification data. The system uses the sequence number to determine whether the notification data is out-of-date.

A value greater than or equal to 0 that specifies the sequence number of this notification data. When multiple NotificationData objects are received, the system displays the NotificationData with the greatest non-zero number. Setting this value to 0 causes it to always displays.

Gets the collection of keys and values for the new NotificationData, such as "progressValue", "0".

The collection of keys and values for the new NotificationData, such as "progressValue", "0".

Specifies the type of notification.

The notification is a toast notification.

The notification type is unknown.

Specifies whether notification mirroring is allowed. Mirroring enables a notification to be displayed on multiple devices.

Notification mirroring is allowed.

Notification mirroring is disabled.

Specifies the limitations on tile or toast notification display.

An administrator has disabled all notifications on this computer through group policy. The group policy setting overrides the user's setting.

This app has not declared itself toast capable in its package.appxmanifest file. This setting is found on the manifest's Application UI page, under the Notification section. For an app to send toast, the **Toast Capable** option must be set to "Yes".

The user has disabled notifications for this app.

The user or administrator has disabled all notifications for this user on this computer.

All notifications raised by this app can be displayed.

Describes the results of a notification update.

The notification update failed.

The specified notification couldn't be found.

The notification was updated.

Represents the visual element of a notification. The visual element contains bindings, which contain the text and other visual content for the notification.

Gets the bindings for this notification visual. Bindings contain text and other visual content for the notification.

A collection of bindings for this notification visual.

Gets or sets the language for this notification visual.

The language of this notification visual. See the National Language Support (NLS) API Reference for a list of valid values.

Retrieves the binding with the specified template.

The template for the binding visual. You can use the properties of the KnownNotificationBindings class to retrieve the string for each of the available template types. The binding with the specified template, if it exists; otherwise, **null**.

Specifies the time period for subsequent polls of the tile or badge data source for new content.

Poll once a day.

Poll every half an hour.

Poll every hour.

Poll every 6 hours.

Poll every 12 hours.

Defines the visual content and timing for a single, non-recurring scheduled update to a tile.

Creates and initializes a new instance of the ScheduledTileNotification object for use with a TileUpdater.

The object that provides the content for the tile notification. The time at which the tile should be updated with the notification information.

Gets the XML description of the content of the scheduled tile update.

The object that contains the notification content.

Gets the time at which the tile is scheduled to be updated.

The date and time that the notification will be updated.

Gets or sets the time after which the tile notification should no longer be shown. By default, a tile notification does not expire. It is a best practice to explicitly set an expiration time to avoid stale content.

The time after which the tile update should no longer be shown.

Gets or sets the unique ID that is used to identify the scheduled tile in the schedule.

The notification's identifier. This string is limited to 16 characters.

Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue.

A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form for the string content, we recommend that it should relate to the content of the notification.

Contains the XML that defines the toast notification that will display at the scheduled time.

Creates and initializes a new instance of a ScheduledToastNotification that will be displayed only once.

The XML that defines the toast notification content. The date and time that Windows should display the toast notification. You must call AddToSchedule before this time.

Deprecated in Windows 10. On Windows 8 systems, creates and initializes a new instance of a ScheduledToastNotification that re-appears after a specified time after initially appearing. On Windows 10, this functions equivalently to ScheduledToastNotification(XmlDocument, DateTime). To achieve the same snooze interval behavior in Windows 10, you can use buttons on your toasts.

The XML that defines the toast notification content. The date and time that Windows should first display the toast notification. You must call AddToSchedule before this time. The amount of time between occurrences of the notification. To be valid, this value must be no less than 60 seconds and no more than 60 minutes. The maximum number of times to display this notification. Valid values range from 1 to 5.

Gets the XML that defines this scheduled toast notification.

The object that contains the XML.

Gets the time that this toast notification is scheduled to be displayed.

The time that this toast notification is scheduled to be displayed.

Gets or sets the expiration time of the notification.

The expiration time of the notification.

Gets or sets the group identifier for the notification.

The group identifier for the notification.

Gets a developer-specified value used to identify a specific scheduled toast.

The identifier. This string is limited to 16 characters.

Gets the maximum number of times to display this notification.

The maximum number of times to display this notification. This will be a value between 1 and 5, inclusive.

Gets or sets a value that specifies whether notification mirroring is enabled. (Notification mirroring enables a notification to appear on multiple devices.)

**true** to enable notification mirroring; otherwise, **false**.

Gets or sets a remote id for the notification that enables the system to correlate this notification with another one generated on another device.

A remote id for the notification that enables the system to correlate this notification with another one generated on another device.

Gets the amount of time between occurrences of the notification.

The time between occurrences of the notification. This value will be between 60 seconds and 60 minutes, inclusive.

Gets or sets whether a toast's pop-up UI is displayed on the user's screen.

Set to **true** to suppress the popup message; otherwise, false. The default value is false, meaning the toast's pop-up message will be shown. Setting this property to **true** places the toast notification silently into the action center. This enables your app to communicate with the user without interrupting them.

Gets or sets a string that uniquely identifies a toast notification inside a Group.

The unique identifier for this notification within a Group.

Provides info when the system is in the process of showing a scheduled toast notification.

Gets or sets whether Windows should perform its default handling of the notification.

Set to **false** to allow the system to perform its default handling (which is subject to user and system settings). Set to **true** to tell the system that your app has handled the notification and that it shouldn't perform default handling. The default value is **false**.

Gets the scheduled toast notification being shown.

The scheduled toast notification being shown.

Requests that the app delay showing the scheduled toast notification.

An object you can use to manage the delayed scheduled toast notification.

Provides info about a tile notification that was displayed in the **Start** menu.

Gets the arguments from the notification’s XML payload for the tile size that was displayed, or an empty string if there were no arguments provided for that size.

The arguments from the notification’s XML payload for the tile size that was displayed, or an empty string if there were no arguments provided for that size.

Provides the details of a tile flyout (mix view) notification. This includes the notification's XML content and, optionally, its expiration time. This class also provides a method by which you can retrieve the current flyout notification's XML content.

Creates a TileFlyoutNotification object for use in a tile flyout (mix view) notification. This object provides the XML content of the notification— the sub-tiles to be displayed and the text and image elements used in each sub-tile.

The XML content of the tile flyout notification.

Gets the XML description of the current tile flyout (mix view) notification. This content can then be examined or manipulated as necessary.

The XML content of the current tile flyout notification.

Gets or sets the time that the system will remove the tile flyout (mix view) notification. By default, a tile flyout notification does not expire. It is generally a best practice to explicitly set an expiration time to avoid stale content.

The date and time that the notification should be removed.

Specifies the layout template to use in a tile flyout (mix view) update. At present, only one template is defined.

Eight sub-tiles that surround a central medium (150x150) tile. Each sub-tile supports a combination of text and images.

Creates TileFlyoutUpdater objects specific to an app's primary or secondary tile, for use with a tile flyout (mix view) notification. This class also enables you to retrieve a blank tile flyout XML template to which you can add your content to define the tile flyout notification.

Creates a new TileFlyoutUpdater object for the calling app's tile, for use with a tile flyout (mix view) notification.

An object that you can use to send notification updates to the calling app's tile flyout, clear the flyout notification, and start and stop [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) flyout notifications.

Creates a new TileFlyoutUpdater object for a specified tile, for use with a tile flyout (mix view) notification. Because this method overload uses a tile ID, this tile can belong to another app in the same package as the calling app.

The ID of the app. An object that you can use to send notification updates to the tile flyout for the specified app, clear the flyout notification, and start and stop [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) flyout notifications.

Creates a new TileFlyoutUpdater object for one of an app's secondary tiles, for use with a tile flyout (mix view) notification.

The secondary tile's ID, assigned to the secondary tile when it was created. An object that you can use to send notification updates to the secondary tile's flyout, clear the flyout notification, and start and stop [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) flyout notifications.

Gets a blank XML template content that defines a tile flyout (mix view) notification. You can then fill in this template as needed, using Document Object Model (DOM) API.

The specific template. At this time, the only valid value is **TileFlyoutTemplate01**. The template's content represented as an XmlDocument object.

Used to send or clear a tile flyout (mix view) notification. This class also provides methods to start and stop [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) tile flyout notifications.

Gets a value that specifies whether a tile's flyout can be updated through notifications.

This value always returns **Enabled**. Mix view cannot currently be disabled.

Removes the current tile flyout (mix view) notification. A tile flyout notification does not have a default expiration time, so unless one is set explicitly through TileFlyoutNotification.ExpirationTime, this method is the only way to remove the flyout.

Launches a series of [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) updates for a tile flyout (mix view) notification, beginning at a specified time. Update content is retrieved from a specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) from which the XML content of the tile flyout update is retrieved. The date and time at which the Uniform Resource Identifier (URI) should first be polled for new content. The frequency with which the Uniform Resource Identifier (URI) is polled for new content, following the initial update at *startTime*.

Launches a series of [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) updates for a tile flyout (mix view) notification, beginning with an immediate update when the method is called. Update content is retrieved from a specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) from which the XML content of the tile flyout update is retrieved. The frequency with which the Uniform Resource Identifier (URI) is polled for new content, following the initial update.

Cancels the current series of [periodic](https://docs.microsoft.com/previous-versions/windows/apps/jj150587(v=win.10)) tile flyout (mix view) notification updates for the primary or secondary tile associated with the updater.

Sends a new tile flyout (mix view) notification to the primary or secondary tile associated with the updater.

The notification object that supplies the new content for the tile's flyout.

Defines an update to a tile, including its visuals, identification tag, and expiration time.

Creates and initializes a new instance of the TileNotification object for use with a TileUpdater.

The object that provides the content for the tile notification.

Gets the XML description of the notification content, which you can then manipulate to alter the notification.

The object that contains the notification content.

Gets or sets the time that Windows will remove the notification from the tile. By default, a tile update does not expire. It is a best practice to explicitly set an expiration time to avoid stale content.

The date and time that the notification should be removed.

Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue.

A string of 16 characters or less (plus a terminating null character) that identifies the notification in the stack. While there is no set form to the string content, we recommend that it should relate to the content of the notification.

Specifies the content template to use in a tile update. For a more detailed discussion of each tile, including an example of its XML coding, specifics on each template's image sizes, and use with different versions of the tile XML schema, see [The tile template catalog](https://docs.microsoft.com/previous-versions/windows/apps/hh761491(v=win.10)).

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareBlock**

** only**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareImage**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquarePeekImageAndText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquarePeekImageAndText02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquarePeekImageAndText03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquarePeekImageAndText04**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareText02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareText03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileSquareText04**

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

** only**.

** only**

****: One string of large block text (generally numerical) over a single, short line of regular text.

TileSquareBlock may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Block.

One image that fills the entire tile; no text. <img src="./windows.ui.notifications/images/TileSquareImage.png" alt="TileSquareImage example" />

TileSquareImage may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Image.

Top/Front: One square image, no text. Bottom/Back: One header string in larger text on the first line, three strings of regular text on each of the next three lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileSquarePeekImageAndText01.png" alt="TileSquarePeekImageAndText01 example" />

TileSquarePeekImageAndText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150PeekImageAndText01.

Top/Front: Square image, no text. Bottom/Back: One header string in larger text on the first line, over one string of regular text wrapped over a maximum of three lines. <img src="./windows.ui.notifications/images/TileSquarePeekImageAndText02.png" alt="TileSquarePeekImageAndText02 example" />

TileSquarePeekImageAndText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150PeekImageAndText02.

Top/Front: Square image, no text. Bottom/Back: Four strings of regular text on four lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileSquarePeekImageAndText03.png" alt="TileSquarePeekImageAndText03 example" />

TileSquarePeekImageAndText03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150PeekImageAndText03.

Top/Front: Square image, no text. Bottom/Back: One string of regular text wrapped over a maximum of four lines. <img src="./windows.ui.notifications/images/TileSquarePeekImageAndText04.png" alt="TileSquarePeekImageAndText04 example" />

TileSquarePeekImageAndText04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150PeekImageAndText04.

One header string in larger text on the first line; three strings of regular text on each of the next three lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileSquareText01.png" alt="TileSquareText01 example" />

TileSquareText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Text01.

One header string in larger text on the first line, over one string of regular text wrapped over a maximum of three lines. <img src="./windows.ui.notifications/images/TileSquareText02.png" alt="TileSquareText02 example" />

TileSquareText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Text02.

Four strings of regular text on four lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileSquareText03.png" alt="TileSquareText03 example" />

TileSquareText03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Text03.

One string of regular text wrapped over a maximum of four lines. <img src="./windows.ui.notifications/images/TileSquareText04.png" alt="TileSquareText04 example" />

TileSquareText04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileSquare150x150Text04.

One rectangular image that fills the entire tile, no text.

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideBlockAndText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideBlockAndText02**

** only**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideImage**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideImageAndText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideImageAndText02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideImageCollection**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage04**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage05**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImage06**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageAndText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageAndText02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection04**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection05**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWidePeekImageCollection06**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideSmallImageAndText01**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideSmallImageAndText02**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideSmallImageAndText03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideSmallImageAndText04**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideSmallImageAndText05**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideText01**

**Windows only; not supported on **

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideText03**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideText04**

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideText05**

**Windows only; not supported on **

**Windows only; not supported on **

**Windows only; not supported on **

Windows 8 (Version 1) name/Windows 8.1 fallback attribute value: **TileWideText09**

**Windows only; not supported on **

**Windows only; not supported on **

Four strings of regular, unwrapped text on the left; large block text (this should be numerical) over a single, short string of regular text on the right.

TileWideBlockAndText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150BlockAndText01.

One string of regular text wrapped over a maximum of four lines on the left; large block text (this should be numerical) over a single, short string of regular text on the right. <img src="./windows.ui.notifications/images/TileWideBlockAndText02.png" alt="TileWideBlockAndText02 example" />

TileWideBlockAndText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150BlockAndText02.

One wide image that fills the entire tile, no text. <img src="./windows.ui.notifications/images/TileWideImage.png" alt="TileWideImage example" />

TileWideImage may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Image.

One wide image over one string of regular text wrapped over a maximum of two lines (one line on Windows Phone 8.1). The width of the text area depends on whether a logo is displayed.

TileWideImageAndText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150ImageAndText01.

****: One wide image over two strings of regular text on two lines. Text does not wrap. The width of the text area depends on whether a logo is displayed.

TileWideImageAndText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150ImageAndText02.

****: One large square image with four smaller square images to its right, no text.

TileWideImageCollection may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150ImageCollection.

Top/Front: One wide image. Bottom/Back: One header string in larger text over one string of regular text that wraps over a maximum of four lines. <img src="./windows.ui.notifications/images/TileWidePeekImage01.png" alt="TileWidePeekImage01 example" />

TileWidePeekImage01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage01.

Top/Front: One wide image. Bottom/Back: One header string in larger text on the first line, four strings of regular text on the next four lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileWidePeekImage02.png" alt="TileWidePeekImage02 example" />

TileWidePeekImage02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage02.

Top/Front: One wide image. Bottom/Back: One string of large text wrapped over a maximum of three lines. <img src="./windows.ui.notifications/images/TileWidePeekImage03.png" alt="TileWidePeekImage03 example" />

TileWidePeekImage03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage03.

Top/Front: One wide image. Bottom/Back: One string of regular text wrapped over a maximum of five lines. <img src="./windows.ui.notifications/images/TileWidePeekImage04.png" alt="TileWidePeekImage04 example" />

TileWidePeekImage04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage04.

Top/Front: One wide image.

TileWidePeekImage05 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage05.

Top/Front: One wide image.

TileWidePeekImage06 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImage06.

****: Top: One wide image, with a shorter height than a full-bleed wide image.

TileWidePeekImageAndText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageAndText01.

Top/Front: One wide image, with a shorter height than a full-bleed wide image. Bottom/Back: Five strings of regular text on five lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileWidePeekImageAndText02.jpg" alt="TileWidePeekImageAndText02 example" />

TileWidePeekImageAndText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageAndText02.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection01.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection02.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection03.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection04.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection05 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection05.

****: Top: One large square image with four smaller square images to its right, no text.

TileWidePeekImageCollection06 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150PeekImageCollection06.

On the left, one small image; on the right, one string of large text wrapped over a maximum of three lines.

TileWideSmallImageAndText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150SmallImageAndText01.

On the left, one small image; on the right, one header string in larger text on the first line, four strings of regular text on the next four lines. Text does not wrap.

TileWideSmallImageAndText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150SmallImageAndText02.

On the left, one small image; on the right, one string of regular text wrapped over a maximum of five lines.

TileWideSmallImageAndText03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150SmallImageAndText03.

On the left, one small image; on the right, one header string of larger text on the first line over one string of regular text wrapped over a maximum of four lines.

TileWideSmallImageAndText04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150SmallImageAndText04.

On the left, one header string in larger text over one string of regular text wrapped over a maximum of four lines; on the right, one small image with 3:4 dimensions.

TileWideSmallImageAndText05 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150SmallImageAndText05.

One header string in larger text on the first line, four strings of regular text on the next four lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileWideText01.png" alt="TileWideText01 example" />

TileWideText01 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text01.

One header string in larger text over eight short strings arranged in two columns of four lines each. Columns are of equal width. This template is similar to TileWideText07 and TileWideText10, but those templates use columns of unequal width. <img src="./windows.ui.notifications/images/TileWideText02.png" alt="TileWideText02 example" />

TileWideText02 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text02.

One string of large text wrapped over a maximum of three lines. <img src="./windows.ui.notifications/images/TileWideText03.png" alt="TileWideText03 example" />

TileWideText03 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text03.

One string of regular text wrapped over a maximum of five lines. <img src="./windows.ui.notifications/images/TileWideText04.png" alt="TileWideText04 example" />

TileWideText04 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text04.

Five strings of regular text on five lines. Text does not wrap. <img src="./windows.ui.notifications/images/TileWideText05.png" alt="TileWideText05 example" />

TileWideText05 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text05.

Ten short strings of regular text, arranged in two columns of five lines each. Columns are of equal width. This template is similar to TileWideText08 and TileWideText11, but those templates use columns of unequal width. <img src="./windows.ui.notifications/images/TileWideText06.png" alt="TileWideText06 example" />

TileWideText06 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text06.

One header string in larger text over eight short strings of regular text arranged in two columns of four lines each. The column widths are such that the first column acts as a label and the second column as the content. This template is similar to TileWideText10, which has an even narrower first column, and TileWideText02, which has columns of equal width. <img src="./windows.ui.notifications/images/TileWideText07.png" alt="TileWideText07 example" />

TileWideText07 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text07.

Ten short strings of regular text arranged in two columns of five lines each. The column widths are such that the first column acts as a label and the second column as the content. This template is similar to TileWideText11, which has an even narrower first column, and TileWideText06, which has columns of equal width. <img src="./windows.ui.notifications/images/TileWideText08.png" alt="TileWideText08 example" />

TileWideText08 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text08.

One header string in larger text over one string of regular text wrapped over a maximum of four lines. <img src="./windows.ui.notifications/images/TileWideText09.png" alt="TileWideText09 example" />

TileWideText09 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text09.

One header string in larger text over eight short strings of regular text arranged in two columns of four lines each. The column widths are such that the first column acts as a label and the second column as the content. This template is similar to TileWideText07, which has a wider first column, and TileWideText02, which has columns of equal width. <img src="./windows.ui.notifications/images/TileWideText10.png" alt="TileWideText10 example" />

TileWideText10 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text10.

Ten short strings of regular text arranged in two columns of five lines each. The column widths are such that the first column acts as a label and the second column as the content. This template is similar to TileWideText08, which has a wider first column, and TileWideText06, which has columns of equal width. <img src="./windows.ui.notifications/images/TileWideText11.png" alt="TileWideText11 example" />

TileWideText11 may be altered or unavailable for releases after Windows 8.1. Instead, use TileWide310x150Text11.

Creates TileUpdater objects used to change and update **Start** menu tiles. This class also provides access to the XML content of the system-provided tile templates so that you can customize that content for use in updating your tiles.

Creates and initializes a new instance of the TileUpdater, which lets you change the appearance of the calling app's tile.

The object you will use to send changes to the app's tile.

Creates and initializes a new instance of the TileUpdater for a tile that belongs to another app in the same package as the calling app. The TileUpdater lets a developer change the appearance of that tile.

The package-relative application identifier (PRAID) of the tile. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. The object you will use to send changes to the tile identified by *applicationId*.

Creates and initializes a new instance of the TileUpdater, which enables you to change the appearance of a secondary tile. The tile can belong to the calling app or any other app in the same package.

A unique ID for the tile. The object you will use to send updates to the tile identified by *tileID*.

Creates and initializes a new TileUpdateManagerForUser for the specified user, which lets you change the appearance or content of a tile for a specific user.

The user who will receive the tile updates. An object that will update tiles for the specified user.

Gets the XML content of one of the predefined tile templates so that you can customize it for a tile update.

The name of the template. The object that contains the XML.

Creates TileUpdater objects used to change and update **Start** menu tiles for a specific user. This class also provides access to the XML content of the system-provided tile templates so that you can customize that content for use in updating your tiles.

Gets the user that receives the toast notifications created by this object.

The user that receives the toast notifications created by this object.

Creates a new TileUpdater for a tile for the bound user. The tile can belong to the calling app or any other app in the same package. The TileUpdater lets a developer change the appearance of that tile.

The package-relative application identifier (PRAID) of the tile. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. The object you will use to send changes to the tile identified by *applicationId*.

Creates and initializes a new instance of the TileUpdater, which lets you change the appearance of the calling app's tile for the bound user.

The object you will use to send changes to the app's tile for the current user.

Creates a new TileUpdater, which enables you to change the appearance of a secondary tile for the bound user. The tile can belong to the calling app or any other app in the same package.

A unique ID for the tile. The object you will use to send updates to the tile identified by *tileID*.

Changes the content of the specific tile that the updater is bound to.

Gets a value that specifies whether a tile can be updated through notifications.

A value that indicates either that the tile can be updated through notifications, or who disabled them: developer, user, or administrator.

Adds a ScheduledTileNotification to the schedule.

The scheduled tile update object.

Removes all updates and causes the tile to display its default content as declared in the app's manifest.

Enables the tile to queue up to five notifications. This enables the notification queue on all tile sizes.

**True** to enable queuing; otherwise **false**.

Enables the tile to queue up to five notifications on the medium tile.

**True** to enable queuing on this tile size; otherwise **false**.

Enables the tile to queue up to five notifications on the large tile.

**True** to enable queuing on this tile size; otherwise **false**.

Enables the tile to queue up to five notifications on the wide tile.

**True** to enable queuing on this tile size; otherwise **false**.

Retrieves a list of scheduled updates to the tile.

The collection of scheduled updates for this tile.

Removes an upcoming tile update from the schedule.

The notification to remove from the schedule.

Begins a series of timed updates for the tile that the updater is bound to. Update content is retrieved from a specified Uniform Resource Identifier (URI). Updates begin at a specified time.

The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. The time at which the Uniform Resource Identifier (URI) should first be polled for new tile content. The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*.

Begins a series of timed content changes for the tile that the updater is bound to, beginning immediately.

The Uniform Resource Identifier (URI) from which the XML content of the tile update will be retrieved. The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*.

Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI) with updates beginning at a specified time and subsequent updates occurring at the periodic interval thereafter.

An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. The time at which the initial Uniform Resource Identifier (URI) should first be polled for new content. The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*.

Begins a series of timed updates that cycle on the tile that the updater is bound to. Update content is retrieved from an array of specified Uniform Resource Identifier (URI), the first update happening immediately and subsequent updates occurring at the periodic interval thereafter.

An array of up to five Uniform Resource Identifier (URI) from which the XML content of the cycling tile updates will be retrieved. If the array contains more than five Uniform Resource Identifier (URI), the method will fail. The frequency with which the Uniform Resource Identifier (URI) is polled for new tile content, following the initial update at *startTime*.

Cancels the current series of timed updates for the tile that the updater is bound to.

Applies a change in content or appearance to the tile.

The object that supplies the new XML definition for the tile's content.

Exposes a method that retrieves the arguments associated with a toast action initiated by the user. This lets the app tell which action was taken when multiple actions were exposed.

Gets the arguments associated with a toast action initiated by the user. This arguments string was included in the toast's XML payload.

The arguments string associated with the particular action.

Represents a group of notifications for a particular app.

Creates a new toast notification group.

The ID of the group. You can use the ID to manipulate the group with a ToastCollectionManager The title of group to display in the Action Center. The launch arguments that are passed to the app when the user clicks the notification group title in the Action Center. The icon to display next to the title in the Action Center.

Gets or sets the group title that displays in the Action Center.

The group title that displays in the Action Center.

Gets or sets the icon that displays next to the group title in the Action Center.

The icon that displays next to the group title in the Action Center.

Gets the ID of this notification group.

Gets or sets the launch arguments provided to app when the notification group title is clicked in the Action Center.

The launch arguments provided to app when the notification group title is clicked in the Action Center.

Provides methods for creating, retrieving, updating, and removing toast collections.

Gets the ID of the app to which this manager belongs.

The ID of the app to which this manager is bound.

Gets the user who receives the toast notification groups created by this toast collection manager.

The user who receives the toast notification groups.

Starts the retrieval of all toast notification groups created by this manager.

An object that represents the asynchronous operation.

Starts the retrieval of the specified notification group.

The ID of the notification group to retrieve. An object that represents the asynchronous operation.

Starts the asynchronous removal of all toast notification groups for the app.

An object that represents the asynchronous operation.

Starts the asynchronous removal of the specified toast notification group.

The ID of toast notification group to remove. An object that represents the asynchronous operation.

Starts the asynchronous creation or update of the specified toast notification group.

The toast notification group to create or update. An object that represents the asynchronous operation.

Specifies the reason that a toast notification is no longer being shown. Used with ToastDismissedEventArgs.Reason.

The app explicitly hid the toast notification by calling the ToastNotifier.hide method.

The toast notification had been shown for the maximum allowed time and was faded out. The maximum time to show a toast notification is 7 seconds except in the case of long-duration toasts, in which case it is 25 seconds.

The user dismissed the toast notification.

Provides the reason that a toast notification is no longer displayed on-screen.

Gets the reason that a toast notification is no longer displayed on-screen.

One of the enumeration values that specify why a toast is no longer being shown.

Provides the error code that was generated in the process of raising a toast notification.

Gets the error code that was generated in the process of raising a toast notification.

One of the standard system error codes.

Specifies the kind of change that has happened to a notification in toast history. Used with ToastNotificationHistoryChangedTriggerDetail.ChangeType.

The notification was added.

One or more notifications were removed with a clear command.

The notification has expired.

Just this notification was removed with a remove command.

Defines the content, associated metadata and events, and expiration time of a toast notification.

Creates and initializes a new instance of the ToastNotification.

The XML content that defines the toast notification.

Gets the XML that defines the current toast notification.

The object that contains the XML.

Gets or sets additional information about the status of the toast notification.

An object that provides additional information about the status of the toast notification, such as the progress of the action described by the notification.

Gets or sets the time after which a toast notification should not be displayed.

The date and time after which the toast is no longer considered current or valid and should not be displayed.

Gets or sets the group identifier for the notification.

The group identifier for the notification.

Gets or sets a value that specifies whether notification mirroring is allowed.

A value that specifies whether notification mirroring is allowed.

Gets or sets the priority of the toast notification.

The priority of the toast notification.

Gets or sets a remote id for the notification that enables the system to correlate this notification with another one generated on another device.

A remote id for the notification that enables the system to correlate this notification with another one generated on another device.

Gets or sets whether a toast's pop-up UI is displayed on the user's screen.

Set to **true** to suppress the popup message; otherwise, false. The default value is false, meaning the toast's pop-up message will be shown. Setting this property to **true** places the toast notification silently into the action center. This enables your app to communicate with the user without interrupting them.

Gets or sets the unique identifier of this notification within the notification Group.

Gets or sets the unique identifier of this notification within the notification Group.

Occurs when user activates a toast notification through a click or touch. Apps that are running subscribe to this event.

Occurs when a toast notification leaves the screen, either by expiring or being explicitly dismissed by the user. Apps that are running subscribe to this event.

Occurs when an error is caused when Windows attempts to raise a toast notification. Apps that are running subscribe to this event.

Represents the details of a toast action trigger.

Gets a value representing the argument that was passed.

The argument that was passed.

Gets a value indicating the user's action.

A value indicating the user's action.

Manages the toast notifications for an app including the ability the clear all toast history and removing individual toasts.

Removes all notifications sent by this app from action center.

Removes all notifications from action center that were sent by another app inside the same app package.

The ID of the app inside the app package whose notifications are to be deleted.

Gets notification history, for all notifications sent by this app, from action center.

A collection of toasts.

Gets notification history, for a toast with the specified tag label, from action center.

The tag label for the toast being queried-for. A collection of toasts.

Removes an individual toast, with the specified tag label, from action center.

The tag label of the toast notification to be removed.

Removes a toast notification from the action using the notification's tag and group labels.

The tag label of the toast notification to be removed. The group label of the toast notification to be removed.

Removes an individual toast notification from action center, identified by the combination of tag label, group label and app ID.

The tag label of the toast notification to be removed. The group label of the toast notification to be removed. The app ID of the app that sent the specified toast notification. This app must be part of the same app package as the app making this remove request.

Removes a group of toast notifications, identified by the specified group label, from action center.

The group label of the toast notifications to be removed.

Removes a group of toast notifications sent by the another app inside the same app package from action center using the group label.

The group label of the toast notifications to be removed. The app ID of the app within the same app package of the calling app.

Represents the details of a toast history changed trigger.

Gets a value representing the kind of change that caused the toast history changed trigger.

The kind of change that has happened to a notification in toast history.

Gets the ID of the notification group to which the notification that caused the change trigger belongs.

The ID of the notification group to which the notification that caused the change trigger belongs.

Creates ToastNotifier objects that you use to raise toast notifications. This class also provides access to the XML content of the system-provided toast templates so that you can customize that content for use in your notifications.

Gets the ToastNotificationHistory object.

The ToastNotificationHistory object.

Specifies whether notification mirroring is allowed. Notification mirroring enables a notification to be broadcast on multiple devices.

One of the enumeration values.

Creates and initializes a new instance of the ToastNotification, bound to the calling application, that lets you raise a toast notification to that app.

The object you will use to send the toast notification to the app.

Creates and initializes a new instance of the ToastNotification, bound to a specified app, usually another app in the same package.

The unique ID of the app. The object you will use to send the toast notification to the tile.

Gets a toast notification manager for the current user.

A toast notification manager for the current user.

Gets a toast notification manager for the specified user.

The user who will receive the toast notifications. A object for creating toast notifications for the specified user.

Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification.

One of the system-provided toast templates. The object that contains the template XML.

Creates ToastNotifier objects that you use to raise toast notifications for the bound user. This class also provides access to the XML content of the system-provided toast templates so that you can customize that content for use in your notifications.

Gets the ToastNotificationHistory object.

The ToastNotificationHistory object.

Gets the user that receives the toast notifications created by this object.

The user that receives the toast notifications created by this object.

Creates a new ToastNotifier for the calling application and the bound user that lets you raise a toast notification.

The object you will use to send the toast notification to the app for the bound user.

Creates a new ToastNotification for the bound user and the specified app, usually another app in the same package.

The unique ID of the app. The object you will use to send the toast notification to the tile.

Starts the retrieval of notification history for the specified notification group.

The ID of the notification group whose history you want to retrieve. An object that represents the asynchronous operation.

Creates a ToastCollectionManager that you can use to save, update, and clear notification groups for the current app.

An object you can use to save, update, and clear notification groups.

Creates a ToastCollectionManager that you can use to save, update, and clear notification groups for the specified app.

The ID of the app whose notification groups you want to manipulate. An object you can use to save, update, and clear notification groups.

Creates a new ToastNotification for the bound user and app for the specified notification group.

The ID of the ToastNotificationCollection that represents the notification group you want to send. The object you will use to send the toast notifications.

Specifies the priority of a ToastNotification.

The notification should have default behavior in terms of delivery and display priority during connected standby mode.

The notification should be treated as high priority. For desktop PCs, this means during connected standby mode the incoming notification can turn on the screen for Surface-like devices if it doesn’t have a closed lid detected.

Raises a toast notification to the specific app to which the ToastNotifier is bound. This class also lets you schedule and remove toast notifications.

Gets a value that tells you whether there is an app, user, or system block that prevents the display of a toast notification.

**Enabled** if the toast can be shown; otherwise, one or more reasons that the toast will be blocked.

Occurs when the system shows the scheduled toast notification.

Adds a ScheduledToastNotification for later display by Windows.

The scheduled toast notification, which includes its content and timing instructions.

Gets the collection of ScheduledToastNotification objects that this app has scheduled for display.

The collection of scheduled toast notifications that the app bound to this notifier has scheduled for timed display.

Removes the specified toast notification from the screen.

The object that specifies the toast to hide.

Cancels the scheduled display of a specified ScheduledToastNotification.

The notification to remove from the schedule.

Displays the specified toast notification.

The object that contains the content of the toast notification to display.

Updates the existing toast notification that has the specified tag.

An object that contains the updated info. The identifier of the toast notification to update. A value that indicates the result of the update (failure, success, etc).

Updates the existing toast notification that has the specified tag and belongs to the specified notification group.

An object that contains the updated info. The identifier of the toast notification to update. The ID of the ToastCollection that contains the notification. A value that indicates the result of the update (failure, success, etc).

Specifies the template to use in a toast notification.

A large image and a single string wrapped across three lines of text. <img src="./windows.ui.notifications/images/toast_6.png" alt="ToastImageAndText01 example" />

A large image, one string of bold text on the first line, one string of regular text wrapped across the second and third lines. <img src="./windows.ui.notifications/images/toast_7.png" alt="ToastImageAndText02 example" />

A large image, one string of bold text wrapped across the first two lines, one string of regular text on the third line. <img src="./windows.ui.notifications/images/toast_8.png" alt="ToastImageAndText03 example" />

A large image, one string of bold text on the first line, one string of regular text on the second line, one string of regular text on the third line. <img src="./windows.ui.notifications/images/ToastImageAndText04.png" alt="ToastImageAndText04 example" />

A single string wrapped across three lines of text. <img src="./windows.ui.notifications/images/toast_1.png" alt="ToastText01 example" />

One string of bold text on the first line, one string of regular text wrapped across the second and third lines. <img src="./windows.ui.notifications/images/toast_2.png" alt="ToastText02 example" />

One string of bold text wrapped across the first and second lines, one string of regular text on the third line. <img src="./windows.ui.notifications/images/toast_4.png" alt="ToastText03 example" />

One string of bold text on the first line, one string of regular text on the second line, one string of regular text on the third line. <img src="./windows.ui.notifications/images/toast_5.png" alt="ToastText04 example" />

Represents a notification for a specific user.

Gets info about the app that owns the notification.

The app that owns the notification.

Gets the time at which the notification was created.

The time at which the notification was created.

Gets the ID of the notification.

The ID of the notification.

Gets the notification content.

The notification content.

Provides info when a user notification changes.

Gets the type of change this triggered the event.

The type of change that triggered the event.

Gets the ID of the user notification that changed.

The ID of the user notification that changed.

Specifies the type of user notification change that occurred.

The user notification was added.

The user notification was removed.

Reads and manages a user's notifications.

Gets a UserNotificationListener for the current user.

A UserNotificationListener for the current user.

Occurs when a notification is added or removed.

Clears the notification.

Gets a value that indicates whether the UserNotificationListener has access to the user's notifications.

A value that indicates whether the UserNotificationListener has access to the user's notifications.

Retrieves the specified notification.

The ID of the notification to retrieve. The notification if it exists; otherwise, **null**.

Asynchronously retrieves notifications that match the specified notification kind.

The type of notification to retrieve. A collection of notifications of the specified type.

Removes the specified notification.

The ID of the notification to remove.

Requests the user's permission to manage notifications.

A value that specifies whether the user chose to provide access to notification.

Specifies whether the user has given the UserNotificationListener access to notifications.

The user granted access to the UserNotificationListener.

The user denied access to the UserNotificationListener.

The user has not yet allowed or denied access.

Represents a command in a context menu or message dialog box.

Gets or sets the identifier of the command.

Represents the identifier of the command.

Gets or sets the handler for the event that is fired when the user invokes the command.

The event handler for the command.

Gets or sets the label for the command.

The label for the command.

Represents a dialog for showing messages to the user.

Initializes a new instance of the MessageDialog class to display an untitled message dialog that can be used to ask your user simple questions.

The message displayed to the user.

Initializes a new instance of the MessageDialog class to display a titled message dialog that can be used to ask your user simple questions.

The message displayed to the user. The title you want displayed on the dialog.

Gets or sets the index of the command you want to use as the cancel command. This is the command that fires when users press the ESC key.

The index of the cancel command.

Gets an array of commands that appear in the command bar of the message dialog. These commands makes the dialog actionable.

The commands.

Gets or sets the message to be displayed to the user.

The message to be displayed to the user.

Gets or sets the index of the command you want to use as the default. This is the command that fires by default when users press the ENTER key.

The index of the default command.

Gets or sets the options for a MessageDialog.

The options for the dialog.

Gets or sets the title to display on the dialog, if any.

The title to display on the dialog; or, an empty string if no title is set.

Begins an asynchronous operation showing a dialog.

An object that represents the asynchronous operation. For more on the async pattern, see Asynchronous programming.

Specifies less frequently used options for a MessageDialog.

Ignore user input for a short period. This enables browsers to defend against clickjacking.

No options are specified and default behavior is used.

Specifies where the context menu should be positioned relative to the selection rectangle.

Place the context menu above the selection rectangle.

Place the context menu below the selection rectangle.

Place the context menu above the selection rectangle.

Place the context menu to the left of the selection rectangle.

Place the context menu to the right of the selection rectangle.

Represents a context menu.

Creates a new instance of the PopupMenu class.

Gets the commands for the context menu.

The commands for the context menu.

Shows the context menu at the specified client coordinates.

The coordinates (in DIPs), relative to the window, of the user's finger or mouse pointer when the [oncontextmenu](https://docs.microsoft.com/previous-versions/windows/internet-explorer/ie-developer/platform-apis/aa704010(v=vs.85)) event fired. The menu is placed above and centered on this point. A IUICommand object that represents the context menu command that was invoked by the user, after the ShowAsync call completes.

Shows the context menu above the specified selection.

The coordinates (in DIPs) of the selected rectangle, relative to the window. The context menu is placed directly above and centered on this rectangle such that selection is not covered. A IUICommand object that represents the context menu command invoked by the user, after the ShowForSelectionAsync call completes.

Shows the context menu in the preferred placement relative to the specified selection.

The coordinates (in DIPs) of the selected rectangle, relative to the window. The preferred placement of the context menu relative to the selection rectangle. A IUICommand object that represents the context menu command invoked by the user, after the ShowForSelectionAsync call completes.

Represents a command in a context menu.

Creates a new instance of the UICommand class.

Creates a new instance of the UICommand class using the specified label.

The label for the UICommand.

Creates a new instance of the UICommand class using the specified label and event handler.

The label for the new command. The event handler for the new command.

Creates a new instance of the UICommand class using the specified label, event handler, and command identifier.

The label for the new command. The event handler for the new command. The command identifier for the new command.

Gets or sets the identifier of the command.

Represents the identifier of the command.

Gets or sets the handler for the event that is fired when the user selects the UICommand.

The event handler associated with the UICommand.

Gets or sets the label for the command.

The label for the command.

Represents a callback function that handles the event that is fired when the user invokes a context menu command.

Represents the invoked command.

Represents a command separator in a context menu.

Creates a new instance of the UICommandSeparator class.

Gets or sets the identifier of the command separator.

The identifier of the command separator.

Gets or sets the handler for the event that is fired for the command separator.

The event handler for the command separator.

Gets or sets the label for the command separator.

The label for the command separator.

Builds Adaptive Cards that can be used in Windows.

Creates a new instance of IAdaptiveCard using the specified Adaptive Card JSON. For more information, see Get Started with Adaptive Cards.

A String representation of the JSON that describes the Adaptive Card to create. An IAdaptiveCard object that represents the described Adaptive Card.

An Adaptive Card that can be used in Windows.

Returns the JSON that represents this Adaptive Card.

A String that contains the JSON representation of the Adaptive Card.

Provides access to methods that build Adaptive Cards for use on Windows.

Creates a new instance of IAdaptiveCard using the specified Adaptive Card JSON. For more information, see Get Started with Adaptive Cards.

A String representation of the JSON that describes the Adaptive Card to create. An IAdapativeCard object that represents the described Adaptive Card.

Provides methods for pinning applications to the taskbar.

Gets whether pinning to the taskbar is allowed.

A boolean indicating whether pinning to the taskbar is allowed.

Gets whether the taskbar is present on the current device.

A boolean indicating if the taskbar is present. This will return false on devices where no taskbar is present.

Returns the TaskbarManager object active in the current process.

The active TaskbarManager object.

Checks if the specified application is already pinned to the taskbar.

An AppListEntry corresponding to the application to check. A boolean representing whether the specified application is pinned to the taskbar.

Checks if the currently active application is already pinned to the taskbar.

A boolean representing whether the current application is pinned to the taskbar.

Checks if the specified secondary tile is pinned to taskbar. Requires user approval as described here

The TileId of the SecondaryTile that you want to check is pinned. A boolean representing whether the specified secondary tile is pinned to taskbar.

Requests that the specified application be pinned to the taskbar.

An AppListEntry corresponding to the application to pin to the taskbar. A boolean representing whether the application was successfully pinned to the takbar. If the app was already pinned, this will immediately return true.

Requests that the currently active application be pinned to the taskbar.

A boolean representing whether the application was successfully pinned to the takbar. If the app was already pinned, this will immediately return true.

Requests to pin the specified tile to taskbar. Requires user approval as described here.

The secondary tile to be pinned. A boolean representing whether the tile is pinned to the takbar. If the tile was already pinned, this will update the tile and return true. If pinning wasn't allowed or taskbar isn't supported, this will return false.

Tries to unpin the secondary tile from taskbar. Requires user approval as described here

The TileId of the SecondaryTile you want to unpin. A boolean representing whether the tile is not pinned to taskbar. If unpinning wasn't allowed, this returns false.

Specifies the color of the tile's foreground text.

A Windows-specified default dark text color.

A Windows-specified default light text color.

Provides functionality for an app's jump list. A jump list is a system-provided menu that appears when the user right-clicks a program in the taskbar or on the Start menu. It is used to provide quick access to recently or frequently-used documents and offer direct links to app functionality. Not all device families support jump lists.

Gets the list of JumpListItem 's for the jump list.Items is of type IVector(JumpListItem).

The list of JumpListItem 's for the jump list.

Gets or sets the current type of the system managed jump list group.

The JumpListItemKind enumeration value of the jump list.

Gets a value that indicates whether the system supports jump lists.

A boolean value that is True if jump lists are supported. Otherwise, False.

Asynchronously retrieves the current jump list and its items.

When this method completes successfully, it returns the current JumpList. If the system does not support jump lists, this method returns an empty jump list and the SaveAsync method has no effect. Apps can check for this case using the isSupported method.

Asynchronously saves changes to the jump list and its items.

Returns an IAsyncAction object that is used to control the asynchronous operation. If the system does not support jump lists, the SaveAsync method has no effect and future calls to LoadCurrentAsync will produce an empty jump list. An app can check for this case using the IsSupported method.

Provides functionality for creating and defining jump list items for an app's jump list.

Gets the command line arguments for the jump list item.

The jump list item command line arguments.

Gets or sets the jump list item task description.

The jump list item task description specified as a string. If localization is desired, this string must be a *ms-resource:* scheme specified URI.

Gets or sets the jump list item display name. The display name can also be specified as a parameter using the CreateWithArguments method when the jump list item is created.

The display name of the jump list item in the app's jump list. If localization is desired, this string must be a*ms-resource:* scheme specified URI.

Gets or sets the jump list item custom group name. If no name is specified, the item will be added to the Tasks group by default.

The custom group name for the jump list item specified as a string. If localization is desired, this string must be a *ms-resource:* scheme specified URI.

Gets the JumpListItemKind of a jump list item.

The JumpListItemKind enumeration indicating the kind of item represented by a jump list item.

Gets or sets the jump list item's logo.

The Uri for the jump list item logo. This can be specified using one of these schemes:<termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets a boolean indicating whether the jump list item was removed from the app's jump list by the user.

True when a user manually removed a jump list item from the app's jump list, otherwise False.

Creates a jump list item that is an inert separator for a custom group within the app's jump list.

A jump list item that can be added to an app's jump list through the items property.

Creates a new jump list item for an app's jump list.

String that specifies any command line arguments that should be passed onto the app when the jump list item is selected by a user. String that specifies a display name for the jump list item. If localization is desired, this string must be a *ms-resource:* scheme specified URI. A jump list item with the specified parameters that can be added to an app's jump list through the items property.

Specifies the kind of jump list item.

Indicates a jump list item that includes arguments.

Indicates a jump list item that is an inert separator within a custom jump list item group.

Indicates the kind of system group used by an app's jump list.

Specifies that the system managed frequent group be used in the jump list.

Specifies that no system managed group be used in the jump list.

Specifies that the system managed recent group be used in the jump list.

Creates, enumerates, and provides information about a secondary tile.

Creates a SecondaryTile object. The caller must then set any mandatory properties through the object before attempting to pin, update, or delete the tile.

Creates a SecondaryTile object with a specific ID. This form of the constructor should be used to create a secondary tile object to perform a tile update or deletion.

A string that will uniquely identify the tile within your app. Choose a unique ID that is descriptive and meaningful to your app. If you provide the same ID as that of an existing secondary tile, the existing secondary tile will be overwritten.

Creates a SecondaryTile object as a medium tile.

SecondaryTile(string, string, string, string, Windows.UI.StartScreen.TileOptions, Windows.Foundation.Uri) may be altered or unavailable for releases after Windows Phone 8.1. Instead, use SecondaryTile(string, string, string, Windows.Foundation.Uri, Windows.UI.StartScreen.TileSize). A string that will uniquely identify the tile within your app's package. Choose a unique ID that is descriptive and meaningful to your app. It is limited to 64 characters and must begin with a number or letter and be composed of the characters a-z, A-Z, 0-9, period (.), or underscore (_). If you provide the same ID as that of an existing secondary tile, the existing secondary tile will be overwritten. Can be set or retrieved through the TileId property. A short name to display directly on the tile if the app chooses to do so. Anything over 40 characters will be truncated. The user has the option to change this value as part of the pinning process. Can be set or retrieved through the ShortName property. A name to be displayed on the tile, in the tile's tooltip, and when showing small tiles, such as on the **Apps** or search results screens. This string is equivalent to the display name given in the manifest for the main tile. It is restricted to 256 characters, but in practice should be kept short to avoid truncation. This value can be set or retrieved through the DisplayName property. An app-defined string meaningful to the calling application. This argument string is passed back to the app when the app is activated from the secondary tile. It will be truncated after 2048 characters. Can be set or retrieved through the Arguments property. A value that specifies various options such as whether the name will be displayed on the secondary tile. Can be set or retrieved through the TileOptions property. A reference to a square logo image stored at a Uniform Resource Identifier (URI). Can be set or retrieved through the Logo property. This value can be expressed using one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Creates a SecondaryTile object as a wide tile.

SecondaryTile(string, string, string, string, Windows.UI.StartScreen.TileOptions, Windows.Foundation.Uri, Windows.Foundation.Uri) may be altered or unavailable for releases after Windows Phone 8.1. Instead, use SecondaryTile(string, string, string, Windows.Foundation.Uri, Windows.UI.StartScreen.TileSize). A string that will uniquely identify the tile within your app's package. Choose a unique ID that is descriptive and meaningful to your app. It is limited to 64 characters and must begin with a number or letter and be composed of the characters a-z, A-Z, 0-9, period (.), or underscore (_). If you provide the same ID as that of an existing secondary tile, the existing secondary tile will be overwritten. Can be set or retrieved through the TileId property. A short name to display directly on the tile if the app chooses to do so. Anything over 40 characters will be truncated. The user has the option to change this value as part of the pinning process. Can be set or retrieved through the ShortName property. A name to be displayed on the tile, in the tile's tooltip, and when showing small tiles, such as on the **Apps** or search results screens. This string is equivalent to the display name given in the manifest for the main tile. It is restricted to 256 characters, but in practice should be kept short to avoid truncation. This value can be set or retrieved through the DisplayName property. An app-defined string meaningful to the calling application. This argument string is passed back to the app when the app is activated from the secondary tile. It will be truncated after 2048 characters. Can be set or retrieved through the Arguments property. A value that specifies various options such as whether the name will be displayed on the secondary tile. Can be set or retrieved through the TileOptions property. A reference to a medium logo image stored at a Uniform Resource Identifier (URI). Can be set or retrieved through the Square150x150Logo property. This value can be expressed using one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist> A reference to a wide logo image stored at a Uniform Resource Identifier (URI). Can be set or retrieved through the WideLogo property. This value can be expressed using one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Creates a SecondaryTile object that includes all of the mandatory properties required to create a medium tile.

A string that will uniquely identify the tile within your app's package. Choose a unique ID that is descriptive and meaningful to your app. It is limited to 64 characters and must begin with a number or letter and be composed of the characters a-z, A-Z, 0-9, period (.), or underscore (_). If you provide the same ID as that of an existing secondary tile, the existing secondary tile will be overwritten. Can be set or retrieved through the TileId property. A name to be displayed on the tile, in the tile's tooltip, and when showing small tiles, such as on the **Apps** or search results screens. This string is equivalent to the display name given in the manifest for the main tile. It is restricted to 256 characters, but in practice should be kept short to avoid truncation. This value can be set or retrieved through the DisplayName property. An app-defined string meaningful to the calling application. This argument string is passed back to the app when the app is activated from the secondary tile. It will be truncated after 2048 characters. Can be set or retrieved through the Arguments property. A reference to a medium logo image stored at a Uniform Resource Identifier (URI). Can be set or retrieved through the SecondaryTileVisualElements.Square150x150Logo property. This value can be expressed using one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. The size of tile to pin. This value must be **Default** (which provides Windows 8 behavior), **Square150x150**, or **Wide310x150**. Any other TileSize value causes an exception to be thrown during runtime.

Gets or sets an app-defined set of information that is passed from the secondary tile to the app on activation. This property is required when you create a tile.

The argument string, of 2048 or fewer characters. This contents of this string are understood by the app. Any string longer than 2048 characters will cause an exception to be thrown. This string is passed to the app through the LaunchActivatedEventArgs.Arguments property.

Gets or sets the tile's background color.

The background color.

Gets or sets a name that is associated with and displayed on the tile. This name is displayed on the tile in Start, in the tile's tooltip, next to the small tile representation in the **Apps** list, and in some Control Panel applications. This property is required when you create a tile. It is the equivalent of the display name declared in the manifest for the app's main tile.

The display name. This string is limited to 256 characters, but in reality should be kept short to avoid truncation.

Gets or sets whether the tile should use dark or light text.

One of the two values that specifies either the default dark or default light text.

Gets or sets the location of a badge logo image to represent the secondary tile on the lock screen. By supplying this image, you declare that the secondary tile is eligible to display a badge on the lock screen. If you also want the secondary tile to be eligible for the lock screen's detailed tile slot, you must also set the LockScreenDisplayBadgeAndTileText property to **True**.

A Uniform Resource Identifier (URI) that specifies the logo image file location.

Gets or sets whether the secondary tile is eligible to display both a badge and a detailed tile on the lock screen. If you set this property to **True**, you must also provide a badge image through the LockScreenBadgeLogo property. If you do not want to use the detailed tile capability, provide a badge image through the LockScreenBadgeLogo property and set LockScreenDisplayBadgeAndTileText to **False**.

**True** if the secondary tile can have a lock screen presence; otherwise, **False**.

Gets or sets the logo image used in a medium tile. This property is required when you create either a square or a wide tile.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets a phonetic version of the secondary tile name. Used with character-based languages for UI sorting purposes.

The phonetic name.

Gets or sets a value that determines whether the secondary tile will be reacquired through the cloud when the parent app is installed by the user, using their Microsoft account, on another computer. Note that as of Windows 8.1, roaming is the default behavior. This is the opposite of the default Windows 8 behavior, where roaming was opt-in.

Set to **true** if roaming is enabled; otherwise, **false**. The default is **true**.

Gets or sets a short name to display directly on the tile.

The short name. Anything over 40 characters will be truncated. The user has the option to change this value as part of the pinning process.

Gets or sets the small logo image, used in search results, the All Programs list, and other locations in the UI.

The location of the image. This must be expressed using this scheme: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef></termdeflist>

Gets or sets a unique string to identify the tile within the package. This property is required when you create or delete a tile.

A unique identifier, meaningful to your app. It is limited to 64 characters and must begin with a number or letter and be composed of the characters a-z, A-Z, 0-9, period (.), or underscore (_). It cannot contain spaces, commas, or any of these characters: | > < " / ? * \ ; : ! '

Gets or sets options available to a secondary tile.

One or more enumeration values. See TileOptions for the full list of valid values.

Gets an object through which you can get or set a secondary tile's background color, foreground text, tile images, and app name display options. As of Windows 8.1, the properties of this object replace these SecondaryTile properties:

An object that represents the secondary tile.

Gets or sets the logo image used in a wide secondary tile. This property is required when you create a wide secondary tile and gives the user the option of a wide tile when they resize the tile.

The location of the image. This can be expressed using one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Fired when a call is made to RequestCreateAsync.

Checks whether a specific secondary tile exists for the calling app.

The unique ID string that was assigned to the tile when it was created. **True** if the tile exists in the calling application; otherwise, **false**.

Retrieves a list of secondary tiles created for the calling app.

An enumeration object that allows you to examine the set of tiles.

Retrieves a list of secondary tiles created for another app in the same package as the calling app.

The package-relative application identifier (PRAID) of the app. The specified app must be in the same package as the calling app. For more info on the PRAID, see the **Id** attribute of the Application element. An enumeration object that allows you to examine the set of tiles.

Retrieves a list of secondary tiles created for all of the apps in the package of the calling app.

An enumeration object that allows you to examine the set of tiles.

Displays the **Pin to Start** flyout, through which the user can confirm that they want to create the secondary tile, which in turn creates the tile. Overloads of this method let you specify the on-screen location of the flyout.

An object used to launch the asynchronous create operation as well as to retrieve information about it.

Displays the **Pin to Start** flyout above a specified location, through which the user can confirm that they want to create the secondary tile, which in turn creates the tile.

The point used as the lower-right corner of the **Pin to Start** flyout. An object that provides information concerning the asynchronous create operation.

Displays the **Pin to Start** flyout above a specified area. This flyout is used by the user to confirm that they want to create the secondary tile, which in turn creates the tile.

The area that the flyout is displayed directly above. An object that provides information concerning the asynchronous create operation.

Displays the **Pin to Start** flyout at the specified side of a specified area. This flyout is used by the user to confirm that they want to create the secondary tile, which in turn creates the tile.

The area to one side of which the flyout will be displayed. The side of the rectangle where the flyout should appear. An object that provides information concerning the asynchronous create operation.

Displays the **Unpin from Start** flyout. This flyout lets the user confirm removal of the secondary tile.

An object that provides information concerning the asynchronous delete operation.

Displays the **Unpin from Start** flyout at a specified point. This flyout lets the user confirm removal of the secondary tile.

The point used as the lower-right corner of the **Pin to Start** flyout. An object that provides information concerning the asynchronous delete operation.

Displays the **Unpin from Start** flyout above a specified area. This flyout lets the user confirm removal of the secondary tile.

The area that the secondary tile is displayed directly above. An object that provides information concerning the asynchronous delete operation.

Displays the **Unpin from Start** flyout at the specified side of a specified area. This flyout lets the user confirm removal of the secondary tile.

The area to the side of which the flyout will be displayed. One of the enumeration values that specifies the side of the rectangle where the flyout should be shown. An object that provides information concerning the asynchronous delete operation.

Updates a secondary tile after that tile is pinned to the Start screen.

An object used to launch the asynchronous create operation as well as to retrieve information about it.

Contains properties through which you can get or set a secondary tile's background color, foreground text, tile images, and app name display options. The properties in this class replace these SecondaryTile properties:

Gets or sets the secondary tile's background color.

The background color. Specify in #ffffff format.

Specifies whether the tile should use dark or light text.

One of the two values that specifies either the default dark or default light text.

Gets an object representing a 3D model asset for use as an app launcher in the Windows Mixed Reality home environment.

The mixed reality model.

Specifies whether the display name should be shown on the medium secondary tile.

**True** to show the display name on the tile; otherwise, **false**. The default value is **false**.

Specifies whether the display name should be shown on the large secondary tile.

**True** to dhow the display name on the tile; otherwise, **false**. The default value is **false**.

Specifies whether the display name should be shown on the wide secondary tile.

**True** to show the display name on the tile; otherwise, **false**. The default value is **false**.

Gets or sets the medium secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the square30x30 secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the large secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the square44x44 secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the small secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the small secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Gets or sets the wide secondary tile image.

The location of the image. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Represents a Start screen manager object.

Gets the user associated with the current Start screen.

Checks if the app is currently pinned to the Start screen.

Checks if the specified secondary tile is pinned to Start.

The TileId of the SecondaryTile that you want to check is pinned. A boolean representing whether the specified secondary tile is pinned to Start.

Gets the current Start screen manager.

Gets the Start screen manager for a specific user.

Requests to pin the app to the current Start screen. Depending on the device family, this must be called on the UI thread, and will display a dialog asking the user to confirm they would like to pin the app.

Checks if the app can be pinned to the current Start screen.

Tries to remove the specified secondary tile from Start.

The TileId of the SecondaryTile you want to remove. A boolean representing whether the tile is not on Start. If removing wasn't allowed, this returns false.

Represents a 3D model asset for use as an app launcher in the Windows Mixed Reality home environment.

Gets or sets what the system does when the user selects this tile.

A value that specifies how the system behaviors when the user selects this tile. The default behavior is to launch the associated app.

Gets or sets the bounding box that defines the size of the model in the Windows Mixed Reality home in meters.

The bounding box. If this value is null, the system will determine the bounding box when it loads the model. The default value is null.

Gets or sets the path to the mixed reality model.

The location of the mixed reality model file within the app package or local storage. This can be expressed as one of these schemes: <termdeflist><termdef><name>ms-appx:///</name>A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.</termdef><termdef><name>ms-appdata:///local/</name>A file found in the per-user app storage.</termdef></termdeflist>

Specifies how the system reacts when the user interacts with a TileMixedRealityModel in the Windows Mixed Reality home environment.

When the user selects the tile model, the system launches the app.

When the user selects the tile model, the system does not launch the app.

Specifies options available to a secondary tile.

The tile will be reacquired from the cloud when the parent app is installed by the user, using their Microsoft account, on another computer.

TileOptions.CopyOnDeployment may be altered or unavailable for releases after Windows Phone 8.1. Instead, use SecondaryTile.RoamingEnabled to control roaming behavior.

Default. Do not show the name on a secondary tile of any size.

TileOptions.None may be altered or unavailable for release after Windows Phone 8.1.

Display the name on the medium version of the tile.

TileOptions.ShowNameOnLogo may be altered or unavailable for releases after Windows Phone 8.1. Instead, use SecondaryTile.VisualElements.ShowNameOnSquare150x150Logo.

Display the name on the wide version of the tile.

TileOptions.ShowNameWideOnLogo may be altered or unavailable for releases after Windows Phone 8.1. Instead, use SecondaryTile.VisualElements.ShowNameOnWide310x150Logo.

Specifies the size of tile to pin. Used by some secondary tile constructors.

Use the default size of the app tile.

The medium tile.

The small image size used in search results, the Apps list, and in some other parts of the UI.

TileSize.Square30x30 may be altered or unavailable for release after Windows 10.

The large tile.

The small image size used in search results, the Apps list, and in some other parts of the UI.

The small tile used on the Start screen.

TileSize.Square70x70 may be altered or unavailable for release after Windows Phone 8.1.

** only**: The small tile used on the Start screen. Note that you cannot specify the size of a pinned secondary tile on Windows Phone 8.1, so this value currently has no use.

The wide tile.

Provides a method to delay the display of the **Pin to Start** flyout, as well as methods through which you can set the visual elements of the secondary tile to be presented in that flyout as well as alternate versions of the tile that can also be presented as options.

Gets a set of objects that provide alternate logo images, background and foreground colors, and display name. These alternates are shown to the user in the **Pin to Start** flyout.

An array of SecondaryTileVisualElements objects, each of which provides the information for an alternate presentation of the secondary tile.

Gets the approximate time at which the deferral will time-out.

The time at which the deferral will time out.

Gets a copy of the parent secondary tile's SecondaryTileVisualElements object. The visual elements properties can be set or read through this object. When deferral is complete (or the handler returns without a deferral), the properties in this object are verified and then reflected in the **Pin to Start** flyout.

The object through which you'll access the visual element properties.

Retrieves a deferral object, which allows the app time to provide information and assets used in the **Pin to Start** flyout.

The deferral object.

A deferral object used during the creation of the **Pin to Start** flyout. By using this object, the app can delay the display of the flyout while it gathers the information and assets that will be shown in that flyout.

Tells Windows that the app is ready to display the **Pin to Start** flyout. The app calls this method when it has finished setting the properties that specify what to show in that flyout.

Passed to the SecondaryTile.VisualElementsRequested event handler to provide the visual elements details.

Gets the VisualElementsRequest object for the event.

The object associated with the event.

Specifies the caret type.

The insertion point for a sequenced language; that is, characters that are typed with one key stroke.

The insertion point is null.

Represents information about a ContentLink.

Initializes a new instance of the ContentLinkInfo class.

Gets or sets the text to display for the link.

The text to display for the link.

Gets or sets the identifier for the content link.

The identifier for the content link.

Gets or sets a value that indicates what kind of content the link contains.

A string that indicates what kind of content the link contains.

Gets or sets additional information about the ContentLink to display to the user.

Additional information about the ContentLink to display to the user. The default is an empty string.

Gets or sets the Uniform Resource Identifier (URI) of the app to launch when the link is activated.

The Uniform Resource Identifier (URI) of the app to launch when the link is activated. The default is **null**.

Specifies the options to use when doing a text search.

Match case; that is, a case-sensitive search.

Use the default text search options; namely, use case- independent, arbitrary character boundaries.

Match whole words.

Describes the degree to which a font has been stretched, compared to the normal aspect ratio of that font.

A condensed font stretch (75% of normal).

An expanded font stretch (125% of normal).

An extra-condensed font stretch (62.5% of normal).

An extra-expanded font stretch (150% of normal).

The normal font stretch that all other font stretch values relate to (100%).

A semi-condensed font stretch (87.5% of normal).

A semi-expanded font stretch (112.5% of normal).

An ultra-condensed font stretch (50% of normal).

An ultra-expanded font stretch (200% of normal).

No defined font stretch.

Represents the style of a font face (for example, normal or italic).

Represents an italic font style.

Represents a normal font style.

Represents an oblique font style.

Expresses the density of a typeface, in terms of the lightness or heaviness of the strokes.

The font weight expressed as a numeric value. See Remarks.

Provides a set of predefined font weights as static property values.

Specifies a font weight value of 900.

A FontWeight with a Weight value of 900.

Specifies a font weight value of 700.

A FontWeight with a Weight value of 700.

Specifies a font weight value of 950.

A FontWeight with a Weight value of 950.

Specifies a font weight value of 800.

A FontWeight with a Weight value of 800.

Specifies a font weight value of 200.

A FontWeight with a Weight value of 200.

Specifies a font weight value of 300.

A FontWeight with a Weight value of 300.

Specifies a font weight value of 500.

A FontWeight with a Weight value of 500.

Specifies a font weight value of 400.

A FontWeight with a Weight value of 400.

Specifies a font weight value of 600.

A FontWeight with a Weight value of 600.

Specifies a font weight value of 350.

A FontWeight with a Weight value of 350.

Specifies a font weight value of 100.

A FontWeight with a Weight value of 100.

Defines values that indicate the state of a character or paragraph formatting property.

Turns off the property.

Turns on the property.

Toggles the current setting.

No change.

Specifies the horizontal position of a character relative to a bounding rectangle.

The character is at the center of the bounding rectangle.

The character is at the left edge of the bounding rectangle.

The character is at the right edge of the bounding rectangle.

Defines the default character formatting attributes of a document, or the current character formatting attributes of a text range.

Gets or sets whether the characters are all uppercase.

The uppercase state.

Gets or sets the text background (highlight) color.

The text background color.

Gets or sets whether the characters are bold.

The bold state.

Gets or sets the degree to which the font is stretched, compared to the normal aspect ratio of the font.

The degree to which the font is stretched.

Gets or sets the style of the font face, such as normal or italic.

The font style.

Gets or sets the foreground, or text, color.

The foreground color.

Gets or sets whether characters are hidden.

The hidden state.

Gets or sets whether characters are in italics.

The italicized state.

Gets or sets the minimum font size at which kerning occurs.

The kerning size, in floating-point points.

Gets or sets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the characters.

The language tag.

Gets the link type of the text.

The link type.

Gets or sets the font name.

The font name.

Gets or sets whether characters are displayed as outlined characters.

The outlined state.

Gets or sets the character offset relative to the baseline.

The character offset, in floating-point points.

Gets or sets whether the characters are protected against attempts to modify them.

The protected state.

Gets or sets the font size.

The font size, in floating-point points.

Gets or sets whether characters are in small capital letters.

The small capitals state.

Gets or sets the amount of horizontal spacing between characters.

The amount of horizontal spacing, in floating-point points.

Gets or sets whether characters are displayed with a horizontal line through the center.

The strikethrough state.

Gets or sets whether characters are displayed as subscript.

The subscript state.

Gets or sets whether characters are displayed as superscript.

The superscript state.

Gets or sets the character repertoire.

The character repertoire.

Gets or sets the type of underlining that the characters use.

The type of underlining.

Gets or sets the font weight of the characters.

The font weight expressed as a numeric value. See Remarks.

Creates a new object that is identical to this character format object.

The duplicate character format object.

Determines whether this character format object has the same properties as the specified character format object.

The character format object to compare against. True if the objects have the same properties, or false if they don't.

Sets the character formatting by copying another text character formatting object.

The character formatting to apply.

Provides access to the content of a document, providing a way to load and save the document to a stream, retrieve text ranges, get the active selection, set default formatting attributes, and so on.

Gets or sets the caret type.

The caret type.

Gets or sets the default tab spacing.

The new default tab spacing. The default value is 36.0 points, or 0.5 inches.

Gets the active text selection.

The active text selection.

Gets or sets the maximum number of actions that can be stored in the undo queue.

The maximum number of undo actions.

Decrements an internal counter that controls whether text updates are displayed immediately or batched.

The value of the internal counter.

Increments an internal counter that controls whether text updates are displayed immediately or batched.

The value of the internal counter.

Turns on undo grouping.

Determines whether document content can be copied to the Clipboard.

True if copying to the Clipboard is allowed; otherwise false.

Determines whether the Clipboard has content that can be pasted into the document.

True if the Clipboard has content that can be pasted into the document; otherwise false.

Determines whether one or more redo operations exist.

True if one or more redo operations exist; otherwise false.

Determines whether one or more undo operations exist.

True if one or more undo operations exist; otherwise false.

Turns off undo grouping.

Retrieves the default character formatting attributes of the document.

The default character formatting attributes.

Retrieves the default paragraph formatting attributes of the document.

The default paragraph formatting attributes.

Retrieves a new text range for the active story of the document.

The starting position of the new text range, relative to the beginning of the story. The ending position of the new text range. The new text range.

Retrieves the degenerate (empty) text range at, or nearest to, a particular point on the screen.

The location of the point on the screen, in screen coordinates. The alignment type of the specified *point*. The text range object.

Gets the text in the active story (document).

The text retrieval options. The text in the active story.

Loads a document from a stream.

The text options to use for the loading the document. The random access stream that contains the document.

Reverses the most recent undo operation.

Saves the document to a stream.

The text options for saving the document. The random access stream for saving the document.

Sets the default character formatting attributes of the document.

The new default character formatting attributes.

Sets the default paragraph formatting attributes of the document.

The default paragraph formatting attributes.

Sets the text of the document.

Options controlling how the text is inserted into the document. The new text.

Undoes the most recent undo group.

Defines the default paragraph formatting attributes of a document, or the current paragraph formatting attributes of a text range.

Gets or sets the paragraph alignment.

The paragraph alignment value.

Gets the amount used to indent the first line of a paragraph relative to the left indent.

The first line indentation amount, in floating-point points.

Gets or sets whether page breaks are allowed in paragraphs.

A value that indicates whether page breaks are allowed.

Gets or sets whether page breaks are allowed between paragraphs in a range.

The value that indicates whether page breaks are allowed.

Gets the amount used to indent all lines except the first line of a paragraph.

The amount of left indentation, in floating-point points. Indentation is relative to the left margin.

Gets the paragraph line-spacing value.

The line spacing value. The meaning depends on the value of the LineSpacingRule property. The line spacing value is in floating-point points except when the line-spacing rule is **Multiple** or **Percent**.

Gets the paragraph line-spacing rule.

The paragraph line-spacing rule.

Gets or sets the alignment to use for bulleted and numbered lists.

The alignment for bulleted and numbered lists.

Gets or sets the list level index used with paragraphs.

The list level index. It can be a value of 0 or higher, as described in the following table. <table>

Gets or sets the starting value or code of a list numbering sequence.

The starting value or code of a list numbering sequence.

Gets or sets the style used to mark the item paragraphs in a list.

The style used to mark the item paragraphs.

Gets or sets the list tab setting, which is the distance between the first indent and the start of the text on the first line.

The list tab setting.

Gets or sets the kind of characters used to mark the item paragraphs in a list.

The kind of characters used to mark the item paragraphs.

Gets or sets whether paragraph numbering is suppressed.

A value that indicates whether line numbering is suppressed.

Gets or sets whether there is a page break before a paragraph.

A value that indicates whether there is page break.

Gets or sets the right margin of a paragraph.

The size of the right margin, in floating-point points.

Gets or sets whether the paragraph uses right-to-left formatting.

A value that indicates whether the paragraph uses right-to-left formatting.

Gets or sets the amount of vertical space that follows a paragraph.

The amount of vertical space, in floating-point points.

Gets or sets the amount of vertical space above a paragraph.

The amount of vertical space, in floating-point points.

Gets or sets the paragraph style.

The paragraph style.

Retrieves the tab count.

The tab count.

Gets or sets whether widow and orphan suppression is on or off.

The state of widow and orphan suppression.

Adds a new tab at the specified position.

The position of the new tab, in floating-point points relative to the left side of the page for left-to-right paragraphs, or the right side of the page for right-to-left paragraphs. A maximum of 63 tabs are allowed. Tabs beyond the page are ignored. Negative tabs are not valid. The alignment option for the tab position. The character used to fill the space taken by a tab character.

Clears all tabs, reverting to equally spaced tabs with the default tab spacing.

Deletes the tab at the specified position.

The position of the tab to delete, in floating-point points.

Creates a new object that is identical to this paragraph format object.

The duplicate paragraph format object.

Retrieves information about the specified tab.

The zero-based index of the tab to retrieve. The tab's position, in floating-point points. This parameter is zero if the tab does not exist. The alignment option for the tab position. The character used to fill the space taken by a tab character.

Determines whether this paragraph format object has the same properties as the specified paragraph format object.

The paragraph format object to compare against. True if the objects have the same properties, or false if they don't.

Sets the paragraph formatting by copying another paragraph formatting object.

The paragraph formatting to apply.

Sets the first-line indent, the left indent, and the right indent for a paragraph.

The indent of the first line in a paragraph, relative to the left indent. The value is in floating-point points and can be positive or negative. The left indent of all lines except the first line in a paragraph, relative to the left margin. The value is in floating-point points and can be positive or negative. The right indent of all lines in a paragraph, relative to the right margin. The value is in floating-point points and can be positive or negative. This value is optional.

Sets the paragraph line-spacing rule and the amount of line spacing for a paragraph.

The new line-spacing rule. The new line spacing amount. If the line-spacing *rule* interprets the *spacing* value as a linear dimension, *spacing* is given in floating-point points.

Represents a span of continuous text in a document, and provides powerful editing and data-binding properties and methods that allow an app to select, examine, and change document text.

Gets or sets the first character of the text range; that is, the character associated with the StartPosition property.

The value of the first character in the text range.

Gets or sets the character formatting attributes of the text range.

The character formatting attributes.

Gets or sets the end character position of the text range.

The end character position.

Gets or sets an ITextRange object with the formatted text of the specified range.

The formatted text.

Gets or sets the gravity of the text range.

The gravity of the text range.

Gets the count of characters in the text range.

The count of characters.

Gets or sets the URL text associated with a text range.

The URL as text.

Gets or sets the paragraph formatting attributes of the text range.

The paragraph formatting attributes.

Gets or sets the start position of the text range.

The character position to set as the start position of the text range.

Gets the count of characters in the story of the text range.

The count of characters in the story.

Gets or sets the plain text of the text range.

The plain text.

Determines whether the Clipboard contains content that can be pasted, using a specified format, into the current text range.

The clipboard format. Zero represents the best format, which usually is Rich Text Format (RTF), but CF_UNICODETEXT and other formats are also possible. The default value is zero. True if the Clipboard content can be pasted into the text range in the specified format, and otherwise false.

Changes the case of letters in a text range.

The new case of letters in the text range. The default value is **Lower**.

Collapses the text range into a degenerate point at either the beginning or end of the range.

True collapses at the start of the text range, and false collapses at the end of the range. The default value is true.

Copies the text of the text range to the Clipboard.

Moves the text of the text range to the Clipboard.

Deletes text from the text range.

The unit of text to delete. The number of *units* to delete. See Remarks. The number of *units* deleted. Deleting the text in a nondegenerate text range counts as one *unit*.

Moves or extends the text range to the end of the nearest specified text unit. The text range is moved or extended forward in the document.

The unit by which to move the end position of the text range. True extends the text range by moving just the end position of the range to the end of the specified *unit*. False moves both ends of the text range to the end of the specified *unit*. The default value is false. The number of character positions that the range was moved or extended, plus 1 if the text range collapsed to the start of the range. If the text range includes the final carriage return (CR) at the end of the story, and *extend* is false, the return value is set to –1 to indicate that the collapse occurred before the end of the range. This is because an insertion point cannot exist beyond the final CR.

Expands a text range to completely contain any partial text units.

The text unit to use to expand the range. The default value is **Word**. The number of characters added to the text range, if the range was expanded to include a partially contained *unit*.

Searches for a particular text string in a range and, if found, selects the string.

The text string to search for. The maximum number of characters to search. It can be one of the following. The options to use when doing the text search. The length of the matching text string, or zero if no matching string is found.

Retrieves the Unicode Transformation Format (UTF)-32 character code of the character at the specified offset from the end of the text range.

The character value. The offset from the end of the text range.<table>

Creates a new object that is identical to this text range object.

The duplicate text range object.

Retrieves the story index of the text unit (word, line, sentence, paragraph, and so on) at the starting character position of the text range.

The text unit that is indexed. The index value. The value is zero if *unit* does not exist.

Retrieves the screen coordinates of a particular location in the text range.

The horizontal position to retrieve, relative to the bounding rectangle of the text range. The vertical position to retrieve, relative to the bounding rectangle of the text range. The options for retrieving the coordinates of the specified location in the text range. A structure that receives the coordinates of the specified location in the text range, represented as an ordered pair of floating-point x- and y-coordinates that define a point in a two-dimensional plane.

Retrieves the bounding rectangle that encompasses the text range on the screen.

A value that indicates the rectangle to retrieve. A structure that contains four floating-point numbers that represent the location and size of the bounding rectangle. The hit-test value for the text range.

Retrieves the text in a text range according to the specified conversion flags.

The conversion flags that control how the text is retrieved. The text in the text range.

Retrieves the text in the text range according to the specified conversion flags, as a random access stream.

The conversion flags that control how the text is retrieved. A value of **default** retrieves the plain text in the text range. The text stream.

Determines whether this range is in or at the same text as a specified range.

Text that is compared to the current range. The comparison result. The result can be null. The method returns **True** if the range is in or at the same text as ITextRange; otherwise it returns **False**.

Inserts an image into this range.

The width of the image, in Device-independent pixels (DIPs). The height of the image, in DIPs. If *verticalAlign* is **Baseline**, this parameter is the distance, in DIPs, that the top of the image extends above the text baseline. If *verticalAlign* is **Baseline** and ascent is zero, the bottom of the image is placed at the text baseline. The vertical alignment of the image. The alternate text for the image. The stream that contains the image data.

Determines whether this range's story is the same as a specified range's story.

The ITextRange object whose story is compared to this range's story. The comparison result. The result can be null. The method returns **True** if this range's story is the same as that of the ITextRange; otherwise it returns **False**.

Determines whether this range has the same character positions and story as those of a specified range.

The text range to compare to this text range. True if this text range has the same character positions and story as *range*, and otherwise false.

Sets the start and end positions of this range to match the active selection.

Moves the insertion point forward or backward by the specified number of *units*. If the text range is nondegenerate, it is collapsed to an insertion point at the start or end position of the text range, depending on *count*, and then is moved.

The units to move the insertion point. The default value is **Character**. The number of *units* to move the insertion point. The default value is 1. If *count* is greater than zero, the insertion point moves forward, toward the end of the story. If *count* is less than zero, the insertion point moves backward, toward the beginning of the story. If *count* is zero, the range is unchanged. The actual number of *units* the insertion point moves. For more information, see the Remarks section.

Moves the end position of the text range.

The unit by which to move the end position of the text range. The default value is **Character**. The number of *unit*s to move the end position of the text range. The default value is 1. If *count* is greater than zero, the end position moves forward, toward the end of the story. If *count* is less than zero, the end position move backward, toward the beginning of the story. If *count* is zero, the end position does not move. The actual number of *unit*s that the end position of the text range moved.

Moves the start position of a text range.

The unit by which to move the start position of the text range. The default value is **Character**. The number of *unit*s to move the start position of the text range. The default value is 1. If *count* is greater than zero, the start position of the text range moves forward, toward the end of the story. If *count* is less than zero, the start position of the text range moves backward, toward the beginning of the story. If *count* is zero, the start position doesn't move. The actual number of *unit*s that the start position moved. The pointer can be **NULL**.

Pastes text from the Clipboard into the text range.

The clipboard format to use in the paste operation. Zero represents the best format, which usually is Rich Text Format (RTF), but CF_UNICODETEXT and other formats are also possible. The default value is zero.

Scrolls this text range into view.

The end of the text range to scroll into view. This function uses only the **Start**, **NoHorizontalScroll**, and **NoVerticalScroll** values of the PointOptions enumeration.

Moves the text range to the specified unit of the story.

The *unit* used to move the text range. The index of the specified *unit*. The text range is relocated to the *unit* that has this index. If *unit* is positive, the numbering of units begins at the start of the story and proceeds forward. If negative, the numbering begins at the end of the story and proceeds backward. The start of the story corresponds to *index* = 1 for all existing units, and the last *unit* in the story corresponds to *index* = – 1. Indicates how to change the text range. True extends the text range to include the *unit* by moving only the end position of the text range. False collapses the text range to an insertion point and then moves the insertion point. The default value is false.

Changes the text range based on the specified point.

An ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane. The alignment type of the specified *point*. Indicates how to set the endpoints of the text range. If *extend* is 0, the text range is an insertion point located at the specified point, or at the nearest point with selectable text. If *extend* is 1, the endpoint specified by *options* is moved to the *point* and the other endpoint is left alone. The default value is 0.

Sets the endpoints of the text range to the specified values.

The character position for the start of the text range. This parameter must be less than *endPosition*. The character position for the end of the text range.

Replaces the text in the text range.

The conversion flags that control how the text is inserted in the text range. The new text.

Sets the text in the text range based on the contents of a random access stream.

The text options. The random access stream.

Moves or extends the text range to the start of the nearest specified text unit. The text range is moved or extended backward in the document.

The unit by which to move the start position of the text range. The default value is **Word**. True extends the text range by moving just the start position of the range to the start of the specified *unit*. False moves both ends of the text range to the start of the specified *unit*. The default value is false. The number of characters the insertion point or start position is moved. Note that this value is always less than or equal to zero, since the motion is always toward the beginning of the story.

Represents the currently selected text of a document.

Gets and sets text selection options.

The text selection options. Each option is binary, so if a particular option is not set, the text selection has the opposite option. For example, if the Overtype option is not set, the text selection is set to insert mode.

Retrieves the type of text selection.

The selection type.

Moves the insertion point or the active end of the text selection to the end of the specified unit, mimicking the functionality of the End key.

The units by which to move the insertion point or active end. The following values are valid. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units that the insertion point or the active end is moved.

Moves the insertion point or the active end of the text selection to the home position, mimicking the functionality of the Home key.

The units by which to move the insertion point or active end. The following values are valid. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units that the insertion point or the active end is moved.

Moves the insertion point or the active end of the text selection down, mimicking the functionality of the Down Arrow or Page Down key.

The units by which to move the insertion point or active end. The following values are valid.<table> The number of units to move. The default value is 1. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units that the insertion point or active end moved down. Collapsing the selection counts as one unit.

Moves the insertion point or the active end of the text selection to the left, mimicking the functionality of the Left Arrow key.

The units by which to move the insertion point or active end. The following values are valid. <table> The number of units to move. The default value is 1. If *count* is less than zero, movement is to the right. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units that the insertion point or active end moved. Collapsing the selection counts as one unit.

Moves the insertion point or the active end of the text selection to the right, mimicking the functionality of the Right Arrow key.

The units by which to move the insertion point or active end. The following values are valid. <table> The number of units to move. The default value is 1. If *count* is less than zero, movement is to the left. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units that the insertion point or active end moved. Collapsing the selection counts as one unit.

Moves the insertion point or the active end of the text selection up, mimicking the functionality of the Up Arrow or Page Up keys.

The units by which to move the insertion point or active end. The following values are valid.<table> The number of units to move. The default value is 1. Indicates how to change the selection. True extends the selection by moving only the active end. False collapses the selection to an insertion point and then moves the insertion point. The default value is false. The number of units the insertion point or active end is moved down. Collapsing the selection counts as one unit.

Enters text into the selection as if someone typed it.

The text string to type into this selection.

Represents the character case formatting.

Lowercase characters.

Uppercase characters.

Specifies options for line-spacing rules.

The line-spacing value specifies the spacing from one line to the next. However, if the value is less than single spacing, text is single spaced.

Double line spacing. The line-spacing value is ignored.

The line-spacing value specifies the exact spacing from one line to the next, even if the value is less than single spacing.

The line-spacing value specifies the line spacing, in lines.

One-and-a-half line spacing. The line-spacing value is ignored.

The line-spacing value specifies the line spacing by percent of line height. This option is not supported by Windows.UI.Xaml.Controls.RichEditBox. Setting it will always return an InvalidArgumentException.

Single space. The line-spacing value is ignored.

The line spacing is undefined.

Indicates the link type of a range of text.

A Uniform Resource Identifier (URI) that is automatically recognized.

An email address that is automatically recognized.

A file name, including the full path, that is automatically recognized.

A phone number that is automatically recognized.

A link specified by the client; that is, not an autolink or a friendly-name link.

The address Uniform Resource Identifier (URI) part of friendly-name link. The address it the part that is sent when the user clicks the name.

The name part of a friendly-name link. The name is the part that is displayed.

Not a link.

A mix of link and nonlink attributes.

Defines bullet and numbering alignment.

Text is centered in the line.

Text is left aligned.

Text is right aligned.

The value is undefined.

Specifies the style used to mark the item paragraphs in a list.

The item marker is followed by a hyphen (-).

The items have no markers.

The item marker is enclosed in parentheses, as in (1).

The item marker is followed by a parenthesis, as in 1).

The item marker is followed by a period.

The item marker appears by itself.

The marker style is not defined.

Specifies the kind of characters used to mark the item paragraphs in a list.

The list is numbered with Arabic numerals (0, 1, 2, ...).

Arabic abjadi ( أ ,ب ,ج ,د ,…).

Arabic alphabetic ( أ ,ب ,ت ,ث ,…).

Full-width ASCII (０, １, ２, ３, …).

The list is ordered with Wingdings black circled digits <img alt="Circled black digits." src="./windows.ui.text/images/wingdingblackcircleddigits.png" />

The list uses bullets (character code 0x2022).

The list is ordered with Unicode circled numbers <img alt="Unicode numbers in a circle." src="./windows.ui.text/images/unicodecirclednumbers.png" />

Devanāgarī consonants (क, ख, ग, घ, …).

Devanāgarī numbers (१, २, ३, ४, …).

Devanāgarī vowels (अ, आ, इ, ई, …).

Hebrew alphabet (א, ב, ג, ד, …).

Chinese with no 十.

Chinese with a full-width period, no 十.

The list is ordered with lowercase letters (a, b, c, ...).

The list is ordered with lowercase Roman letters (i, ii, iii, ...).

Not a list paragraph.

Chinese with 十 only in items 10 through 99 (一, 二, 三, 四, …).

Thai alphabetic (ก, ข,ค, ง, …).

Thai numbers (๑, ๒,๓, ๔, …).

Chinese with 十 only in items 10 through 19.

The list type is not defined.

The value returned by ITextParagraphFormat.ListStart is treated as the first code in a Unicode sequence.

The list is ordered with uppercase letters (A, B, C, ...).

The list is ordered with uppercase Roman letters (I, II, III, ...).

The list is ordered with Wingdings white circled digits <img alt="White digits in a black circle." src="./windows.ui.text/images/wingdingwhitecircleddigits.png" />

Specifies values for aligning paragraphs.

Text is centered between the margins.

Text is equally distributed between the margins so that each line of the paragraph, other than the last, is identical in length.

Text aligns with the left margin.

Text aligns with the right margin.

No paragraph alignment is defined.

Specifies the paragraph style.

The top level heading.

The second level heading.

Third level heading.

Fourth level heading.

Fifth level heading.

Sixth level heading.

Seventh level heading.

Eighth level heading.

Ninth level heading.

There is no paragraph style.

The paragraph style is normal.

The paragraph style is undefined.

Defines options for specifying or retrieving a point.

Allow points outside of the client area.

Return client coordinates instead of screen coordinates.

Add left and top insets to the left and top coordinates of the rectangle, and subtract right and bottom insets from the right and bottom coordinates.

Horizontal scrolling is disabled.

No options.

Vertical scrolling is disabled.

The start position of the text range.

Transform coordinates using a world transform supplied by the host app.

Specifies the gravity for a text range.

Use the formatting of the previous text run when on a boundary between runs.

Use the formatting of the following text run when on a boundary between runs.

The start of the text range has forward gravity, and the end has backward gravity.

The start of the text range has backward gravity, and the end has forward gravity.

Use selection user interface rules.

Defines constants that specify whether a RichEditBox interprets input as math (MathML ) or text.

Input is interpreted as math.

Input is interpreted as text.

Represents a rich text document that can be loaded, saved, and edited.

Gets or sets a value that indicates whether trailing white space is taken into account when text is aligned.

**true** if trailing whitespace is taken into account when text is aligned; **false** if trailing whitespace is ignored. The default is **false**.

Gets or sets the caret type.

The caret type.

Gets or sets the default tab spacing.

The default tab spacing.

Gets or sets a value that indicates whether character spacing is applied to the last character in a line.

**true** if spacing is applied to the last character in a line of text; otherwise, **false**. The default is **false**.

Gets the active text selection.

The active text selection.

Gets or sets the maximum number of actions that can be stored in the undo queue.

The maximum number of undo actions.

Decrements an internal counter that controls whether text updates are displayed immediately or batched.

The value of the internal counter.

Increments an internal counter that controls whether text updates are displayed immediately or batched.

The value of the internal counter.

Turns on undo grouping.

Determines whether document content can be copied to the Clipboard.

**true** if copying to the Clipboard is allowed; otherwise, **false**.

Determines whether the Clipboard has content that can be pasted into the document.

**true** if the Clipboard has content that can be pasted into the document; otherwise, **false**.

Determines whether one or more redo operations exist.

**true** if one or more redo operations exist; otherwise, **false**.

Determines whether one or more undo operations exist.

**true** if one or more undo operations exist; otherwise, **false**.

Empties the undo and redo buffers.

Turns off undo grouping.

Retrieves the default character formatting attributes of the document.

The default character formatting attributes.

Retrieves the default paragraph formatting attributes of the document.

The default paragraph formatting attributes.

Retrieves the RichEditBox content as MathML.

The RichEditBox content as MathML.

Retrieves a new text range for the active story of the document.

The starting position of the new text range, relative to the beginning of the story. The ending position of the new text range. The new text range.

Retrieves the degenerate (empty) text range at, or nearest to, a particular point on the screen.

The location of the point on the screen, in screen coordinates. The alignment type of the specified *point*. The new text range.

Gets the text in the active story (document).

The text retrieval options. The text in the active story.

Loads a document from a stream.

The text options to use for the loading the document. The random access stream that contains the document.

Reverses the most recent undo operation.

Saves the document to a stream.

The text options for saving the document. The random access stream for saving the document.

Sets the default character formatting attributes of the document.

The new default character formatting attributes.

Sets the default paragraph formatting attributes of the document.

The default paragraph formatting attributes.

Sets the RichEditBox content to the specified MathML.

The MathML content for the RichEditBox.

Configures a RichEditBox to interpret input based on the specified math mode.

Specifies whether a RichEditBox interprets input as (MathML ) or text.

Sets the text of the document.

Options that control how the text is inserted into the document. The new text.

Undoes the most recent undo group.

Represents a span of continuous text in a RichEditTextDocument, and provides editing and data-binding properties and methods that allow an app to select, examine, and change document content.

Gets or sets the first character of the text range; that is, the character associated with the StartPosition property.

The value of the first character in the text range.

Gets or sets the character formatting attributes of the text range.

The character formatting attributes.

Gets or sets the content link information for this text range.

The content link information for this text range.

Gets or sets the end character position of the text range.

The end character position.

Gets or sets an ITextRange object with the formatted text of the specified range.

The formatted text.

Gets or sets the gravity of the text range.

The gravity of the text range.

Gets the count of characters in the text range.

The count of characters.

Gets or sets the URL text associated with a text range.

The URL as text.

Gets or sets the paragraph formatting attributes of the text range.

The paragraph formatting attributes.

Gets or sets the start position of the text range.

The character position to set as the start position of the text range.

Gets the count of characters in the story of the text range.

The count of characters in the story.

Gets or sets the plain text of the text range.

The plain text.

Determines whether the Clipboard contains content that can be pasted, using a specified format, into the current text range.

The clipboard format. Zero represents the best format, which usually is Rich Text Format (RTF), but CF_UNICODETEXT and other formats are also possible. The default value is zero. **true** if the Clipboard content can be pasted into the text range in the specified format; otherwise, **false**.

Changes the case of letters in a text range.

The new case of letters in the text range. The default value is **Lower**.

Collapses the text range into a degenerate point at either the beginning or end of the range.

**true** to collapse at the start of the text range. **false** to collapse at the end of the range. The default is **true**.

Copies the text of the text range to the Clipboard.

Moves the text of the text range to the Clipboard.

Deletes text from the text range.

The unit of text to delete. The number of _unit_s to delete. The number of _unit_s deleted. Deleting the text in a nondegenerate text range counts as one _unit_.

Moves or extends the text range to the end of the nearest specified text unit. The text range is moved or extended forward in the document.

The unit by which to move the end position of the text range. **true** to extend the text range by moving just the end position of the range to the end of the specified unit. **false** to move both ends of the text range to the end of the specified unit. The default is **false**. The number of character positions that the range was moved or extended, plus 1 if the text range collapsed to the start of the range. If the text range includes the final carriage return (CR) at the end of the story, and extend is false, the return value is set to –1 to indicate that the collapse occurred before the end of the range. This is because an insertion point cannot exist beyond the final CR.

Expands a text range to completely contain any partial text units.

The text unit to use to expand the range. The default value is **Word**. The number of characters added to the text range, if the range was expanded to include a partially contained _unit_.

Searches for a particular text string in a range and, if found, selects the string.

The text string to search for. The maximum number of characters to search. It can be one of the following. The options to use when doing the text search. The length of the matching text string, or zero if no matching string is found.

Retrieves the Unicode Transformation Format (UTF)-32 character code of the character at the specified offset from the end of the text range.

The character value. The offset from the end of the text range.

Creates a new object that is identical to this text range object.

The duplicate text range object.

Retrieves the story index of the text unit (word, line, sentence, paragraph, and so on) at the starting character position of the text range.

The text unit that is indexed. The index value. The value is zero if unit does not exist.

Retrieves the screen coordinates of a particular location in the text range.

The horizontal position to retrieve, relative to the bounding rectangle of the text range. The vertical position to retrieve, relative to the bounding rectangle of the text range. The options for retrieving the coordinates of the specified location in the text range. A structure that receives the coordinates of the specified location in the text range, represented as an ordered pair of floating-point x- and y-coordinates that define a point in a two-dimensional plane.

Retrieves the bounding rectangle that encompasses the text range on the screen.

A value that indicates the rectangle to retrieve. A structure that contains four floating-point numbers that represent the location and size of the bounding rectangle. The hit-test value for the text range.

Retrieves the text in a text range according to the specified conversion flags.

The conversion flags that control how the text is retrieved. The text in the text range.

Retrieves the text in the text range according to the specified conversion flags, as a random access stream.

The conversion flags that control how the text is retrieved. A value of default retrieves the plain text in the text range. The text stream.

Determines whether this range is in or at the same text as a specified range.

Text that is compared to the current range. The comparison result. The result can be **null**. The method returns **true** if the range is in or at the same text as ITextRange; otherwise, it returns **false**.

Inserts an image into this range.

The width of the image, in Device-independent pixels (DIPs). The height of the image, in DIPs. If _verticalAlign_ is **Baseline**, this parameter is the distance, in DIPs, that the top of the image extends above the text baseline. If _verticalAlign_ is **Baseline** and ascent is zero, the bottom of the image is placed at the text baseline. The vertical alignment of the image. The alternate text for the image. The stream that contains the image data.

Determines whether this range's story is the same as a specified range's story.

The ITextRange object whose story is compared to this range's story. The comparison result. The result can be **null**. The method returns **true** if this range's story is the same as that of the ITextRange; otherwise it returns **false**.

Determines whether this range has the same character positions and story as those of a specified range.

The text range to compare to this text range.

Sets the start and end positions of this range to match the active selection.

Moves the insertion point forward or backward by the specified number of _unit_s. If the text range is nondegenerate, it is collapsed to an insertion point at the start or end position of the text range, depending on _count_, and then is moved.

The units to move the insertion point. The default value is **Character**. The number of _unit_s to move the insertion point. The default value is 1. If _count_ is greater than zero, the insertion point moves forward, toward the end of the story. If _count_ is less than zero, the insertion point moves backward, toward the beginning of the story. If _count_ is zero, the range is unchanged. The actual number of units the insertion point moves.

Moves the end position of the text range.

The unit by which to move the end position of the text range. The default value is Character. The number of _unit_s to move the end position of the text range. The default value is 1. If _count_ is greater than zero, the end position moves forward, toward the end of the story. If _count_ is less than zero, the end position move backward, toward the beginning of the story. If _count_ is zero, the end position does not move. The actual number of _unit_s that the end position of the text range moved.

Moves the start position of a text range.

The unit by which to move the start position of the text range. The default value is **Character**. The number of _unit_s to move the start position of the text range. The default value is 1. If _count_ is greater than zero, the start position of the text range moves forward, toward the end of the story. If _count_ is less than zero, the start position of the text range moves backward, toward the beginning of the story. If _count_ is zero, the start position doesn't move. The actual number of _unit_s that the start position moved. The pointer can be **null**.

Pastes text from the Clipboard into the text range.

The clipboard format to use in the paste operation. Zero represents the best format, which usually is Rich Text Format (RTF), but CF_UNICODETEXT and other formats are also possible. The default value is zero.

Scrolls this text range into view.

The end of the text range to scroll into view. This function uses only the **Start**, **NoHorizontalScroll**, and **NoVerticalScroll** values of the PointOptions enumeration.

Moves the text range to the specified unit of the story.

The unit used to move the text range. The index of the specified unit. The text range is relocated to the unit that has this index. If unit is positive, the numbering of units begins at the start of the story and proceeds forward. If negative, the numbering begins at the end of the story and proceeds backward. The start of the story corresponds to index = 1 for all existing units, and the last unit in the story corresponds to index = – 1. Indicates how to change the text range. True extends the text range to include the unit by moving only the end position of the text range. False collapses the text range to an insertion point and then moves the insertion point. The default value is false.

Changes the text range based on the specified point.

An ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane. The alignment type of the specified _point_. Indicates how to set the endpoints of the text range. If extend is 0, the text range is an insertion point located at the specified point, or at the nearest point with selectable text. If extend is 1, the endpoint specified by options is moved to the point and the other endpoint is left alone. The default is 0.

Sets the endpoints of the text range to the specified values.

The character position for the start of the text range. This parameter must be less than _endPosition_. The character position for the end of the text range.

Replaces the text in the text range.

The conversion flags that control how the text is inserted in the text range. The new text.

Sets the text in the text range based on the contents of a random access stream.

The text options. The random access stream.

Moves or extends the text range to the start of the nearest specified text unit. The text range is moved or extended backward in the document.

The unit by which to move the start position of the text range. The default value is **Word**. **true** to extend the text range by moving just the start position of the range to the start of the specified unit. **false** to move both ends of the text range to the start of the specified unit. The default is **false**.

Describes the options that apply to a selection.

The selection is active; that is, the text control has the input focus.

For a degenerate selection (insertion point), the character position at the beginning of a line is the same as the character position at the end of the preceding line. As such, the character position is ambiguous. If this flag is 1, display the caret at the end of the preceding line; otherwise, display it at the beginning of the line.

Insert/overtype mode is set to overtype.

Typing and pasting replaces the selection.

The start position of the selection is the active end; that is, the end that is changed by pressing Shift+Right Arrow and Shift+Left Arrow.

Specifies the type of a selection.

An image (see ITextRange.InsertImage ).

An insertion point.

No selection and no insertion point.

A single nondegenerate range.

A shape.

Alignment options for tab positions.

A vertical bar is positioned at the tab position. Text is not affected. Alignment bars on nearby lines at the same position form a continuous vertical line.

Text is centered on the tab position.

The decimal point is set at the tab position. This is useful for aligning a column of decimal numbers.

Text is left justified from the tab position. This is the default.

Text is right justified from the tab position.

The character that is used to fill the space taken by a tab character.

A dashed line is used.

Dots are used.

An equal sign is used.

A solid line is used.

Spaces are used. This is the default.

A thick line is used.

Defines a set of constants that are used with various methods in the Windows.UI.Text namespace.

Gets the default color.

The default color.

Gets the maximum unit count.

The maximum unit count.

Gets the minimum unit count.

The minimum unit count.

Gets the undefined color value.

The undefined color.

Gets the undefined floating-point value.

The undefined floating-point value.

Gets the undefined font stretch value.

The undefined font stretch value.

Gets the undefined font style.

The undefined font style.

Gets the undefined 32-bit integer value.

The undefined 32-bit integer value.

Defines constants that specify the decorations applied to text.

No text decorations are applied.

Strikethrough is applied to the text.

Underline is applied to the text.

Specifies options for retrieving the text in a document or text range.

If the starting character position is in the middle of a construct such as a CRLF (U+000D U+000A), surrogate pair, variation-selector sequence, or table-row delimiter, move to the beginning of the construct.

Allow retrieving the final end-of-paragraph (EOP) if it’s included in the range. This EOP exists in all rich-text controls and cannot be deleted. It does not exist in plain-text controls.

Retrieve Rich Text Format (RTF) instead of plain text. Rich Text Format (RTF) is a BYTE (8-bit) format, but because ITextRange.GetText returns a string, the Rich Text Format (RTF) is returned as WCHARs (16-bit or UTF-16), not bytes, when you call ITextRange.GetText with the **FormatRtf** value. When you call ITextRange.SetText with **FormatRtf**, the method accepts an string containing either bytes or WCHARs, but other Rich Text Format (RTF) readers only understand bytes.

Include list numbers.

Don't include hidden text.

None of the following options is used.

Use carriage return/line feed (CR/LF) in place of a carriage return.

Use line feed (LF) in place of all carriage returns.

Retrieve text including the alternate text for the images in the range.

Specifies the units to use when navigating a text range.

Text in all uppercase.

Bold text.

A single character.

A text run of characters that all have identical character formatting properties.

A complex-script cluster (occurs, for example, in Indic scripts).

ContentLink text.

Disabled text.

Text is in a font-bound font. That is, characters that can't be displayed with the current font were assigned a different font that could display the characters.

A paragraph that is ended by a carriage return (CR) or carriage return/line feed (CR/LF).

Hidden text.

Imprinted (engraved) text.

Italic text.

A single line of text on a display, provided that the display is associated with the range. If no display is associated with a range, **Line** is treated as **Paragraph**. A selection automatically has a display.

Hyperlink text.

Characters in one or more contiguous, friendly-name hyperlinks. To work with single links that might be adjacent, use the **Link** unit.

An embedded object.

Outline text.

A string of text terminated by an end-of-paragraph mark, such as carriage return/line feed (CR/LF), carriage return (CR), vertical tab(VT), line feed (LF), form feed (FF), or the Unicode paragraph separator (0x2029).

A text run of characters that all have identical paragraph formatting properties.

Protected text.

Revised text.

The contents of a screen. Typically, a screen is the amount of content associated with the Page Up or Page Down key.

A section.

A string of text that meets the following criteria:

Shadow text.

Text in small caps.

A story, which is a contiguous range of text in a document. For example, a story can contain one of the various parts of a document, such as the main text of a document, headers and footers, footnotes, or annotations. In a rich edit control, there is only one story per document, although a client can use multiple documents to represent multiple stories.

Strikethrough text.

Text in the subscript character format.

Text in the superscript character format.

Underlined text.

The characters between the upper-left and lower-right corners of the window.

A span of alphanumeric characters, an end of paragraph, or punctuation that includes any blanks that follow.

Specifies the character repertoire (typically the script) for a run of character formatting.

Aboriginal

Latin 1 (ANSI)

Arabic

Armenian

From Latin 1 and 2

Bangla

Traditional Chinese

Braille

Cherokee

Cyrillic

Default character repertoire

Deseret

Devanagari

Latin 1 and Latin 2

Emoji

Ethiopic

Simplified Chinese

Georgian

Glagolitic

Gothic

Greek

Gujarati

Gurmukhi

Hangul

Hebrew

Jamo

Kannada

Kayahli

Kharoshthi

Khmer

Lao

Limbu

Lisu

Main Macintosh character repertoire

Malayalam

Mongolian

Myanmar

TaiLu

NKo

OEM character set (original PC)

Ogham

Odia

Osmanya

PC437 character set (disk operating system (DOS))

PhagsPa

Runic

Japanese

Sinhala

Syloti Nagri

Symbol character set (not Unicode)

Syriac

TaiLe

Tamil

Telugu

Thaana

Thai

Tibetan

Tifinagh

Turkish (Latin 1 + dotless i, and so on)

Undefined

Unicode symbol such as math operators

Vai

Latin 1 with some combining marks

Yi

Specifies options for setting the text in a text range.

Apply the Rich Text Format (RTF) default settings for the document. Rich Text Format (RTF) often contains document default properties. These properties are typically ignored when inserting Rich Text Format (RTF) (as distinguished from opening an Rich Text Format (RTF) file).

Obey the current text limit instead of increasing the limit to fit.

Treat input text as Rich Text Format (RTF) (the Rich Text Format (RTF) text will be validated).

No text setting option is specified.

Don't insert as hidden text.

Use the Unicode bidirectional algorithm.

Don't include text as part of a hyperlink.

Specifies the type of character underlining.

A dashed line.

Alternating dashes and dots.

Single dashes, each followed by two dots.

A dotted line.

Two solid double lines.

Two wavy lines.

A thick wavy line.

Long dashes.

Characters are not underlined.

A single solid line.

A thick solid line.

Thick dashes.

Thick, alternating dashes and dots.

Thick single dashes, each followed by two thick dots.

A thick dotted line.

Thick long dashes.

A thin solid line.

No underline type is defined.

A wavy line.

Underline words, but not the spaces between words.

Specifies the vertical position of a character relative to a bounding rectangle.

The character is positioned at the text baseline.

The character is positioned at the bottom edge of the bounding rectangle.

The character is positioned at the top edge of the bounding rectangle.

Provides data for the CompositionCompleted event.

Gets a collection of CoreTextCompositionSegment objects representing the segments in the composition string. Applications can use this property, for example, to get the pre-conversion string for each composition segment.

A collection of CoreTextCompositionSegment objects.

Gets a value that indicates whether the operation is canceled.

**true** if the operation is canceled; otherwise, **false**.

Requests that the operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Represents a segment in a composition string. See Remarks for an illustration.

Gets a string that represents the state of the user input after IME-processing but before final conversion.

A string that represents the pre-conversion string.

Gets an object that represents the range that defines this composition segment.

An object that represents the range that defines this composition segment.

Provides data for the CompositionStarted event.

Gets a value that indicates whether the operation is canceled.

**true** if the operation is canceled; otherwise, **false**.

Requests that the operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

The primary object used by text input controls to communicate with the text input server.

Gets or sets a value that indicates whether the input pane should be shown automatically when focus enters your text input control. The default value is **Automatic**, indicating that the input pane will be shown automatically. A value of **Manual** indicates that your app will be responsible for showing and hiding the input pane using InputPane.TryShow and TryHide.

One of the CoreTextInputPaneDisplayPolicy enumeration values. The default is **Automatic**.

Gets or sets a value that indicates the input scope of the text input control.

One of the CoreTextInputScope enumeration values. The default is **Default**.

Gets or sets a value that indicates whether the edit control is editable.

**true** if the text input control is read-only; otherwise, **false**. The default is **false**.

Gets or sets a descriptive name for the text input control. An application framework usually uses properties such as "name" or "id" to identify a control, so it’s recommended that you set this property accordingly on the text input server so that input processors can better preserve the input context, and provide better suggestions.

A string containing a descriptive name for the text input control.

Occurs when composition has completed.

Occurs when composition has started.

Occurs when focus was forcibly removed from a text input control. The application should handle this event to remove focus for the text input control accordingly.

Occurs when the text input server needs to apply a different format to a particular range of text. This usually happens during composition.

Occurs when the text input server needs to get the bounding box of a range of text and of the text input control itself. The application should handle this event and return the geometry information requested.

Occurs after focus has left the text input control.

Occurs when the text input server needs to get the text range representing the currently selected text in the text input control. The application should handle this event and return the range requested.

Occurs when the text input server needs to modify the range of text currently selected in the text input control. This event could be the result of an input processor needing to select some text, or to move the caret. The text input control should set its selection range accordingly.

Occurs when the text input server needs to get a range of text from the text input control. The application should handle this event and return the range requested.

Occurs when the text input server needs to modify text inside the text input control. This event could be the result of a key event— such as inserting a single character— or the result of processing done by an input processor, such as auto-correction and prediction.

Notifies the text input server that focus has entered the text input control.

Notifies the text input server that focus has left the text input control.

Notifies the text input server that the layout of text inside the text input control has changed.

Notifies the text input server about any change that the text input control needs to make to the selection range. This is important in order to keep the internal state of the control and the internal state of the server synchronized.

The range of selection currently in effect.

Notifies the text input server about any change that the text input control needs to make to the text. This is important in order to keep the internal state of the control and the internal state of the server synchronized. Since a change to the text is also likely to affect the selection range, the method takes the selection range as a parameter.

The range of text to replace, in terms of the state the text buffer is in prior to this text change. The length of the text that should replace *modifiedRange*. The range of selection in effect after the text change.

Provides data for the FormatUpdating event.

Gets a value that represents the background color to be applied to the text range. The text input server populates this property before raising the event.

A value that represents the background color to be applied to the text range.

Gets a value that indicates whether the format update operation is canceled.

**true** if the format update operation is canceled; otherwise, **false**.

Gets a value that indicates the range of text that the text input server needs to format. The server populates this property before raising the event.

The range of text to format.

Gets a value that indicates the reason that the text input server needs to apply formatting to this range of text. The server populates this property before raising the event.

A value that indicates the reason that the server needs to apply formatting to this range of text.

Gets or sets a value that indicates the result of handling the FormatUpdating event. The default value is **Succeeded** but if you can't action the operation as the text input server expects then before returning from the event handler set the property to the appropriate value to indicate what has happened.

The result of handling the FormatUpdating event. The default is **Succeeded**.

Gets a value that represents the text color to be applied to the text range. The text input server populates this property before raising the event.

A value that represents the text color to be applied to the text range.

Gets a value that represents the underline color to be applied to the text range. The text input server populates this property before raising the event.

A value that represents the underline color to be applied to the text range.

Gets a value that represents the underline type to be applied to the text range. The text input server populates this property before raising the event.

A value that represents the underline type to be applied to the text range.

Requests that the format update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Defines constants that specify the set of state applied during text composition.

The text is a converted composition string.

The user made a selection in the composition string, but the text has not yet been converted.

The user has made a selection in the composition string and the text has been converted.

The text is an unconverted composition string.

The reason for the format updating is unknown.

Defines constants that specify the result of handling the FormatUpdating event.

The format update operation was not completed as the text input server expected.

The format update operation completed successfully.

Defines constants that specify whether the input pane should be shown automatically when focus enters your text input control.

The input pane will be shown automatically when focus enters your text input control.

Your app is responsible for showing and hiding the input pane.

Defines constants that specify the set of input scope names. Input scope is used by the text input server and input processors to determine the layout of the Soft Input Panel (SIP), and what type of language model to use.

Expected input is a full postal address. (For example, "One Microsoft Way, Redmond, WA 98052, U.S.A.")

Expected input is the city portion a full address. (For example, "Redmond".)

Expected input is the country name portion a full address. (For example, "United States of America".)

Expected input is the country abbreviation portion a full address. (For example, "U.S.A.")

Expected input is the postal code (or zip code) portion a full address. (For example, "98052".)

Expected input is the state or province portion a full address. (For example, "WA".)

Expected input is the street portion a full address. (For example, "Microsoft Way".)

Expected input is full-width alphanumeric characters.

Expected input is half-width alphanumeric characters.

Expected input is the Bopomofo Mandarin Chinese phonetic transcription system.

Expected input is chat strings.

Expected input does not include emoji. Advises input processors to not display the emoji key.

Expected input is Chinese full-width characters.

Expected input is Chinese half-width characters.

Expected input is an amount of currency.

Expected input is an amount of currency and a currency symbol.

Expected input is Chinese currency.

Expected input is a calendar date.

Expected input is the numeric day portion of a calendar date.

Expected input is the alphabetic name of the day from a calendar date.

Expected input is the numeric month portion of a calendar date.

Expected input is the alphabetic name of the month from a calendar date.

Expected input is the year portion of a calendar date.

No input scope is applied.

Expected input includes positive whole numbers, constrained to 0-9.

Expected input is an SMTP form email address (<accountname><host>).

Expected input is the account name portion of an email address.

Expected input is an email user name (\<accountname>) or full email address (\<accountname>\<host>).

Expected input is characters used in describing a file name.

Expected input is characters used in describing a file path.

Expected input is a mathematical formula.

Expected input is a mathematical formula. Advises input processors to show the number page.

Expected input is Hangul full-width characters.

Expected input is Hangul half-width characters.

Expected input is Hanja characters.

Expected input is Hiragana characters.

Expected input is Katakana full-width characters.

Expected input is Katakana half-width characters.

Expected input is from the device's Maps layout; does not include typing intelligence.

Expected input is a name or a telephone number.

Expected input is native script.

Expected input includes the digits 0-9, decimal separators, place separators, and negative sign. The exact characters used for decimal separators, place separators, and negative sign, depend on the user’s regional settings.

Expected input is full-width number characters.

Expected input is a password.

Expected input is a numeric password, or PIN.

Expected input is a person’s full name, including prefix, given name, middle name, surname, and suffix.

Expected input is the given (or first) name portion of a person’s full name.

Expected input is the middle name portion of a person’s full name.

Expected input is the prefix portion of a person’s full name. (For example, "Mr.")

Expected input is the suffix portion of a person’s full name. (For example, "Jr.")

Expected input is the family (or last) name portion of a person’s full name.

Expected input is an alphanumeric password, or PIN. Typically constrained to 5-6 characters.

Expected input is an numeric password, or PIN. Typically constrained to 5-6 digits.

Expected input is private data. Advises input processors that the text should not be stored nor logged.

Expected input is a search string.

Expected input is a search string. Use for search boxes where incremental results are displayed as the user types.

Expected input is a single ANSI character, codepage 1252.

Expected input is the area code portion of a full telephone number. (For example, "(800)".)

Expected input is the country code portion of a full telephone number. (For example, "1".)

Expected input is the local number portion of a full telephone number. (For example, "555-5555".)

Expected input is a full telephone number. (For example, "1(800)555-5555".)

Expected input is text; turns on typing intelligence.

Expected input is a time value.

Expected input is the hour portion of a time value.

Expected input is the minute or second portion of a time value.

Expected input is a URL.

Expected input is a log-in name and a domain (<accountname> or <domain>\<accountname>).

Represents the screen coordinates of the bounding box for a range of text, or a text input control.

Gets or sets the bounding box in screen coordinates of a text input control.

The bounding box in screen coordinates of a text input control.

Gets or sets the bounding box in screen coordinates of a range of text.

The bounding box in screen coordinates of a range of text.

Represents information about a LayoutRequested event.

Gets a value that indicates whether the layout request operation is canceled.

**true** if the layout request operation is canceled; otherwise, **false**.

Gets the screen coordinates of the bounding box for a range of text, or a text input control.

An object that represents the layout bounds information requested by the text input server.

Gets the coordinates of the bounding box for a range of text, or a text input control, relative to viewport of your application.

An object that represents the layout bounds information requested by the text input server.

Gets a value that indicates the range of text whose bounding box is being requested by the text input server. The server populates this property before raising the event.

The range of text whose bounding box is being requested by the server.

Requests that the layout request operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Provides data for the LayoutRequested event.

Gets information about a LayoutRequested event.

An object that represents information about a LayoutRequested event.

Defines a range of text inside a text input control.

The end position of a range in Application Character Position (ACP) terms.

The start position of a range in Application Character Position (ACP) terms.

Represents information about a SelectionRequested event.

Gets a value that indicates whether the selection request operation is canceled.

**true** if the selection request operation is canceled; otherwise, **false**.

Gets or sets the selection range that the text input server is requesting. The application should set the current range of selection before returning from the event handler.

The selection range that the server is requesting. The default is null.

Requests that the selection request operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Provides data for the SelectionRequested event.

Gets information about a SelectionRequested event.

An object that represents information about a SelectionRequested event.

Provides data for the SelectionUpdating event.

Gets a value that indicates whether the selection update operation is canceled.

**true** if the selection update operation is canceled; otherwise, **false**.

Gets or sets a value that indicates the result of handling the SelectionUpdating event. The default value is **Succeeded** but if you can't action the operation as the text input server expects then before returning from the event handler set the property to the appropriate value to indicate what has happened.

The result of handling the SelectionUpdating event. The default is **Succeeded**.

Gets a value that indicates the range of text that the text input server indicates should be selected. The server populates this property before raising the event.

The range of text that the server indicates should be selected.

Requests that the selection update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Defines constants that specify the result of handling the SelectionUpdating event.

The selection update operation was not completed as the text input server expected.

The selection update operation completed successfully.

Provides constant values for use with the Windows core text APIs and the text input server.

Gets a value to use to replace hidden data inside a text stream before returning the text to the text input server.

A value to use to replace hidden data inside a text stream. The Unicode code point is 0xF8FD.

The entry point to all services provided by the Windows core text APIs and the text input server. This object is associated with an application's UI thread (the thread that CoreWindow runs on).

Gets a Language object representing the current input language.

An object representing the current input language.

Occurs when the current input language has changed.

Creates a context object used by a text input control to communicate with the text input server. Each text input control must create its own context object.

A CoreTextEditContext instance, which is the primary object used for communicating with the text input server.

Gets the CoreTextServicesManager object for the currently active view.

A CoreTextServicesManager instance, which can be used to create further objects to support the app's text input scenarios.

Represents information about a TextRequested event.

Gets a value that indicates whether the text request operation is canceled.

**true** if the text request operation is canceled; otherwise, **false**.

Gets a value that indicates the range of text being requested by the text input server. The server populates this property before raising the event.

The range of text being requested by the server.

Gets or sets the text that the text input server is requesting. The application should set the text being requested before returning from the event handler.

The text that the server is requesting. The default is null.

Requests that the text request operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral object.

Provides data for the TextRequested event.

Gets information about a TextRequested event.

An object that represents information about a TextRequested event.

Provides data for the TextUpdating event.

Gets a Language object representing the current input language.

An object representing the current input language.

Gets a value that indicates whether the text update operation is canceled.

**true** if the text update operation is canceled; otherwise, **false**.

Gets a value that indicates the range of text that the text input server indicates should be selected. The server populates this property before raising the event.

The range of text that the server indicates should be selected.

Gets a value that indicates the range of text that the text input server needs to modify. The server populates this property before raising the event.

The range of text to modify.

Gets or sets a value that indicates the result of handling the TextUpdating event. The default value is **Succeeded** but if you can't action the operation as the text input server expects then before returning from the event handler set the property to the appropriate value to indicate what has happened.

The result of handling the TextUpdating event. The default is **Succeeded**.

Gets the text that the text input server is requesting to be set into the modified range. The server populates this property before raising the event.

The text that the server is requesting to be set into the modified range.

Requests that the text update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

A Deferral deferral object.

Defines constants that specify the result of handling the TextUpdating event.

The text update operation was not completed as the text input server expected. The state of the text input control is unchanged.

The text update operation completed successfully.

Provides access to the high contrast accessibility settings.

Initializes a new AccessibilitySettings object.

Gets a value that indicates whether the system high contrast feature is on or off.

True if the high contrast feature is on; otherwise false.

Gets the name of the default high contrast color scheme.

The name of the default high contrast color scheme.

Occurs when the system high contrast feature turns on or off.

Provides methods for switching to an app view in response to an activation.

Returns a value that indicates whether the specified view is present on the virtual desktop that the activation was initiated on.

The identifier for that view that is being activated. **true** if the view is present on the virtual desktop that the activation was initiated on; otherwise, **false**.

Shows the view in a new standalone window.

The identifier for the view. The asynchronous results of the operation. Use this to determine when the async call is complete.

Shows the view in a new standalone window and sets the size preference for the view.

The identifier for the view. The preferred size of the view. The asynchronous results of the operation. Use this to determine when the async call is complete.

Represents the active application view and associated states and behaviors.

Gets a value that indicates whether the current window is in close proximity to the left edge of the screen.

**true** if the current window is in close proximity to the left edge of the screen; otherwise, **false**.

Gets a value that indicates whether the current window is in close proximity to the right edge of the screen.

**true** if the current window is in close proximity to the right edge of the screen; otherwise, **false**.

Gets or sets a value that indicates whether there is a critical input mismatch.

**true** if there is a critical input mismatch; otherwise, **false**. The default is **false**.

Gets a value that indicates the bounds used by the framework to lay out the contents of the window (app view).

The current layout bounds of the window. The default is **UseVisible**.

Gets or sets a value that indicates how an app in full-screen mode responds to edge swipe actions.

A value from the FullScreenSystemOverlayMode enumeration that indicates how an app in full-screen mode responds to edge swipe actions.

Gets the ID of the window (app view).

The ID of the window. It is unique for all windows managed by the app.

Gets a value that indicates whether the window touches both the left and right sides of the display.

**true** if the window touches both the left and right sides of the display; otherwise, **false**.

Gets a value that indicates whether the app is running in full-screen mode.

**true** if the app is running in full-screen mode; otherwise, **false**. The default is **false**.

Gets whether the window (app view) is on the Windows lock screen.

**true** if the calling window is on the lock screen; **false** if it is not.

Gets or sets whether screen capture is enabled for the window (app view).

**true** if screen capture is enabled for the window; **false** if it is not.

Gets the current orientation (landscape or portrait) of the window (app view) with respect to the display.

The current orientation of the calling window.

Gets or sets a string that identifies this view for tracking and saving state.

A string that identifies this view for tracking and saving state.

Gets or sets the size that the app launches with when the ApplicationView.PreferredLaunchWindowingMode property is set to **PreferredLaunchViewSize**, except in cases where the system manages the window size directly.

The size that the app launches with when the ApplicationView.PreferredLaunchWindowingMode property is set to **PreferredLaunchViewSize**, except in cases where the system manages the window size directly.

Gets or sets a value that indicates the windowing mode the app launches with.

An enumeration value that indicates the windowing mode of the app.

Gets or sets a value indicating whether or not system overlays (such as overlay applications or the soft steering wheel) should be shown.

**true** if system overlays (such as overlay applications or the soft steering wheel) should be shown; otherwise, **false**.

Gets or sets a value that indicates whether there is a temporary input mismatch.

**true** if there is a temporary input mismatch; otherwise, **false**. The default is **false**.

Indicates whether the app terminates when the last window is closed.

**true** if the app terminates when the last open window is closed; **false** if it doesn't terminate.

Gets or sets the displayed title of the window.

The title of the window.

Gets the title bar of the app.

The title bar of the app.

Gets the context identifier for the view.

The context identifier for the view.

Gets the state of the current window (app view).

The state of the current window (app view). This state indicates the orientation (landscape or portrait) and whether or not the app is snapped.

Gets the app view mode for the current view.

A value of the enumeration that indicates the view mode of the current view.

Gets the visible region of the window (app view). The visible region is the region not occluded by chrome such as the status bar and app bar.

The visible region of the window (app view).

Gets the windowing environment for the view.

The windowing environment for the view.

Occurs when the window is removed from the list of recently used apps, or if the user executes a close gesture on it.

This event is raised when the value of VisibleBounds changes, typically as a result of the status bar, app bar, or other chrome being shown or hidden.

Clears any properties the system has saved for any view PersistedStateId for the given application.

Clears any properties the system has saved for the view with the specified identifier for the given application.

The PersistedStateId for the view to be cleared.

Takes the app out of full-screen mode.

Gets the window ID that corresponds to a specific CoreWindow managed by the app.

Reference to the CoreWindow object that contains a window handle used by the app. The ID of the window associated with the supplied CoreWindow.

Returns the collection of display regions available for the view.

The collection of display regions available for the view.

Gets the view state and behavior settings of the active application.

An ApplicationView instance that can be used to get and set app display properties.

Determines whether the specified view mode is supported on the current device.

A value of the enumeration that indicates the desired view mode. **true** if the specified view mode is supported; otherwise, **false**.

Sets a value indicating the bounds used by the framework to lay out the contents of the window (app view).

The bounds that the framework should use to lay out the contents of the window (app view). **true** to confirm that the change to DesiredBoundsMode was successful; otherwise, **false**.

Sets the smallest size, in effective pixels, allowed for the app window.

The smallest size allowed for the app window, or a Size whose height and width are both zero to use the system default minimum size.

Shows system UI elements, like the title bar, over a full-screen app.

Tries to close the current app view. This method is a programmatic equivalent to a user initiating a close gesture for the app view.

**true** if the app views are consolidated; otherwise, **false**.

Attempts to place the app in full-screen mode.

**true** if the app is placed in full-screen mode; otherwise, **false**.

Attempts to change the app view to the specified view mode.

A value of the enumeration that indicates the desired view mode. **true** if the app view was changed to the specified view mode; otherwise, **false**.

Attempts to change the app view to the specified view mode using the specified options.

A value of the enumeration that indicates the desired view mode. Preferred settings for the desired view mode. **true** if the app view was changed to the specified view mode; otherwise, **false**.

Attempts to change the size of the view to the specified size in effective pixels.

The new size of the view in effective pixels. **true** if the view is resized to the requested size; otherwise, **false**.

Attempts to unsnap a previously snapped app. This call will only succeed when the app is running in the foreground.

TryUnsnap may be altered or unavailable for releases after Windows 8.1. Apps can be continuously resized, but cannot be snapped, starting in Windows 8.1. **true** if the app has been successfully unsnapped; **false** if the unsnap attempt failed.

Attempts to unsnap a previously snapped app.

IApplicationViewFullscreenStatics is deprecated after Windows 8. Please use other resize APIs. **true** if the app has been successfully unsnapped; **false** if the unsnap attempt failed.

The bounds used by the framework to lay out the contents of a window (app view).

Lay out the window's content within the region occupied by the core window (that is, including any occluded areas).

Lay out the window's content within the visible region (that is, the region not occluded by chrome such as the status bar and app bar).

Contains the results of a window (app view) consolidation operation.

Gets a value that indicates whether the window consolidation was app-initiated.

**true** if the window consolidation operation was app-initiated; otherwise **false**.

Gets a value that indicates whether the window consolidation was user-initiated.

**true** if the window consolidation operation was user-initiated; otherwise, **false**.

Defines constants that specify the view mode of an app window.

The app window is in a compact overlay (picture-in-picture) mode.

The app window is in it's default mode.

Defines the set of display orientation modes for a window (app view).

The window is in landscape orientation, with the display width greater than the height.

The window is in portrait orientation, with the display height greater than the width.

Specifies the set of app view state changes that can be handled.

ApplicationViewState may be altered or unavailable for releases after Windows 8.1. Instead, query for window layout sizes directly.

The current app's view has been reduced to a partial screen view as the result of another app snapping.

The current app's view is in full-screen (has no snapped app adjacent to it), and has changed to landscape orientation.

The current app's view is in full-screen (has no snapped app adjacent to it), and has changed to portrait orientation.

The current app's view has been snapped.

Represents the app view switching behaviors for an app.

Disables the primary window (app view) when the app is activated, showing the most recently displayed window instead.

Disables Windows shell control of the view selection on activation, and lets the app handle it instead.

Prepares your app to visually transition between two windows with a custom animation.

The ID of the window from which your app is transitioning. The ID of the window to which your app is transitioning. Enumeration value that specifies thw view switching behaviors. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Visually replaces the calling window (app view) with a specified window.

The ID of the window under preparation for display. The asynchronous results of the operation. Use this to determine when the async call is complete.

Visually replaces the calling window (app view) with a specified window.

The ID of the window under preparation for display. The ID of the calling, currently displayed window. The asynchronous results of the operation. Use this to determine when the async call is complete.

Visually replaces the calling window (app view) with a specified window.

The ID of the window under preparation for display. The ID of the calling, currently displayed window. Options for the display transition behaviors. The asynchronous results of the operation. Use this to determine when the async call is complete.

Displays another window (app view) for the app on the screen, adjacent to the original window

The ID of the new window to display. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Displays another window (app view) for the app on the screen, adjacent to the original window

The ID of the new window to display. The preferred general sizing of the new window. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Displays another window (app view) for the app on the screen, adjacent to the original window.

The ID of the new window to display. The preferred general sizing of the new window. The ID of the calling (anchor) window. The preferred new general sizing of the calling window if this call succeeds. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Displays a view as a standalone view in the desired view mode.

The ID of the window to display. The desired view mode for the window. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Displays a view as a standalone view in the desired view mode with the specified options.

The ID of the window to display. The desired view mode for the window. Preferred settings for the desired view mode. Asynchronously returns **true** if the call succeeds; **false** if it does not.

Defines a set of options for window (app view) switching behaviors.

Close the initial window and remove it from the list of recently used apps, and display the window to which the app is switching.

Perform the standard animated transition between windows upon switching.

Immediately transition between windows without animation.

Represents the title bar of an app.

Gets or sets the color of the title bar background.

The color of the title bar background. (See Color.)

Gets or sets the background color of the title bar buttons.

The background color of the title bar buttons. (See Color.)

Gets or sets the foreground color of the title bar buttons.

The foreground color of the title bar buttons. (See Color.)

Gets or sets the background color of a title bar button when the pointer is over it.

The background color of a title bar button when the pointer is over it. (See Color.)

Gets or sets the foreground color of a title bar button when the pointer is over it.

The foreground color of a title bar button when the pointer is over it. (See Color.)

Gets or sets the background color of a title bar button when it's inactive.

The background color of a title bar button when it's inactive. (See Color.)

Gets or sets the foreground color of a title bar button when it's inactive.

The foreground color of a title bar button when it's inactive. (See Color.)

Gets or sets the background color of a title bar button when it's pressed.

The background color of a title bar button when it's pressed. (See Color.)

Gets or sets the foreground color of a title bar button when it's pressed.

The foreground color of a title bar button when it's pressed. (See Color.)

Gets or sets the color of the title bar foreground.

The color of the title bar foreground. (See Color.)

Gets or sets the color of the title bar background when it's inactive.

The color of the title bar background when it's inactive. (See Color.)

Gets or sets the color of the title bar foreground when it's inactive.

The color of the title bar foreground when it's inactive. (See Color.)

Represents information about a window drag operation.

Initializes a new instance of the ApplicationViewTransferContext class.

Gets the format ID of the DataPackage for the drag operation.

The format ID of the DataPackage for the drag operation.

Gets or sets the ID of the application view.

The ID of the application view.

Defines constants that specify whether the app window is auto-sized, full-screen, or set to a specific size on launch.

The system sizes the app window automatically.

The window is shown as a compact overlay (picture-in-picture).

The window is full-screen.

The window is maximized.

The window is sized as specified by the ApplicationView.PreferredLaunchViewSize property.

Defines constants that specify how the app responds to edge gestures when in full-screen mode.

Edge gestures call up a temporary UI, which in turn can be used to call up system overlays corresponding to that edge.

Edge gestures call up system overlays, like the taskbar and title bar.

Defines the set of directional preferences for the user interface presented by the app view.

The preferred layout is for left-directional users.

The preferred layout is for right-directional users.

Enables an app to receive notifications when the docked touch keyboard, or Soft Input Panel (SIP), is about to be displayed or hidden, and to determine which portion of the application's window is obscured by the input pane.

Gets the region of the app window obscured by the input pane.

The rectangle, in client coordinates, representing the region of the app window hidden behind the input pane. Specified in device-independent pixel (DIP).

Gets or sets a value that indicates whether the input pane is shown.

**true** if the input pane is shown; otherwise, **false**.

Occurs when the input pane starts sliding out of view.

Occurs when the input pane starts sliding into view.

Gets the InputPane object associated with the application window that is currently visible.

The input pane.

Gets the InputPane object associated with the view with the specified context identifier.

The context identifier of the view to get the input pane for. The input pane.

Tries to hide the InputPane, if it is visible.

**true** if the request to hide the InputPane was accepted; otherwise **false**.

Tries to show the InputPane, if it is hidden.

**true** if the request to show the InputPane was accepted; otherwise **false**.

Provides data for the input pane Hiding and Showing events.

Identifies whether the application has taken steps to ensure that the input pane doesn't cover the UI element that has focus.

True if the application has ensured that the input pane isn't covering the UI element that has focus; otherwise false.

Gets the region of the application's window that the input pane is covering.

The window region that the input pane is covering, in client coordinates specified in device independent pixels (DIPs).

Defines a set of methods for managing the windows (app views) sent to secondary displays, such as projectors.

Gets whether or not a projection display is available to use.

**true** if a projection display is available on the current computer; **false** if it is not.

Occurs when a projector or other secondary display becomes available or unavailable.

Returns a string that is used to enumerate device services.

A string that is used to enumerate device services.

Makes a request to asynchronously sends a window (app view) to the projector or other secondary display.

The new ID of the window to be displayed by the projector or other secondary display. The ID of the original window before projection. The area to one side of which the flyout is displayed. **true** if projection started; otherwise, **false**.

Makes a request to asynchronously sends a window (app view) to the projector or other secondary display with the specified preferred placement.

The new ID of the window to be displayed by the projector or other secondary display. The ID of the original window before projection. The area to one side of which the flyout is displayed. The side of the rectangle where the flyout should appear. **true** if projection started; otherwise, **false**.

Asynchronously sends a window (app view) to the projector or other secondary display.

The new ID of the window to be displayed by the projector or other secondary display. The ID of the original window before projection. The asynchronous results of the operation. Use this to determine when the async call is complete.

Asynchronously sends a window (app view) to the projector or other secondary display, and provides info about the display.

The new ID of the window to be displayed by the projector or other secondary display. The ID of the original window before projection. Information about the display device. The asynchronous results of the operation. Use this to determine when the async call is complete.

Asynchronously hides a window (app view) displayed by a projector or other secondary display.

The ID of the window currently displayed by the projector or other secondary display. The ID of the original window before projection. The asynchronous results of the operation. Use this to determine when the async call is complete.

Asynchronously swaps the calling window (app view) with the window displayed on the projector or other secondary display. The result is that the calling window is displayed on the projector, and the formerly projected window is displayed on the device screen.

The ID of the window currently displayed by the projector. The ID of the window to swap with the projected window. The asynchronous results of the operation. Use this to determine when the async call is complete.

Defines constants that specify known system color values.

The accent color.

The dark accent color.

The darker accent color.

The darkest accent color.

The light accent color.

The lighter accent color.

The lightest accent color.

The background color.

Not supported. Do not use.

The foreground color.

Defines the set of user interface element types.

An active caption element.

A background element.

A button face element.

The text displayed on a button.

The text displayed in a caption.

Greyed text.

A highlighted user interface (UI) element.

Highlighted text.

A hotlighted UI element.

An inactive caption element.

The text displayed in an inactive caption element.

A window.

The text displayed in a window's UI decoration.

Contains a set of common app user interface settings and operations.

Creates a new default instance of the UISettings class.

Gets a value that indicates whether the system Transparency effects setting is enabled.

**true** if Transparency UI effects are enabled; otherwise, **false**.

Gets whether animations are enabled for the user interface.

**true** if animations are enabled; **false** if not.

Gets whether the user has specified that scroll bars should be automatically hidden when not being interacted with.

True, if **Settings -> Ease of Access -> Display -> Automatically hide scroll bars in Windows** is set. Otherwise, false.

Gets the blink rate of a new caret created by the app view.

The blink rate of the new caret, in milliseconds.

Gets whether the caret can be used for browse operations.

True if the caret can be used for browse operations; false if it cannot.

Gets the width of a new caret created by the app view.

The width of a new caret, in pixels.

Gets the size of a new cursor created by the app view.

The size of a new cursor.

Gets the maximum allowed time between clicks in a double-click operation.

The delta of a double-click operation, in milliseconds.

Gets the directional preference of the user interface created by the app view.

The directional preference of the user interface.

Gets the length of time a message is displayed for the app view.

The duration the message is displayed, in seconds.

Gets the amount of time the mouse pointer can rest in a hover rectangle before a hover event is raised.

The hover time before a hover event is raised, in milliseconds.

Gets the size of a scroll bar arrow for windows associated with the app view.

The size of a scroll bar arrow.

Gets the size of a scroll bar for windows associated with the app view.

The size of the scroll bar.

Gets the size of a thumb box for windows associated with the app view.

The size of the thumb box.

Gets the value of the system text size setting.

The value ranges from 1 to 2.25.

Occurs when the system advanced UI effects setting is enabled or disabled.

Occurs when the value of the AnimationsEnabled property has changed.

Event invoked when the AutoHideScrollBars state changes.

Occurs when color values have changed.

Occurs when the value of the MessageDuration property has changed.

Occurs when the system text size setting is changed.

Returns the color value of the specified color type.

An enumeration value that specifies the type of color to get a value for. The color value of the specified color type.

Gets the color used for a specific user interface element type, such as a button face or window text.

The type of element for which the color will be obtained. The color of the element type, expressed as a 32-bit color value.

Contains event data for the AnimationsEnabledChanged event.

Contains event data for the AutoHideScrollBarsChanged event.

Contains event data for the MessageDurationChanged event.

Represents UI states and behaviors associated with the device mode (Tablet or Desktop) and input device type.

Gets a value that indicates whether the device UI is optimized for touch input or mouse input.

A value that indicates the input type (mouse or touch) the device UI is optimized for.

Gets the UI states and behaviors associated with the device mode (Tablet or Desktop) for the active app.

A UIViewSettings instance that can be used to get and set view settings properties.

Specifies the UI view, optimized for input device type.

The device UI is optimized for mouse input.

The device UI is optimized for touch input.

Represents the preferred settings to be applied to a view when it's changed to a new view mode.

Gets or sets a custom preferred size for the app window.

The preferred size for the app window.

Gets or sets the preferred size of the app window.

A value of the enumeration that indicates the preferred size of the app window.

Creates a new instance of **ViewModePreferences** with default property values set for the specified view mode.

The view mode to set default preferences for. A new instance of **ViewModePreferences** with default property values set for the specified view mode.

Defines the set of possible general window (app view) size preferences.

The window uses a custom preferred size specifed in the app.

The app does not have a window size preference specified. Windows, rather than the app, sets the size preference, which defaults to **UseHalf**.

The window uses 50% (half) of the available horizontal screen pixels.

The window uses less than 50% of the available horizontal screen pixels.

The window uses the minimum horizontal pixel width (either 320 or 500 pixels) specifies in the app's manifest (such as package.appxmanifest).

The window uses more than 50% of the available horizontal screen pixels.

The window has no visible component.

Enables an app to receive notifications when a docked, undocked, moveable, or transitory input pane (and associated UI) is moved, displayed, or hidden, and to determine which portion of the app's window is obscured by the pane.

Occurs when one or more CoreInputViewOcclusion objects change their position or occluding area.

Occurs before the input pane associated with the CoreInputView is hidden (if visible).

Occurs before the input pane associated with the CoreInputView is shown (if hidden).

Occurs when focus is moved to the input pane from the application UI.

Occurs before the input pane loses focus and before a UI element gets focus.

Retrieves a reference to each input pane currently occluding the app.

A CoreInputViewOcclusion collection.

Retrieves the CoreInputView object associated with the current window.

The CoreInputView object associated with the current window.

Gets a CoreInputView object associated with the view with the specified context identifier.

The context identifier of the view to get the CoreInputView for. A CoreInputView for the specified context identifier.

Attempts to hide (if visible) the input pane associated with the CoreInputView pane.

**true** if the request to show the input pane was accepted; otherwise **false**.

Attempts to hide (if visible) the input pane associated with the CoreInputView.

**true** if the request to show the input pane was accepted; otherwise **false**.

Attempts to show (if hidden) the input pane associated with the CoreInputView.

**true** if the request to show the input pane was accepted; otherwise **false**.

Attempts to show (if hidden) the specified type of input pane associated with the CoreInputView.

CoreInputViewKind **true** if the request to show the input pane was accepted; otherwise **false**.

Attempts to show (if hidden) the CoreInputView pane.

**true** if the request to show the input pane was accepted; otherwise **false**.

Attempts to move focus from the application UI to the input pane.

The rectangle, in client coordinates, representing the previously focused UI element. Specified in device-independent pixels (DIP). The direction of navigation. If the input pane is not located in the specified direction, this method fails and returns false. True, if the input pane received focus; otherwise, false.

Contains event data for the PrimaryViewHiding event.

Attempts to cancel the PrimaryViewHiding event of the input pane associated with the CoreInputView pane (if input pane is visible).

Defines the values for specifying a preferred view for the input pane.

Show the default input pane view.

Show the emoji pane view. If it is not available, it will show the emoji view of the software keyboard.

Show the handwriting pane view. If it is not available, it will show the software keyboard.

Show the software keyboard view.

Represents a single input pane currently occluding the app.

Gets the bounding rect of the occluding input pane (and associated UI).

The rectangle, in client coordinates, representing the region of the app window hidden behind the pane. Specified in device-independent pixels (DIP).

The type of occluding input pane (and associated UI).

A value from the CoreInputViewOcclusionKind enumeration that indicates the type of input pane supported by the CoreInputViewOcclusion object.

Specifies the types of input panes supported by the CoreInputViewOcclusion object.

Docked panes such as a Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel**.

Undocked panes such as a toolbar, or a Soft Input Panel (SIP) like the **Touch keyboard and handwriting panel**.

Floating panes such as an inline Ink or Input Method Editor (IME) candidate window.

Contains event data for the OcclusionsChanged event.

Gets or sets a value that marks the event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the event handled. **false** to leave the event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the collection of input panes (and associated UI) currently occluding the app.

The CoreInputViewOcclusion collection.

Contains event data for the PrimaryViewShowing event.

Attempts to cancel the PrimaryViewShowing event of the input pane associated with the CoreInputView pane (if input pane is visible).

Contains event data for the XYFocusTransferringFromPrimaryView event.

Gets the direction of focus navigation relative to the input pane.

One of the values from CoreInputViewXYFocusTransferDirection.

Gets or sets whether the input pane remains visible when the UI element loses focus.

True, if the input pane remains visible; otherwise, false. The default is true.

Gets the bounding rect of the originally focused element.

The bounding rect of the focused input pane element for the TryTransferXYFocusToPrimaryView method, or the bounding rect of the focused UI element in the application for the XYFocusTransferringFromPrimaryView event.

Gets or sets a value that marks the XYFocusTransferringFromPrimaryView event as handled.

Set the value to true on successful focus navigation. The default is false.

Specifies the direction of focus navigation relative to the input pane.

Focus movement is do

Focus movement is to the left.

Focus movement is to the right.

Focus movement is up.

Provides access to the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

Retrieves the default UISettingsController with access to **Ease of Access** display settings (Settings -> Ease of Access -> Display).

An asynchronous operation that completes with a UISettingsController.

Turn complex window display effects on or off through the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

True, if enabled. Otherwise, false.

Turn window animation effects on or off through the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

True, if enabled. Otherwise, false.

Turn automatic hiding of scroll bars on or off through the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

True, if enabled. Otherwise, false.

Set the amount of time that notifications are shown through the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

The amount of time notifications are shown, in seconds.

Set the text scale factor through the **Ease of Access** display settings (Settings -> Ease of Access -> Display).

The text scale factor, in percent (100-225).

Manages delayed activation for an app.

Notifies the system that the app has set up its state and initial UI and is ready to be displayed.

Represents a method that handles the app activation event.

The sender. The event information. The data type depends on why the app was activated. For a list of possible data types, see the ActivationKind enumeration.

Manages an app activation operation.

Requests that the completion of app activation be delayed.

The activation deferral object.

Makes all data available from the IBackgroundTask.Run method available to your event handler when your app is activated by a background trigger.

Gets the background task that activated the app.

The background task that activated the app.

Provides info when a background task activates the app.

The object that triggered the event. Information about the event.

Provides data when an app begins running in the background.

Requests a delay before the app begins running in the background.

A deferral that delays the app from running in the background.

Represents a method that handles the entered background event.

The object that fired the event. Information about the event.

Manages the document source for app printing.

Gets and sets the bottom margin of the document source.

The bottom margin of the document source.

Gets and sets the content of the document source to print.

The content of the document source to print.

Gets and sets a value that controls whether header and footer are enabled in the document source.

A Boolean value that indicates whether header and footer are enabled in the document source. **TRUE** indicates enabled and **FALSE** indicates disabled.

Gets and sets the left margin of the document source.

The left margin of the document source.

Gets the range of pages that prints.

The range of pages that prints.

Gets and sets the size of the document source by percentage.

The size of the document source by percentage.

Gets and sets the right margin of the document source.

The right margin of the document source.

Gets and sets a value that controls whether content shrinks to fit the document source.

A Boolean value that indicates whether content shrinks to fit the document source. **TRUE** indicates content shrinks to fit and **FALSE** otherwise. This property is ignored if the PercentScale property is set.

Gets and sets the top margin of the document source.

The top margin of the document source.

Performs app-defined tasks that are associated with freeing, releasing, or resetting resources that were allocated for the document source.

Tries to set the page range of the document source.

The page range to set. A Boolean value that indicates whether trySetPageRange set the page range in *strPageRange*. **TRUE** indicates the page range was set and **FALSE** otherwise.

Manages delayed activation for an app.

Gets the app activation operation.

The activation operation.

Provides access to an instance of a background task.

Gets or sets the success value for the background task. The success value is what is returned to the foreground instance of your app in the completed event.

An app can set this property to **false** to indicate that the background task has failed. Otherwise this property is always **true.**

Provides data for an app navigation event.

Gets the app navigation operation.

The app navigation operation.

Provides data when an app is about to stop running in the background.

Requests a delay before the app stops running in the background.

A deferral that delays the app from leaving the background.

Represents a method that handles the leaving background event.

The object that fired the event. Information about the event.

Represents a method that handles the app navigation event.

The sender. The event information.

Provides info when a new WebUIView is created.

Gets info about the activated event that caused the view to be created.

An object that provides info about the app's activation.

Gets the web UI view that triggered the event.

The view that triggered the event.

Specifies the content that HtmlPrintDocumentSource.content prints.

Print all pages.

Print the current page.

Print the current selection of pages.

Print a custom page range.

Represents a method that handles the app resumption event.

The sender.

Manages delayed suspension for an app. GetDeferral

Notifies the system that the app has saved its data and is ready to be suspended.

Provides data for an app suspension event.

Gets the app suspension operation.

The suspension operation.

Represents a method that handles the app suspension event.

The sender. The event data.

Manages an app suspension operation.

Gets the time remaining before a delayed app suspension operation continues.

The time remaining.

Requests that the app suspension operation be delayed.

The suspension deferral.

Enables an app to receive notifications related to the lifetime of the app.

Occurs when the app is activated.

Invoked when the application is activated in the background.

Occurs when the app has begins running in the background (no UI is shown for the app).

Occurs when the app is about to leave the background and before the app's UI is shown.

Occurs when the app is navigating.

Occurs when the system creates a new view for the app.

Occurs when the app is resuming.

Occurs when the app is suspending.

Specifies whether pre-launching is enabled.

**true** to enable pre-launching; otherwise, **false**.

Attempts to programatically restart the application.

Requests that the system restarts the app in the context of a specific user.

The target user. The app will be restarted in the context of this user. Launch arguments to pass to the app when it restarts. An asynchronous operation that returns an AppRestartFailureReason object when it completes.

Provides data when an app is activated to add an appointment to the user’s calendar.

Gets the app activated operation.

The activation operation.

Gets the appointment that is provided to the app when the user tries to add it.

The appointment that is added.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to remove an appointment from the user’s calendar.

Gets the app activated operation.

The activation operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the appointment that is provided to the app when the user tries to remove it.

The appointment that is removed.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to replace an appointment in the user’s calendar.

Gets the app activated operation.

The activation operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the appointment that is provided to the app when the user tries to replace it.

The appointment that is replaced.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to show the details of an appointment.

Gets the app activation operation.

The activated operation.

Gets the start date of the appointment instance for which the app should display details.

The start date of the appointment instance for which the app should display details.

Gets the activation type.

One of the enumeration values.

Gets the local identifier of the appointment for which the app should display details.

The local identifier of the appointment for which the app should display details.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the roaming identifier of the appointment for which the app should display details.

The roaming identifier of the appointment for which the app should display details.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Provides data when an app is activated to show a specified time frame on the user’s calendar.

Gets the app activated operation.

The activation operation.

Gets the duration of the time frame to be shown.

The duration of the time frame.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the starting date and time of the time frame to be shown.

The starting date and time of the time frame.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action to be performed by the appointments provider.

The action to be performed by the appointments provider.

Represents an instance of a background task that has been triggered to run.

Gets the current background task.

The current background task. This property can only be accessed in the context of a background task. This property is null in a foreground app.

Provides access to an instance of a background task.

Gets the instance ID of the background task instance.

A unique identifier for the background task instance. This identifier is generated by the system when the instance is created.

Gets or sets progress status for a background task instance.

A value defined by the application to indicate the task's progress.

Gets or sets the success value for the background task. The success value is what is returned to the foreground instance of your app in the completed event.

An app can set this property to **false** to indicate that the background task has failed. Otherwise this property is always **true.**

Gets the number of times resource management policy caused the background task to be suspended.

The number of times the background task has been suspended.

Gets access to the registered background task for this background task instance.

An interface that provides access to the registered background task.

Gets additional information associated with a background task instance.

Represents additional information for the background task. If the background task is triggered by a mobile network operator notification, this property is an instance of a NetworkOperatorNotificationEventDetails class. If the background task is triggered by a system event or time event, this property is not used.

Attaches a cancellation event handler to the background task instance.

Informs the system that the background task might continue to perform work after the IBackgroundTask.Run method returns. This method is not applicable to JavaScript background tasks.

A background task deferral.

Provides event info when a barcode scanner preview activates the app.

Gets the object that manages the app's activation.

An object that manages the app's activation.

Gets a connection ID used to match the service connection.

The connection ID used to match the service connection.

Gets the type of action that activated the app.

The type of action that activated the app.

Gets the execution state of the app before it was activated.

The app's previous execution state.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user for the barcode scanner preview.

The user who activated the app.

Provides information about the activated event that fires when the user saves or opens a file that needs updates from the app.

Gets the app activated operation.

The activation operation.

Gets the letterbox UI of the file picker that is displayed when a file needs updates from the app.

The letterbox UI of the file picker that is displayed when a file needs updates from the app.

Gets the activation type.

The activationKind.cachedFileUpdater enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information, such as the command-line arguments, when an app is activated from the command line.

Gets info about the activation of the app such as what arguments were provided and the current directory path.

The activation info.

Gets the type of activation that launched the app.

The activation kind.

Gets info about the activation of the app such as what arguments were provided and the current directory path.

The activation info.

Gets the execution state of the app before it was activated.

The execution state before the app was activated.

Gets info about the transition from the splash screen to the activated app.

The splash screen transition info.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides data when an app is activated because it uses the Contact Panel.

Gets the operation that activated the app.

The operation that activated the app.

Gets the selected contact from the Contact Panel.

The selected contact.

Gets the contact panel.

The contact panel.

Gets the activation type.

The ActivationKind.Contact enumeration value.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

An object that provides splash screen information.

Gets the user the app was activated for.

The user the app was activated for.

Provides information for a device that invokes AutoPlay.

Gets the app activated operation.

The activation operation.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the device identifier for the device that invoked AutoPlay.

The device identifier for the device that invoked AutoPlay.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action associated with the activated device.

The action associated with the activated device.

Provides information for a device that invokes pairing.

Gets the app activated operation.

The activation operation.

Gets info about the device that triggered the operation.

Info about the device that triggered the operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user the app was activated for.

The user the app was activated for.

Provides data when an app is activated from another app by using the DIAL protocol.

Gets the app activated operation.

The activation operation.

Gets the name of the app that invoked the dial receiver app.

The name of the app that invoked the dial receiver app.

Gets the arguments that are passed to the app during its launch activation.

The list of arguments.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the identifier of the source tile that launched the app.

The ID of the app tile that launched the app.

Gets the user the app was activated for.

The user the app was activated for.

Provides data when an app is activated because it is the app associated with a file.

Gets the app activation operation.

The activation operation.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the files for which the app was activated.

The StorageFile objects representing the files being passed to the app.

Gets the activation type.

One of the enumeration values.

Gets the neighboring files of the files for which the app was activated.

The StorageFile objects that represent the neighboring files of the files being passed to the app.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets the action associated with the activated file.

The action.

Provides information about an activated event that fires when the user tries to pick files or folders that are provided by the app.

Gets the app activated operation.

The activation operation.

Gets the family name of the caller's package.

The family name of the caller's package

Gets the letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

The letterbox UI of the file picker that is displayed when the user wants to pick files or folders that are provided by the app.

Gets the activation type.

The activationKind.fileOpenPicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a file open picker operation.

WebUIFileOpenPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the app activation operation.

The activated operation.

Gets a set of values populated by the app before a FileOpenPicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FileOpenPicker operation that deactivates the app.

Gets the files for which the app was activated.

The StorageFile objects representing the files being passed to the app.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires when the user saves a file through the file picker and selects the app as the location.

Gets the app activated operation.

The activation operation.

Gets the family name of the caller's package.

The family name of the caller's package.

Gets the ID of the enterprise that owns the file.

The ID of the enterprise that owns the file.

Gets the letterbox UI of the file picker that is displayed when the user saves a file and selects the app as the save location.

The letterbox UI of the file picker that is displayed when the user saves a file and uses the app as the location.

Gets the activation type.

The activationKind.fileSavePicker enumeration value.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a file save picker operation.

WebUIFileSavePickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the app activation operation.

The activated operation.

Gets a set of values populated by the app before a FileSavePicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FileSavePicker operation that deactivates the app.

Gets the file for which the app was activated.

The StorageFile object representing the file being passed to the app.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information about an activated event that fires after the app was suspended for a folder picker operation.

WebUIFolderPickerContinuationEventArgs is deprecated and might not work on all platforms. For more info, see MSDN.

Gets the app activation operation.

The activated operation.

Gets a set of values populated by the app before a FolderPicker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a FolderPicker operation that deactivates the app.

Gets the folder selected by the user during the folder picker operation.

The folder selected by the user during the folder picker operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides event information when an app is launched.

Gets the app activated operation.

The activation operation.

Gets the arguments that are passed to the app during its launch activation.

The list of arguments.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the activation type.

One of the enumeration values.

Gets an indication about whether a pre-launch has been activated.

Indicates whether a pre-launch has been activated. **TRUE** indicates activated; otherwise, **FALSE**.

Gets the execution state of the app before this activation.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets additional information that is provided when the user launches your app from a tile. This will be **null** if the app is not launched from its tile or if the app is launched on a platform that doesn't support this property.

Information about the tile that launched the app.

Gets the ID of the source that was invoked to launch the application.

The ID of the tile.

Gets the user that the app was activated for.

The user that the app was activated for.

Represents arguments used when the lock screen is activated.

Gets the object that manages an app activation operation.

The object that manages an app activation operation.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets information about the app activation operation.

The information.

Gets and activation kind for the app activation operation.

The activation kind.

Gets the previous execution state.

The previous execution state of the app.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen.

Gets the user the app was activated for.

The user the app was activated for.

Provides data when an app is activated as part of a lock screen component.

Gets the operation that activated the app.

The operation that activated the app.

Gets the activation type.

The activation type.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Manages delayed navigation for an app.

Notifies the system that the app has set up its state and UI and is ready to be displayed after a top level navigation.

Provides data for an app navigation event.

Gets the app navigation operation.

The app navigation operation.

Manages an app navigation operation.

Requests that the completion of app navigation be delayed.

The navigated deferral object.

Provides data when an app is launched as part of a print workflow.

Gets the operation that activated the app.

The operation that activated the app.

Gets the activation type.

The activation type.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Provides data when an app is activated because it is the app associated with a URI scheme name.

Gets the app activation operation.

The activation operation.

Gets the family name of the caller's package.

The family name of the caller's package.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the data used for activation.

The data used for activation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the Uniform Resource Identifier (URI) for which the app was activated.

The Uniform Resource Identifier (URI).

Gets the user that the app was activated for.

The user that the app was activated for.

Describes the activation arguments when an app is launched via LaunchUriForResultsAsync.

Gets the app activation operation.

The activated operation.

Gets the family name of the caller's package.

The family name of the caller's package.

Gets the identifier for the currently shown app view.

The identifier for the currently shown app view.

Gets the data associated with the activation.

The data associated with the activation.

Gets the kind of activation.

The kind of activation.

Gets the previous execution state.

The previous state.

Gets info about the protocol for results operation that triggered the activation.

Info about the protocol for results operation that triggered the activation.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Gets the Uniform Resource Identifier (URI) for which the app was activated.

The Uniform Resource Identifier (URI) for which the app was activated.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides event information when a restricted app is launched.

Gets the app activated operation.

The activation operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets information about a shared context for the restricted launch.

The object that provides shared context information.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information for an application that is a target for share operations.

Gets the app activated operation.

The activation operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets information about data included in a share operation.

An object that includes the data included in a send operation.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information when an app is activated at device startup or user login.

Gets the operation that activated the app.

The operation that activated the app.

Gets the reason that this app is being activated.

The expected value is **ActivationKind.StartupTask**.

Gets the execution state of the app before it was activated.

The execution state before the app was activated.

Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the unique identifier for your task.

The unique identifier for your task.

Gets the user who launched the app.

The user who launched the app.

Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

Gets the app activation operation.

The app activation operation.

Gets the arguments that the app can retrieve after it is activated through an interactive toast notification.

The arguments that the app can retrieve after it is activated through an interactive toast notification. The value of this property is defined previously in the XML that describes the data to deliver for the toast notification. The following elements and attributes of that XML define the value:

Gets the kind of activation.

The kind of activation.

Gets the previous execution state of the app.

The previous execution state of the app.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The splash screen object.

Gets the user that the app was activated for.

The user that the app was activated for.

Gets a set of values that you can use to obtain the user input from an interactive toast notification.

A set of values that you can use to obtain the user input from an interactive toast notification. This information consists of pairs of keys and values, in which the keys are the identifiers for the input elements for which the user provided input and the values represent the input from the user. For input elements that specify that the type of the input is text, the value is the string that the user specified.

Provides data when an app is activated to manage user accounts.

Gets the operation that activated the app.

The operation that activated the app.

Gets the activation type.

The activation type.

Gets the user account provider operation.

The user account provider operation.

Gets the execution state of the app before it was activated.

The execution state of the app before it was activated.

Gets the splash screen object, which provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Represents a view (window) of the app to the application background script.

Gets a value that indicates whether there is at least one page in the backward navigation history.

**true** if the view can navigate backward; otherwise, **false**.

Gets a value that indicates whether there is at least one page in the forward navigation history.

**true** if the view can navigate forward; otherwise, **false**.

Gets a value that indicates whether the view contains an element that supports full screen.

**true** if the view contains an element that supports full screen display; otherwise, **false**.

Gets or sets the color to use as the view background when the HTML content does not specify a color.

The default background color to use when the HTML content does not specify a color.

Gets a collection of permission requests that are waiting to be granted or denied.

A collection of WebViewDeferredPermissionRequest objects that are waiting to be granted or denied.

Gets the title of the page currently displayed in the view.

The page title.

Gets a WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

A WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

Gets or sets the URI source of the HTML content to display in the control.

The URI source of the HTML content to display in the control.

Occurs when the view is activated.

Occurs when the view has been closed.

Occurs when the status of whether the view currently contains a full screen element or not changes.

Occurs when the view starts loading new content.

An event that is triggered when the view has finished parsing the current HTML content.

Occurs when a frame in the view begins loading new content.

Occurs when a frame in the view has finished parsing its current HTML content.

Occurs when the control has finished loading the current content or if the navigation has failed.

Occurs just before the view navigates to new content.

An event that is triggered periodically while the control executes JavaScript, letting you halt the script.

Occurs when the control has finished loading the current content or if the navigation has failed.

Occurs before the control navigates to new content.

Occurs when a user performs an action in the control that causes content to be opened in a new window.

Occurs when an action in the control requires that permission to be granted.

Occurs when the content contained in the control passes a string to the app using JavaScript.

Occurs when the control shows a warning page for content that was reported as unsafe by SmartScreen Filter.

Occurs when an attempt is made to navigate to a URI using a scheme that the control doesn't support.

An event that is triggered when the control attempts to download an unsupported file.

An event that is fired when an HTTP request is made.

Creates a URI that you can pass to NavigateToLocalStreamUri

A unique identifier for the content the URI is referencing. This defines the root of the URI. The path to the resource, relative to the root.

Creates an image of the current view contents and writes it to the specified stream.

The stream to write the image to. An asynchronous action to await the capture operation.

Asynchronously gets a DataPackage that contains the selected content within the control.

When this method completes, it returns the selected content as a DataPackage.

Returns the deferred permission request with the specified Id.

The Id of the deferred permission request. The deferred permission request with the specified Id.

Navigates to the previous page in the navigation history.

Navigates to the next page in the navigation history.

Executes the specified script function from the currently loaded HTML, with specific arguments, as an asynchronous action.

The name of the script function to invoke. A string array that packages arguments to the script function. The string result of the script invocation.

Loads the HTML content at the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) of the page to load.

Loads local web content at the specified URI using an IUriToStreamResolver.

The local HTML content to load. A resolver that converts the URI into a stream to load.

Loads the specified HTML content as a new document.

The HTML content to display in the control.

Navigates the control to a URI with a POST request and HTTP headers.

The request.

Reloads the current content in the control.

Halts the current control navigation or download.

Provides information about an activated event raised when the app is activated from a voice command.

Gets the app activation operation.

The activated operation.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the SpeechRecognitionResult object representing the voice command that activated the app.

The SpeechRecognitionResult object representing the voice commands that activated the app.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the user that the app was activated for.

The user that the app was activated for.

Represents the arguments involved in activated a web account provider.

Gets the activated operation.

The activated operation.

Gets the kind of activation.

The kind of activation.

Gets the web account provider operation.

The operation.

Gets the previous execution state of the app.

The execution state.

Gets the splash screen.

The splash screen.

Gets the user that the app was activated for.

The user that the app was activated for.

Provides information to an app that was launched after being suspended for a web authentication broker operation.

Gets the app activation operation.

The activated operation.

Gets a set of values populated by the app before a web authentication broker operation that deactivates the app in order to provide context when the app is activated.

A set of values populated by the app before a web authentication broker operation that deactivates the app.

Gets the activation type.

One of the enumeration values.

Gets the execution state of the app before it was activated.

One of the enumeration values.

Gets the splash screen object that provides information about the transition from the splash screen to the activated app.

The object that provides splash screen information.

Gets the WebAuthenticationResult object returned from the web authentication broker operation.

The result of the web authentication broker operation.

Represents a system-managed container for the content of an app.

Gets the app content currently attached to the window.

The app content currently attached to the window.

Gets the dispatcher queue for the app window.

The dispatcher queue for the app window.

Gets the frame for the app window.

The frame for the app window.

Gets a value that indicates whether the window can be seen on a display.

**true** if the window can be seen on a display; otherwise, **false**.

Gets or sets a string that identifies this window for tracking and saving state.

A string that identifies this window for tracking and saving state.

Gets the presenter for the app window.

The presenter for the app window.

Gets or sets the displayed title of the app window.

The displayed title of the app window.

Gets the title bar of the app window.

The title bar of the app window.

Gets the UI context for the app window.

The UI context for the app window.

Gets the windowing environment for the app window.

The windowing environment for the app window.

Occurs when a property of the app window has changed.

Occurs when the app window has been closed.

Occurs after the window starts to close, but before it is closed and before the Closed event occurs.

Clears any properties the system has saved for any window PersistedStateId for the given application.

Clears any properties the system has saved for the window with the specified ID for the given application.

The PersistedStateId for the view to be cleared.

Closes the app window.

Returns a IAsyncAction object that is used to control the asynchronous operation.

Returns the collection of display regions available for the app window.

The collection of display regions available for the app window.

Returns a placement object that describes the app window's display region, offset, and size.

A placement object that describes the app window's display region, offset, and size.

Makes a request to position the window next to the current view.

Makes a request to position the window next to the specified anchor window.

The window to position this window next to.

Makes a request to position the window at the specified offset relative to the current view.

The offset of the window relative to the current view.

Makes a request to position the window in the specified display region at the specified offset.

The display region to move the window to. The offset of the window in the display region.

Makes a request to position the window at the specified offset relative to the anchor window.

The window to position this window relative to. The offset of the window relative to the anchor window.

Makes a request to position the window in the specified display region.

The display region to move the window to.

Makes a request to set the window to the specified size.

The requested size.

Attempts to asynchronously create a new instance of AppWindow.

The new instance of AppWindow if it was created successfully.

Attempts to asynchronously show the current app window.

**true** if the window was shown successfully; otherwise, **false**.

Provides data for the AppWindow.Changed event.

Gets a value that indicates whether the available window presentations changed.

**true** if the available window presentations changed; otherwise, **false**.

Gets a value that indicates whether the display regions changed.

**true** if the display regions changed; otherwise, **false**.

Gets a value that indicates whether one or more properties of the AppWindow.Frame has changed.

**true** if a property of the AppWindow.Frame changed; otherwise, **false**.

Gets a value that indicates whether the size of the app window changed.

**true** if the size of the app window changed; otherwise, **false**.

Gets a value that indicates whether one or more properties of the AppWindow.TitleBar has changed.

**true** if a property of the AppWindow.TitleBar changed; otherwise, **false**.

Gets a value that indicates whether the AppWindow.IsVisible property changed.

**true** if the AppWindow.IsVisible property changed; otherwise, **false**.

Gets a value that indicates whether the AppWindow.WindowingEnvironment property changed.

**true** if the AppWindow.WindowingEnvironment property changed; otherwise, **false**.

Gets a value that indicates whether the applied window presentation has changed.

**true** if the applied window presentation changed; otherwise, **false**.

Provides data for the AppWindow.Closed event.

Gets a value that indicates how the closing of the app window was initiated.

A value of the enumeration that indicates how the closing of the app window was initiated.

Defines constants that specify how a window close operation was initiated.

The operation was initiated programmatically by code in the app.

The operation was initiated by something other than the user or app code.

The operation was initiated by the user.

Provides data for the AppWindow.CloseRequested event.

Gets or sets a value that indicates whether the close operation should be canceled.

**true** to cancel the close operation; otherwise, **false**. The default is **false**.

Gets a deferral object for managing asynchronous work done in the CloseRequested event handler.

A deferral object.

Represents the current frame that is applied around the window content.

Gets a list of drag visuals currently associated with the frame if any have been successfully set. The default system drag visual for the system drawn titlebar is not returned through this method.

A list of drag visuals currently associated with the frame if any have been successfully set.

Returns the style of frame used for the current window.

A value of the enumeration that specifies which frame style is used.

Sets the style of frame to use for the app window.

A value of the enumeration that specifies which frame style to use.

Defines constants that specify the style of frame used for the app window.

The system default frame style is used for the current window.

No frame is used for the current window.

Represents info about the placement of an app window.

Gets the display region for the app window.

The display region for the app window.

Gets the offset of the app window.

The offset of the app window.

Gets the size of the app window.

The size of the app window.

Represents the base configuration for an AppWindowPresenter.

Gets a value that indicates the kind of presentation the app window is using.

A value of the enumeration that indicates the kind of presentation the app window is using.

Defines constants that specify the kind of presentation the app window is using.

The app window is in compact overlay (picture-in-picture) mode.

The app window is using the default presentation mode with no specific presentation applied.

The app window is in full screen mode.

Displays an app window using a pre-defined configuration appropriate for the device it's shown on.

Gets the configuration info for the app window presenter.

The configuration info for the app window presenter.

Gets a value that indicates whether the kind of presentation is supported.

The kind of presentation. **true** if the AppWindowPresentationKind is supported; otherwise; **false**.

Makes a request to show the window using the specified presentation configuration.

The presentation configuration to use to show the app window. **true** if the request succeeds; otherwise, **false**.

Makes a request to show the window using the specified kind of presentation.

The kind of presentation to use to show the app window. **true** if the request succeeds; otherwise, **false**.

Represents the title bar of an app window.

Gets or sets the color of the title bar background.

The color of the title bar background. (See Color.)

Gets or sets the background color of the title bar buttons.

The background color of the title bar buttons. (See Color.)

Gets or sets the foreground color of the title bar buttons.

The foreground color of the title bar buttons. (See Color.)

Gets or sets the background color of a title bar button when the pointer is over it.

The background color of a title bar button when the pointer is over it. (See Color.)

Gets or sets the foreground color of a title bar button when the pointer is over it.

The foreground color of a title bar button when the pointer is over it. (See Color.)

Gets or sets the background color of a title bar button when it's inactive.

The background color of a title bar button when it's inactive. (See Color.)

Gets or sets the foreground color of a title bar button when it's inactive.

The foreground color of a title bar button when it's inactive. (See Color.)

Gets or sets the background color of a title bar button when it's pressed.

The background color of a title bar button when it's pressed. (See Color.)

Gets or sets the foreground color of a title bar button when it's pressed.

The foreground color of a title bar button when it's pressed. (See Color.)

Gets or sets a value that specifies whether this title bar should replace the default window title bar.

**true** to replace the default window title bar; otherwise, **false**. The default is **false**.

Gets or sets the color of the title bar foreground.

The color of the title bar foreground. (See Color.)

Gets or sets the color of the title bar background when it's inactive.

The color of the title bar background when it's inactive. (See Color.)

Gets or sets the color of the title bar foreground when it's inactive.

The color of the title bar foreground when it's inactive. (See Color.)

Gets a value that specifies whether this title bar is visible.

**true** if this title bar is visible; otherwise, **false**.

Returns the preferred visibility mode for the title bar.

A value of the enumeration that indicates the preferred visibility mode for the title bar.

Gets a list of title bar occlusions.

A list of title bar occlusions.

Sets the preferred visibility mode for the title bar.

A value of the enumeration that specifies the preferred visibility mode for the title bar.

Represents the system-reserved regions of the app window that will occlude app content if ExtendsContentIntoTitleBar is true.

Gets a rectangle that defines the width, height, and offset of the occlusion in app content visual relative coordinates.

A rectangle that defines the width, height, and offset of the occlusion in app content visual relative coordinates.

Defines constants that specify the preferred visibility of an AppWindowTitleBar.

The title bar is always hidden.

The title bar uses the system default visibility.

Represents the compact overlay configuration for an AppWindowPresenter.

Initializes a new instance of the CompactOverlayPresentationConfiguration class.

Represents the default configuration for an AppWindowPresenter.

Initializes a new instance of the DefaultPresentationConfiguration class.

Represents the region in which a view is able to be shown to a user on a logical display.

Gets the device ID for the monitor associated with the display region.

The device ID for the monitor associated with the display region.

Gets a value that indicates whether the display region can be seen.

**true** if the display region can be seen; otherwise, **false**.

Gets the windowing environment that this display region exists in.

The windowing environment that this display region exists in.

Gets the offset within the display coordinate space for this DisplayRegion.

The offset within the display coordinate space for this DisplayRegion.

Gets the width and height of the display region.

The width and height of the display region.

Occurs when a property of the display region has changed.

Represents the full screen configuration for an AppWindowPresenter.

Initializes a new instance of the FullScreenPresentationConfiguration class.

Gets or sets a value that indicates whether Exclusive Fullscreen Mode is on.

**true** if the presentation is in Exclusive Fullscreen Mode; otherwise, **false**.

Provides information about the system environments that are available to display the app.

Gets a value that indicates whether the current windowing environment is available to the app.

**true** if the current windowing environment is available to the user; otherwise, **false**.

Gets a value that describes the current windowing environment.

A value that describes the current windowing environment.

Occurs when a property of the windowing environment has changed.

Retrieves a collection of all existing windowing environments in the system.

A collection of all existing windowing environments in the system.

Retrieves a collection of all existing windowing environments in the system of the specified kind.

The kind of windowing environment to find. A collection of all existing windowing environments in the system of the specified kind.

Retrieves the collection of display regions for this windowing environment.

The collection of display regions for this windowing environment.

Provides event data.

Gets the windowing environment.

The windowing environment.

Provides data for the WindowingEnvironment.Changed event.

Defines constants the specify what kind a windowing environment is.

The windowing environment supports windows that overlap.

The windowing environment supports only windows that do not overlap.

The windowing environment is not known.

Provides event data.

Gets the windowing environment.

The windowing environment.

Provides preview APIs for handling and managing the windows associated with the active app.

Sets the preferred minimum size for the specified AppWindow.

The app window to set the size for. The preferred minimum size for the window.

Represents a declarative rule that applies visual states based on window properties.

Initializes a new instance of the AdaptiveTrigger class

Gets or sets the minimum window height at which the VisualState should be applied.

The minimum window height (in effective pixels) at which the VisualState should be applied.

Identifies the MinWindowHeight dependency property.

The identifier for the MinWindowHeight dependency property.

Gets or sets the minimum window width at which the VisualState should be applied.

The minimum window width (in effective pixels) at which the VisualState should be applied.

Identifies the MinWindowWidth dependency property.

The identifier for the MinWindowWidth dependency property.

Encapsulates the app and its available services.

Initializes a new instance of the Application class.

Gets the Application object for the current application.

The Application object for the current application.

Gets an object that declares how the app behaves when run in a debug environment.

An object that declares how the app behaves when run in a debug environment.

Gets or sets the type of visual feedback that an app can use to indicate the UI element with focus.

The type of visual feedback used to indicate the UI element with focus. The default value depends on the operating system.

Gets or sets a value that indicates whether the framework automatically adjusts visual properties when high contrast themes are enabled.

A value of the enumeration that indicates whether the framework automatically adjusts visual properties when high contrast themes are enabled. The default is **Auto**.

Gets or sets a value that determines the light-dark preference for the overall theme of an app.

A value of the enumeration. The initial value is the default theme set by the user in Windows settings.

Gets or sets whether a UWP app supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as an Xbox gamepad or remote control. (All nested elements inherit this behavior.)

The pointer emulation mode. The default is Auto (the default system experience for the input device).

Gets a collection of application-scoped resources, such as styles, templates, and brushes.

A ResourceDictionary object that contains zero or more application-scoped resources.

Occurs when the app moves from the foreground to the background.

Occurs when the app moves from the background to the foreground.

Occurs when the application transitions from Suspended state to Running state.

Occurs when the application transitions to Suspended state from some other state.

Occurs when an exception can be handled by app code, as forwarded from a native-level Windows Runtime error. Apps can mark the occurrence as handled in event data.

Shuts down the app.

Loads a XAML file that is located at the specified relative location, and converts it to an instance of the object that is specified by the root element of the XAML file.

An object of the same type as the root element of the XAML content to be loaded. An object describing the Uniform Resource Identifier (URI) path to the resource to load.

Loads a XAML file that is located at the specified relative location, and converts it to an instance of the object that is specified by the root element of the XAML file.

An object of the same type as the root element of the XAML content to be loaded. An object describing the Uniform Resource Identifier (URI) path to the resource to load. A value of the enumeration.

Invoked when the application is activated by some means other than normal launching.

Event data for the event.

Invoked when the application is activated in the background.

Data about the background activation.

Invoked when the application is activated due to an activation contract with ActivationKind as **CachedFileUpdater**.

Event data for the event.

Invoked when the application is activated through file-open.

Event data for the event.

Invoked when the application is activated through file-open dialog association.

Event data for the event.

Invoked when the application is activated through file-save dialog association.

Event data for the event.

Invoked when the application is launched. Override this method to perform application initialization and to display initial content in the associated Window.

Event data for the event.

Invoked when the application is activated through a search association.

Event data for the event.

Invoked when the application is activated through sharing association.

Event data for the event.

Invoked when the application creates a window.

Event data for the event.

Provides the entry point and requests initialization of the application. Use the callback to instantiate the Application class.

The callback that should be invoked during the initialization sequence.

Defines constants that specify whether the framework automatically adjusts visual properties for the app when high contrast themes are enabled.

Visuals are automatically adjusted when high contrast is enabled.

No automatic adjustments are made to visuals.

Represents the callback that should be invoked during the initialization sequence.

Parameters that convey information for custom startup initialization.

A class that developers should derive from in order to pass information for a custom initialization sequence, in cases where both an Application subclass is present and the entry point Start call is adjusted to pass the information.

Specifies the interaction experiences for non-pointer devices such as an Xbox controller or remote control.

The default system experience for the input device.

A pointer-like interaction experience using a mouse cursor that can be freely moved using non-pointer input devices.

Declares the theme preference for an app.

Use the **Dark** default theme.

Use the **Light** default theme.

Defines constants that identify text attributes of a Microsoft UI Automation text range.

Identifies the **AnimationStyle** text attribute, which specifies the type of animation applied to the text. This attribute is specified as a value of the AutomationAnimationStyle enumeration.

Identifies the **AnnotationObjects** text attribute.

Identifies the **AnnotationTypes** text attribute, which maintains a list of annotation type identifiers for a range of text. This attribute is specified as a value of the AnnotationType enumeration.

Identifies the **BackgroundColor** text attribute, which specifies the background color of the text.

Identifies the **BulletStyle** text attribute, which specifies the style of bullets used in the text range. This attribute is specified as a value of the AutomationBulletStyle enumeration.

Identifies the **CapStyle** text attribute, which specifies the capitalization style for the text.

Identifies the **CaretBidiMode** text attribute, which indicates the direction of text flow in the text range. This attribute is specified as a value of the AutomationCaretBidiMode enumeration.

Identifies the **CaretPosition** text attribute, which indicates whether the caret is at the beginning or the end of a line of text in the text range. This attribute is specified as a value of the AutomationCaretPosition enumeration.

Identifies the **Culture** text attribute, which specifies the locale of the text by locale identifier (LCID).

Identifies the **FontName** text attribute, which specifies the name of the font. Examples: "Arial Black"; "Arial Narrow". The font name string is not localized.

Identifies the **FontSize** text attribute, which specifies the point size of the font.

Identifies the **FontWeight** text attribute, which specifies the relative stroke, thickness, or boldness of the font.

Identifies the **ForegroundColor** text attribute, which specifies the foreground color of the text.

Identifies the **HorizontalTextAlignment** text attribute, which specifies how the text is aligned horizontally.

Identifies the **IndentationFirstLine** text attribute, which specifies how far, in points, to indent the first line of a paragraph.

Identifies the **IndentationLeading** text attribute, which specifies the leading indentation, in points.

Identifies the **IndentationTrailing** text attribute, which specifies the trailing indentation, in points.

Identifies the **IsActive** text attribute, which indicates whether the control that contains the text range has the keyboard focus (**true**) or not (**false**).

Identifies the **IsHidden** text attribute, which indicates whether the text is hidden (**true**) or visible (**false**).

Identifies the **IsItalic** text attribute, which indicates whether the text is italic (**true**) or not (**false**).

Identifies the **IsReadOnly** text attribute, which indicates whether the text is read-only (**true**) or can be modified (**false**).

Identifies the **IsSubscript** text attribute, which indicates whether the text is subscript (**true**) or not (**false**).

Identifies the **IsSuperscript** text attribute, which indicates whether the text is subscript (**true**) or not (**false**).

Identifies the **Link** text attribute, which contains the ITextRangeProvider interface of the text range that is the target of an internal link in a document.

Identifies the **MarginBottom** text attribute, which specifies the size, in points, of the bottom margin applied to the page associated with the text range.

Identifies the **MarginLeading** text attribute, which specifies the size, in points, of the leading margin applied to the page associated with the text range.

Identifies the **MarginTop** text attribute, which specifies the size, in points, of the top margin applied to the page associated with the text range.

Identifies the **MarginTrailing** text attribute, which specifies the size, in points, of the trailing margin applied to the page associated with the text range.

Identifies the **OutlineStyles** text attribute, which specifies the outline style of the text. This attribute is specified as a value of the AutomationOutlineStyles enumeration.

Identifies the **OverlineColor** text attribute, which specifies the color of the overline text decoration.

Identifies the **OverlineStyle** text attribute, which specifies the style of the overline text decoration. This attribute is specified as a value of the AutomationTextDecorationLineStyle enumeration.

Identifies the **SelectionActiveEnd** text attribute, which indicates the location of the caret relative to a text range that represents the currently selected text. This attribute is specified as a value from the AutomationActiveEnd enumeration.

Identifies the **StrikethroughColor** text attribute, which specifies the color of the strikethrough text decoration.

Identifies the **StrikethroughStyle** text attribute, which specifies the style of the strikethrough text decoration. This attribute is specified as a value of the AutomationTextDecorationLineStyle enumeration.

Identifies the **StyleId** text attribute, which indicates the text styles in use for a text range. This attribute is specified as a value of the AutomationStyleId enumeration.

Identifies the **StyleName** text attribute, which identifies the localized name of the text style in use for a text range.

Identifies the **Tabs** text attribute, which is an array specifying the tab stops for the text range. Each array element specifies a distance, in points, from the leading margin.

Identifies the **TextFlowDirections** text attribute, which specifies the direction of text flow. This attribute is specified as a combination of values of the AutomationFlowDirections enumeration.

Identifies the **UnderlineColor** text attribute, which specifies the color of the underline text decoration.

Identifies the **UnderlineStyle** text attribute, which specifies the style of the underline text decoration. This attribute is specified as a value of the AutomationTextDecorationLineStyle enumeration.

Provides event data for the DebugSettings.BindingFailed event.

Gets the explanation of the binding failure.

The reason the binding failed.

Represents the method that will handle the DebugSettings.BindingFailed event.

The source of the event. The event data.

Represents the options that can be applied when an element is brought into view.

Initializes a new instance of the BringIntoViewOptions class.

Gets or sets a value that indicates whether to use animation when the element is brought into view.

**true** to use animation; otherwise, **false**. The default is **true**.

Controls the positioning of the vertical axis of the TargetRect with respect to the vertical axis of the viewport. The value is clamped from 0.0f to 1.0f with 0.0f representing the left vertical edge and 1.0f representing the right vertical edge. By default this is set to 0.0f.

A value that specifies the positioning of the vertical axis of the TargetRect with respect to the vertical axis of the viewport. The default is 0.0f.

Gets or sets the horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.

The horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.

Gets or sets the area of an element to bring into view.

A rectangle that defines the area of an element to bring into view.

Controls the positioning of the horizontal axis of the TargetRect with respect to the horizontal axis of the viewport. The value is clamped from 0.0f to 1.0f with 0.0f representing the top horizontal edge and 1.0f representing the bottom horizontal edge. By default this is set to 0.0f.

A value that specifies the positioning of the horizontal axis of the TargetRect with respect to the horizontal axis of the viewport. The default is 0.0f.

Gets or sets the vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.

The vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.

Provides data for the UIElement.BringIntoViewRequested event.

Gets or sets a value that specifies whether the scrolling should be animated.

**true** to animate the scrolling; otherwise, **false**.

Gets or sets a value that marks the routed event as handled. A **true** value prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the requested horizontal alignment ratio which controls the alignment of the vertical axis of the TargetRect with respect to the vertical axis of the viewport.

The requested horizontal alignment ratio between 0.0 and 1.0, or NaN. See Remarks.

Gets or sets the horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.

The horizontal distance to add to the viewport-relative position of the TargetRect after satisfying the requested HorizontalAlignmentRatio.

Gets or sets the element that should be made visible in response to the event.

The element that should be made visible in response to the event.

Gets or sets the Rect in the TargetElement’s coordinate space to bring into view.

The Rect in the TargetElement’s coordinate space to bring into view.

Gets the requested vertical alignment ratio which controls the alignment of the horizontal axis of the TargetRect with respect to the horizontal axis of the viewport.

The requested vertical alignment ratio between 0.0 and 1.0, or NaN. See Remarks.

Gets or sets the vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.

The vertical distance to add to the viewport-relative position of the TargetRect after satisfying the requested VerticalAlignmentRatio.

Provides the animated transition behavior when an element's brush changes. Currently limited to changes between SolidColorBrush objects.

Initializes a new instance of the BrushTransition class.

Gets or sets the duration of the transition.

The duration of the transition.

Represents a specialized resource dictionary that contains color resources used by XAML elements.

Initializes a new instance of the ColorPaletteResources class.

Gets or sets the Accent color value.

The Accent color value.

Gets or sets the AltHigh color value.

The AltHigh color value.

Gets or sets the AltLow color value.

The AltLow color value.

Gets or sets the AltMedium color value.

The AltMedium color value.

Gets or sets the AltMediumHigh color value.

The AltMediumHigh color value.

Gets or sets the AltMediumLow color value.

The AltMediumLow color value.

Gets or sets the BaseHigh color value.

The BaseHigh color value.

Gets or sets the BaseLow color value.

The BaseLow color value.

Gets or sets the BaseMedium color value.

The BaseMedium color value.

Gets or sets the BaseMediumHigh color value.

The BaseMediumHigh color value.

Gets or sets the BaseMediumLow color value.

The BaseMediumLow color value.

Gets or sets the ChromeAltLow color value.

The ChromeAltLow color value.

Gets or sets the ChromeBlackHigh color value.

The ChromeBlackHigh color value.

Gets or sets the ChromeBlackLow color value.

The ChromeBlackLow color value.

Gets or sets the ChromeBlackMedium color value.

The ChromeBlackMedium color value.

Gets or sets the ChromeBlackMediumLow color value.

The ChromeBlackMediumLow color value.

Gets or sets the ChromeDisabledHigh color value.

The ChromeDisabledHigh color value.

Gets or sets the ChromeDisabledLow color value.

The ChromeDisabledLow color value.

Gets or sets the ChromeGray color value.

The ChromeGray color value.

Gets or sets the ChromeHigh color value.

The ChromeHigh color value.

Gets or sets the ChromeLow color value.

The ChromeLow color value.

Gets or sets the ChromeMedium color value.

The ChromeMedium color value.

Gets or sets the ChromeMediumLow color value.

The ChromeMediumLow color value.

Gets or sets the ChromeWhite color value.

The ChromeWhite color value.

Gets or sets the ErrorText color value.

The ErrorText color value.

Gets or sets the ListLow color value.

The ListLow color value.

Gets or sets the ListMedium color value.

The ListMedium color value.

Describes the characteristics of a rounded corner, such as can be applied to a Border.

The radius of rounding, in pixels, of the lower-left corner of the object where a CornerRadius is applied.

The radius of rounding, in pixels, of the lower-right corner of the object where a CornerRadius is applied.

The radius of rounding, in pixels, of the upper-left corner of the object where a CornerRadius is applied.

The radius of rounding, in pixels, of the upper-right corner of the object where a CornerRadius is applied.

Provides basic utility methods for processing CornerRadius values. C# and Microsoft Visual Basic code should use methods of CornerRadius instead.

Generates a CornerRadius value from element values. C# and Microsoft Visual Basic code should use the CornerRadius(Double,Double,Double,Double) constructor instead.

The initial **TopLeft** value. The initial **TopRight** value. The initial **BottomRight** value. The initial **BottomLeft** value. The created CornerRadius.

Creates a new CornerRadius value that has a uniform radius value for each of its elements. C# and Microsoft Visual Basic code should use the CornerRadius(Double) constructor instead.

The uniform radius value to set. See CornerRadius. The created CornerRadius.

Represents the method that can be invoked as part of a PropertyMetadata constructor to defer definition of a dependency property default value.

The desired default value.

Provides data for the DataContextChanged event.

Gets or sets a value that influences whether another DataContextChanged event should be fired from child elements that inherit the DataContext value and detect that the value has changed.

**true** to prevent further DataContextChanged events from being fired for each child FrameworkElement that inherits the DataContext value. You would do this to indicate to other handlers that the necessary logic for responding to the data context change has already been performed. **false** to permit the event to be fired by each immediate child FrameworkElement in the element tree that detects a change to the inherited DataContext value. The default is **false**.

Gets the new DataContext value for the element where the DataContextChanged event fired.

An object representing the new DataContext value for the element where the DataContextChanged event fired.

Describes the visual structure of a data object. Use data binding for specific elements in the template that display the data values.

Initializes a new instance of the DataTemplate class.

Identifies the ExtensionInstance XAML attached property.

The identifier for the ExtensionInstance XAML attached property.

Creates or retrieves an existing instance of the UIElement object declared in the DataTemplate.

An instance of ElementFactoryGetArgs. An instance of the root UIElement declared in the DataTemplate or **null** if the root of the DataTemplate is not a UIElement.

Gets the value of the DataTemplate.ExtensionInstance XAML attached property for the target element.

The object from which the property value is read. The DataTemplate.ExtensionInstance XAML attached property value of the specified object.

Creates the UIElement objects in the DataTemplate.

The root UIElement of the DataTemplate.

Recycles a UIElement that was previously retrieved using GetElement.

An instance of ElementFactoryRecycleArgs.

Sets the value of the DataTemplate.ExtensionInstance XAML attached property for a target element.

The object to which the property value is written. The value to set.

Represents the resource key for the DataTemplate class.

Initializes a new instance of the DataTemplateKey class.

Initializes a new instance of the DataTemplateKey class with the specified type.

The type for which this template is designed.

Gets or sets the type for which the template is designed.

The type of object that the template is used to display, or a string that specifies the XML tag name for the XML data that the template is used to display.

Declares how certain aspects of the app behave when it is run in a debug environment

Gets or sets a value that indicates whether to display frame-rate and per-frame CPU usage info. These display as an overlay of counters in the window chrome while the app runs.

**true** to display the overlay debug counters; otherwise, **false**.

Gets or sets a value that indicates whether to highlight areas of the app UI surface that are being redrawn each frame.

**true** to highlight redraw regions. **false** to not highlight redraw regions. The default is **false**.

Gets or sets a value that indicates whether XAML errors cause an immediate FailFast rather than returning an error.

**true** if XAML errors cause an immediate FailFast rather than returning an error; otherwise, **false**. The default is **false**.

Gets or sets a value that indicates whether to engage the binding tracing feature of Microsoft Visual Studio when the app runs.

**true** to engage the binding tracing feature of Microsoft Visual Studio; otherwise, **false**.

Gets or sets a value that enables a debug setting that visualizes overdraw operations. This visualization is useful during application development for detecting layout, animation, and other operations that are graphics processing intensive.

**true** to enable the visualization, otherwise, **false**.

Gets or sets a value that indicates whether to engage the text performance visualization feature of Microsoft Visual Studio when the app runs.

**true** to engage the text performance visualization feature of Microsoft Visual Studio; otherwise, **false**.

Occurs when a Binding cannot be resolved.

Represents an object that participates in the dependency property system. DependencyObject is the immediate base class of many important UI-related classes, such as UIElement, Geometry, FrameworkTemplate, Style, and ResourceDictionary. For more info on how DependencyObject supports dependency properties, see Dependency properties overview.

Provides base class initialization behavior for DependencyObject derived classes.

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

The CoreDispatcher that DependencyObject object is associated with, which represents the UI thread.

Clears the local value of a dependency property.

The DependencyProperty identifier of the property for which to clear the value.

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

The identifier for the desired dependency property. The returned base value.

Returns the current effective value of a dependency property from a DependencyObject.

The DependencyProperty identifier of the property for which to retrieve the value. Returns the current effective value.

Returns the local value of a dependency property, if a local value is set.

The DependencyProperty identifier of the property for which to retrieve the local value. Returns the local value, or returns the sentinel value UnsetValue if no local value is set.

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

The dependency property identifier of the property to register for property-changed notification. A callback based on the DependencyPropertyChangedCallback delegate, which the system invokes when the value of the specified property changes. A token that represents the callback, used to identify the callback in calls to UnregisterPropertyChangedCallback.

Sets the local value of a dependency property on a DependencyObject.

The identifier of the dependency property to set. The new local value.

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

The dependency property identifier of the property to unregister for property-changed notification. A token that represents the callback (returned by RegisterPropertyChangedCallback ).

Implements a practical collection class that can contain DependencyObject items.

Initializes a new instance of the DependencyObjectCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Occurs when the contents of the collection changes.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the DependencyObject located at the specified index.

The integer index for the value to retrieve. The DependencyObject value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items returned.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the DependencyObject value specified.

The index at which to set the value. The value to set.

Represents a dependency property that is registered with the dependency property system. Dependency properties provide support for value expressions, data binding, animation, and property change notification. For more info on how DependencyProperty values serve as identifiers for dependency properties, see Dependency properties overview.

Specifies a static value that is used by the property system rather than **null** to indicate that the property exists, but does not have its value set by the property system or by any app code.

The sentinel value for an unset value.

Retrieves the property metadata value for the dependency property as registered to a type. You specify the type you want info from as a type reference.

The name of the specific type from which to retrieve the dependency property metadata, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). A property metadata object.

Registers a dependency property with the specified property name, property type, owner type, and property metadata for the property. Use this method when defining or initializing a DependencyObject derived class that will own the registered dependency property.

The name of the dependency property to register. The type of the property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). The owner type that is registering the dependency property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). A property metadata instance. This can contain a PropertyChangedCallback implementation reference. A dependency property identifier that typically is stored in a public static read-only field in your DependencyObject derived class. The identifier is then used both by your own code and any third-party user code to reference the dependency property later, for operations such as setting its value programmatically or attaching a Binding in code.

Registers an attached dependency property with the specified property name, property type, owner type, and property metadata for the property.

The name of the dependency property to register. The type of the property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). The owner type that is registering the dependency property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). A property metadata instance. This can contain a PropertyChangedCallback implementation reference. A dependency property identifier that should be used to set the value of a public static read-only field in your class. That identifier is then used to reference the attached property later, for operations such as setting its value programmatically or attaching a Binding.

Represents the callback that is invoked when a property value changes, for property change notifications that are registered with the RegisterPropertyChangedCallback technique.

The object instance that holds the property to register for property-changed notification. The dependency property identifier of the property to register for property-changed notification.

Provides data for a PropertyChangedCallback implementation that is invoked when a dependency property changes its value. Also provides event data for the Control.IsEnabledChanged event and any other event that uses the DependencyPropertyChangedEventHandler delegate.

Gets the value of the dependency property after the reported change.

The dependency property value after the change.

Gets the value of the dependency property before the reported change.

The dependency property value before the change.

Gets the identifier for the dependency property where the value change occurred.

The identifier field of the dependency property where the value change occurred.

Represents the method that will handle events that occur when a DependencyProperty is changed on a particular DependencyObject implementation.

The source of the event (typically the object where the property changed). The event data.

Provides a timer that is integrated into the **Dispatcher** queue, which is processed at a specified interval of time and at a specified priority.

Initializes a new instance of the DispatcherTimer class.

Gets or sets the amount of time between timer ticks.

The amount of time between ticks. The default is a **TimeSpan**

Gets a value that indicates whether the timer is running.

**true** if the timer is enabled and running; otherwise, **false**.

Occurs when the timer interval has elapsed.

Starts the DispatcherTimer.

Stops the DispatcherTimer.

Provides data for drag-and-drop events.

Gets or sets a value that specifies which operations are allowed by the originator of the drag event.

A member of the DataPackageOperation enumeration that specifies which operations are allowed by the originator of the drag event.

Gets the allowed data package operations (none, move, copy, and/or link) for the drag and drop operation.

The allowed data operations.

Gets or sets a data object (DataPackage ) that contains the data associated with the corresponding drag event. This value is not useful in all event cases; specifically, the event must be handled by a valid drop target.

The data object that contains data payload that is associated with the corresponding drag event.

Gets a read-only copy of the Data object.

A read-only copy of the Data object.

Gets the visual representation of the data being dragged.

The visual representation of the data being dragged. The default is **null**.

Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.

**true** if the event is marked handled; otherwise, **false**. The default value is **false**.

Gets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.

One or more members of the DragDropModifiers flag enumeration.

Supports asynchronous drag-and-drop operations by creating and returning a DragOperationDeferral object.

A deferral object that you can use to identify when the generation of the data package is complete.

Returns a drop point that is relative to a specified UIElement.

The UIElement for which to get a relative drop point. A point in the coordinate system that is relative to the element specified in *relativeTo*.

Represents the method that will handle the DragEnter, DragLeave, DragOver, and Drop events of a UIElement.

The object where the event handler is attached. The event data.

Enables you to drag-and-drop content with a target app asynchronously.

Indicates that the content for an asynchronous drag-and-drop operation is ready for a target app.

Provides event data for the DragStarting event.

Gets or sets the allowed data package operations (none, move, copy, and/or link) for the drag and drop operation.

The allowed data operations.

Gets or sets a value that indicates whether the drag action should be canceled.

**true** to cancel the drag action; otherwise, **false**. The default is **false**.

Gets the data payload associated with a drag action.

The data payload. The default is an empty DataPackage.

Gets the visual representation of the data being dragged.

The visual representation of the data being dragged.

Supports asynchronous drag-and-drop operations by creating and returning a DragOperationDeferral object.

A deferral object that you can use to identify when the generation of the data package is complete.

Returns a drop point that is relative to a specified UIElement.

The UIElement for which to get a relative drop point. A point in the coordinate system that is relative to the element specified in *relativeTo*.

Provides the visual representation of the data being dragged at the start of a drag-and-drop operation.

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation.

The source image used to create the drag visual.

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

The source image used to create the drag visual. The relative position of the drag visual from the pointer.

Creates a system provided visual element that represents the format of the dragged data in a drag-and-drop operation, typically the icon of the default handler for the file format.

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation.

The source image used to create the drag visual.

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

The source image used to create the drag visual. The relative position of the drag visual from the pointer.

Provides the visual representation of the data being dragged during a drag-and-drop operation, including feedback from the drop target.

Gets or sets the caption text that overlays the drag visual. The text typically describes the drag-and-drop action.

The caption text that overlays the drag visual.

Gets or sets a value that indicates whether the caption text is shown.

**true** if the caption text is shown; otherwise, **false**.

Gets or sets a value that indicates whether the content of the drag visual is shown.

**true** if the content is shown; otherwise, **false**.

Gets or sets a value that indicates whether the glyph is shown.

**true** if the glyph is shown; otherwise, **false**.

Clears the content, caption, and glyph of the drag visual.

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation.

The source image used to create the drag visual.

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

The source image used to create the drag visual. The relative position of the drag visual from the pointer.

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation.

The source image used to create the drag visual.

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

The source image used to create the drag visual. The relative position of the drag visual from the pointer.

Provides event data for the DropCompleted event.

Gets a value that indicates the type of drag-and-drop operation, and whether the operation was successful.

An enumeration value that indicates the type of drag-and-drop operation, and whether the operation was successful.

Represents the duration of time that a Timeline is active, or more generally represents a duration of time that also supports two special values **Automatic** and **Forever**.

The **TimeSpan** value component.

The type as a member of the enumeration.

Provides basic utility methods for processing Duration values. C# and Microsoft Visual Basic code should use methods of Duration instead.

Returns a generated Duration value that indicates an "Automatic" Duration. C# and Microsoft Visual Basic code should use Duration.Automatic instead.

A Duration value that indicates an "Automatic" Duration.

Returns a generated Duration value that indicates a "Forever" Duration. C# and Microsoft Visual Basic code should use Duration.Forever instead.

A Duration value that indicates a "Forever" Duration.

Adds the **TimeSpan** component of two Duration values. C# and Microsoft Visual Basic code should use the Addition (+) operator or the Duration.Add method instead.

The value to add to. The value to add. The resulting Duration after **TimeSpan** component addition.

Compares value equality of two Duration structures. C# and Microsoft Visual Basic code should use Duration.Compare instead.

The first Duration to compare. The second Duration to compare. If *duration1* is less than *duration2*, a negative value that represents the difference. If *duration1* is equal to *duration2*, zero. If *duration1* is greater than *duration2*, a positive value that represents the difference.

Determines whether two Duration values have equivalent values. C# and Microsoft Visual Basic code should use the Equality (=) operator or Duration.Equals method instead.

The first Duration to compare. The second Duration to compare. **true** if *target* and *value* hold equivalent values; otherwise, **false**.

Creates a new Duration based on a TimeSpan value. C# and Microsoft Visual Basic code should use the Duration(TimeSpan) constructor instead.

The initializing TimeSpan. The created Duration.

Returns whether the **TimeSpan** component of a given Duration holds a non-null value. C# and Microsoft Visual Basic code should use Duration.HasTimeSpan instead.

The Duration value to evaluate. **true** if the **TimeSpan** component of the provided Duration is not **null**; otherwise, **false**.

Subtracts the **TimeSpan** component of one Duration value from another Duration value. C# and Microsoft Visual Basic code should use the Subtraction (-) operator or the Duration.Subtract method instead.

The value to subtract from. The value to subtract. The resulting Duration after **TimeSpan** component subtraction.

Declares whether a Duration has a special value of Automatic or Forever, or has valid information in its **TimeSpan** component.

Has the Automatic special value.

Has the Forever special value.

Has valid information in the **TimeSpan** component.

Provides data for the FrameworkElement.EffectiveViewportChanged event.

Gets the sum of translation in the X-axis that is required to bring the FrameworkElement into view of each viewport containing the element.

The translation in the X-axis that is required to bring the FrameworkElement into view of each viewport containing the element

Gets the sum of translation in the Y-axis that is required to bring the FrameworkElement into view of each viewport containing the element.

The translation in the Y-axis that is required to bring the FrameworkElement into view of each viewport containing the element.

Gets the Rect representing the effective viewport.

The Rect representing the effective viewport.

Gets the Rect representing the maximum effective viewport with the current viewport sizes.

The Rect representing the maximum effective viewport with the current viewport sizes.

Represents the optional arguments to use when calling an implementation of the IElementFactory 's GetElement method.

Initializes a new instance of the ElementFactoryGetArgs class.

Gets or sets the data item for which an appropriate element tree should be realized when calling GetElement.

A reference to the data item for which a UIElement should be realized.

Gets or sets the UIElement that is expected to be the parent of the realized element from GetElement.

The UIElement object expected to be the parent of the realized UIElement or **null**. By default, it is **null**.

Represents the optional arguments to use when calling an implementation of the IElementFactory 's RecycleElement method.

Initializes a new instance of the ElementFactoryRecycleArgs class.

Gets or sets the UIElement object to recycle when calling RecycleElement.

The UIElement object to recycle.

Gets or sets a reference to the current parent UIElement of the element being recycled.

The parent UIElement object or **null**. By default, it is **null**.

Defines constants that specify whether the framework automatically adjusts visual properties for an element when high contrast themes are enabled.

Behavior is inherited from the Application.HighContrastAdjustment setting.

Visuals are automatically adjusted when high contrast is enabled.

No automatic adjustments are made to visuals.

Defines constants that specify the sound played by the ElementSoundPlayer.Play method.

The sound to play when an element gets focus.

The sound to play when a user navigates back.

The sound to play when a flyout, dialog, or command bar is closed.

The sound to play when an element is invoked.

The sound to play when a user navigates to the next panel or view within a page.

The sound to play when a user navigates to the previous panel or view within a page.

The sound to play when a flyout, dialog, or command bar is opened.

Defines constants that specify a control's preference for whether sounds are played.

Sound is played based on the ElementSoundPlayer.State setting.

Sound is played only when focus on the control changes.

No sounds are played.

Represents a player for XAML control sounds.

Gets or sets a value that indicates whether spatial audio is on, off, or handled automatically.

An enumeration value that indicates whether spatial audio is on, off, or handled automatically. The default is **Auto**.

Gets or sets a value that specifies whether the system plays control sounds.

A value of the enumeration that specifies whether the system plays control sounds. The default is **Auto**.

Gets or sets the volume of the sounds played by the Play method.

The volume of the sounds played by the Play method. The default is 1.0.

Plays the specified sound.

A value of the enumeration that specifies the sound to play.

Defines constants that specify whether XAML controls play sounds.

The platform determines whether or not sounds are played.

Sounds are never played on any platform.

Sounds are played on all platforms.

Defines constants that indicate whether spatial sound is on, off, or handled automatically.

Spatial sound is turned on or off by the system.

Spatial sound is off.

Spatial sound is on.

Specifies a UI theme that should be used for individual UIElement parts of an app UI.

Use the **Dark** default theme.

Use the Application.RequestedTheme value for the element. This is the default.

Use the **Light** default theme.

Represents the method that will handle the Application.EnteredBackground event.

The object where the handler is attached. Event data for the event.

Represents a trigger that applies a set of actions (animation storyboards) in response to an event. Not commonly used. See Remarks.

Initializes a new instance of the EventTrigger class.

Gets the collection of BeginStoryboard objects that this EventTrigger maintains.

The existing TriggerActionCollection.

Gets or sets the name of the event that initiates the trigger. Not commonly set, see Remarks.

The name or identifier of the event.

Provides event data for exceptions that are raised as events by asynchronous operations, such as ImageFailed.

Gets the message component of the exception, as a string.

The message component of the exception.

Represents the method that will handle certain events that report exceptions. These exceptions generally come from asynchronous operations.

The object where the handler is attached. The event data.

Defines constants that specify the content flow direction for text and UI elements.

Indicates that content should flow from left to right.

Indicates that content should flow from right to left.

Describes how an element obtained focus.

Element obtained focus through a keyboard action, such as tab sequence traversal.

Element obtained focus through a pointer action.

Element obtained focus through a deliberate call to Focus or a related API.

Element is not currently focused.

Specifies the visual feedback used to indicate the UI element with focus when navigating with a keyboard or gamepad.

A dotted line rectangle. Also known as "marching ants".

A solid line rectangle composed of an inner and outer rectangle of contrasting colors.

A solid line rectangle, surrounded by a glowing light effect to simulate depth.

Describes the capital letter style value for the Typography.Capitals attached property.

Both capital and lowercase letters are replaced with a glyph form of an uppercase letter with the same approximate height. Petite capitals are smaller than small capitals.

Both capital and lowercase letters are replaced with a glyph form of an uppercase letter with the same approximate height.

Capital letters render normally.

Lowercase letters are replaced with a glyph form of an uppercase letter with the same approximate height. Petite capitals are smaller than small capitals.

Lowercase letters are replaced with a glyph form of an uppercase letter with the same approximate height.

Glyph forms are substituted with a typographic form specifically designed for titles.

Capital letters display in unicase. Unicase fonts render both uppercase and lowercase letters in a mixture of uppercase and lowercase glyphs determined by the type designer.

Provides a mechanism for selecting font-specific versions of glyphs for a specified East Asian writing system or language.

Replaces default glyphs with the corresponding forms from the Hojo Kanji specification.

Replaces default Japanese glyphs with the corresponding forms from the JIS04 specification.

Replaces default Japanese glyphs with the corresponding forms from the JIS78 specification.

Replaces default Japanese glyphs with the corresponding forms from the JIS83 specification.

Replaces default Japanese glyphs with the corresponding forms from the JIS90 specification.

Replaces default glyphs with the corresponding forms from the NLC Kanji specification.

No font-specific glyph versions are applied.

Replaces traditional Chinese or Japanese forms with their corresponding simplified forms.

Replaces simplified Chinese or Japanese forms with their corresponding traditional forms.

Replaces simplified Kanji forms with their corresponding traditional forms. This glyph set is explicitly limited to the traditional forms considered proper for use in personal names.

Provides a mechanism for selecting glyphs of different width styles.

Replaces uniform width glyphs with full width (usually em) glyphs.

Replaces uniform width glyphs with half width (half em) glyphs

Default width style.

Replaces uniform width glyphs with proportionally spaced glyphs.

Replaces uniform width glyphs with one-quarter width (one-quarter em) glyphs.

Replaces uniform width glyphs with one-third width (one-third em) glyphs.

Describes a fraction style value for the Typography.Fraction attached property.

Default style is used.

Stacked fraction style is used.

Slashed fraction style is used.

Describes the numeral alignment value for the Typography.NumeralAlignment attached property.

Default numeral alignment is used.

Proportional width alignment is used.

Tabular alignment is used.

Describes a numeral style value for the Typography.NumeralStyle attached property.

Lining numeral style is used. Replaces default glyphs with numeric forms of even height.

Default numeral style is used.

Old style numeral style is used. Replaces default glyphs with a figure style that matches lowercase letters in height and color.

Describes a font variant value for the Typography.Variants attached property.

Replaces a default glyph with an inferior glyph, or it may combine glyph substitution with positioning adjustments for proper placement. Inferior forms are typically used in chemical formulas or mathematical notation.

Default font behavior. Font scaling and positioning is normal.

Replaces a default glyph with an ordinal glyph, or it may combine glyph substitution with positioning adjustments for proper placement. Ordinal forms are normally associated with numeric notation of an ordinal word, such as "1st" for "first".

Replaces a default glyph with a smaller Japanese Kana glyph. This is used to clarify the meaning of Kanji, which may be unfamiliar to the reader.

Replaces a default glyph with a subscript glyph.

Replaces a default glyph with a superscript glyph. Superscript is commonly used for footnotes.

Provides a base element class for Windows Runtime UI objects. FrameworkElement defines common API that support UI interaction and the automatic layout system. FrameworkElement  also defines API related to data binding, defining and examining the object tree, and tracking object lifetime.

Provides base class initialization behavior for FrameworkElement -derived classes.

Gets the rendered height of a FrameworkElement. See Remarks.

The height, in pixels, of the object. The default is 0. The default might be encountered if the object has not been loaded and hasn't yet been involved in a layout pass that renders the UI.

Identifies the ActualHeight  dependency property. See Remarks.

The identifier for the ActualHeight  dependency property.

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

A value of the enumeration, for example **Light**.

Identifies the ActualTheme dependency property.

The identifier for the ActualTheme dependency property.

Gets the rendered width of a FrameworkElement. See Remarks.

The width, in pixels, of the object. The default is 0. The default might be encountered if the object has not been loaded and hasn't yet been involved in a layout pass that renders the UI.

Identifies the ActualWidth  dependency property. See Remarks.

The identifier for the ActualWidth  dependency property.

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

**true** if the element gets focus when a user interacts with it; otherwise, **false**.

Identifies for the AllowFocusOnInteraction dependency property.

The identifier for the AllowFocusOnInteraction dependency property.

Gets or sets whether a disabled control can receive focus.

**true** if a disabled control can receive focus; otherwise, **false**.

Identifies the AllowFocusWhenDisabled  dependency property.

The identifier for the AllowFocusWhenDisabled  dependency property.

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.

The base Uniform Resource Identifier (URI) for an object at XAML load time.

Gets or sets the data context for a FrameworkElement. A common use of a data context is when a **FrameworkElement** uses the {Binding} markup extension and participates in data binding.

The object to use as data context.

Identifies the DataContext  dependency property.

The DataContext  dependency property identifier.

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either **LeftToRight** or **RightToLeft**. Setting FlowDirection to **RightToLeft** on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

The direction that text and other UI elements flow within their parent element, as a value of the enumeration. The default value is LeftToRight.

Identifies the FlowDirection  dependency property.

The FlowDirection  dependency property identifier.

Gets or sets the outer margin of the focus visual for a FrameworkElement.

Provides margin values for the focus visual. The default value is a default Thickness with all properties (dimensions) equal to 0.

Identifies the FocusVisualMargin  dependency property.

The identifier for the FocusVisualMargin  dependency property.

Gets or sets the brush used to draw the outer border of a HighVisibility focus visual for a FrameworkElement.

The brush used to draw the outer border of a HighVisibility focus visual.

Identifies the FocusVisualPrimaryBrush  dependency property.

The identifier for the FocusVisualPrimaryBrush  dependency property.

Gets or sets the thickness of the outer border of a HighVisibility focus visual for a FrameworkElement.

The thickness of the outer border of a HighVisibility focus visual. The default value is 2.

Identifies the FocusVisualPrimaryThickness  dependency property.

The identifier for the FocusVisualPrimaryThickness  dependency property.

Gets or sets the brush used to draw the inner border of a HighVisibility focus visual for a FrameworkElement.

The brush used to draw the inner border of a HighVisibility focus visual.

Identifies the FocusVisualSecondaryBrush  dependency property.

The identifier for the FocusVisualSecondaryBrush  dependency property.

Gets or sets the thickness of the inner border of a HighVisibility focus visual for a FrameworkElement.

The thickness of the inner border of a HighVisibility focus visual. The default value is 1.

Identifies the FocusVisualSecondaryThickness  dependency property.

The identifier for the FocusVisualSecondaryThickness  dependency property.

Gets or sets the suggested height of a FrameworkElement.

The height, in pixels, of the object. The default is NaN. Except for the special NaN value, this value must be equal to or greater than 0.

Identifies the Height  dependency property.

The identifier for the Height  dependency property.

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

A horizontal alignment setting, as a value of the enumeration. The default is **Stretch**.

Identifies the HorizontalAlignment  dependency property.

The HorizontalAlignment  dependency property identifier.

Gets a value that indicates whether the element has been added to the element tree and is ready for interaction.

**true** if the element has been added to the element tree and is ready for interaction; otherwise, **false**.

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

A string specifying language and culture that follows the Internet Engineering Task Force (IETF) BCP 47 standards. For example, U.S. English is "en-US".

Identifies the Language dependency property.

The identifier for the Language dependency property.

Gets or sets the outer margin of a FrameworkElement.

Provides margin values for the object. The default value is a default Thickness with all properties (dimensions) equal to 0.

Identifies the Margin  dependency property.

The Margin  dependency property identifier.

Gets or sets the maximum height constraint of a FrameworkElement.

The maximum height of the object, in pixels. The default value is PositiveInfinity. This value can be any value equal to or greater than 0. PositiveInfinity is also valid.

Identifies the MaxHeight  dependency property.

The identifier for the MaxHeight  dependency property.

Gets or sets the maximum width constraint of a FrameworkElement.

The maximum width of the object, in pixels. The default is PositiveInfinity. This value can be any value equal to or greater than 0. PositiveInfinity is also valid.

Identifies the MaxWidth  dependency property.

The identifier for the MaxWidth  dependency property.

Gets or sets the minimum height constraint of a FrameworkElement.

The minimum height of the object, in pixels. The default is 0. This value can be any value equal to or greater than 0. However, PositiveInfinity is not valid.

Identifies the MinHeight  dependency property.

The identifier for the MinHeight  dependency property.

Gets or sets the minimum width constraint of a FrameworkElement.

The minimum width of the object, in pixels. The default is 0. This value can be any value equal to or greater than 0. However, PositiveInfinity is not valid.

Identifies the MinWidth  dependency property.

The identifier for the MinWidth  dependency property.

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

The name of the object, which must be a string that is valid in the XamlName grammar (see table in x:Name attribute reference). The default is an empty string.

Identifies the Name  dependency property.

The identifier for the Name  dependency property.

Gets the parent object of this FrameworkElement in the object tree.

The parent object of this object in the object tree.

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

A value of the enumeration, for example **Light**.

Identifies the RequestedTheme dependency property.

The identifier for the RequestedTheme dependency property.

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a `frameworkElement.Resources` property element, through XAML implicit collection syntax.

The current locally defined dictionary of resources, where each resource can be accessed by its key.

Gets or sets an instance Style that is applied for this object during layout and rendering.

The applied style for the object, if present; otherwise, **null**. The default for a default-constructed FrameworkElement is **null**.

Identifies the Style dependency property.

The identifier for the Style dependency property.

Gets or sets an arbitrary object value that can be used to store custom information about this object.

The intended arbitrary object value. This property has no default value.

Identifies the Tag  dependency property.

The identifier for the Tag  dependency property.

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

The collection of triggers for animations that are defined for this object.

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

A vertical alignment setting, as a value of the enumeration. The default is **Stretch**.

Identifies the VerticalAlignment  dependency property.

The VerticalAlignment  dependency property identifier.

Gets or sets the width of a FrameworkElement.

The width of the object, in pixels. The default is NaN. Except for the special NaN value, this value must be equal to or greater than 0.

Identifies the Width  dependency property.

The identifier for the Width  dependency property.

Occurs when the ActualTheme property value has changed.

Occurs when the value of the FrameworkElement.DataContext property changes.

Occurs when the FrameworkElement 's *effective viewport* changes.

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

Occurs when a FrameworkElement begins to load.

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

Occurs when this object is no longer connected to the main object tree.

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

The final area within the parent that this object should use to arrange itself and its children. The actual size that is used after the element is arranged in layout.

Removes the specified element from the XAML visual tree in a way that it can be undeferred later.

The element to remove from the XAML visual tree.

Retrieves an object that has the specified identifier name.

The name of the requested object. The requested object. This can be null if no matching object was found in the current XAML namescope.

Returns the BindingExpression that represents the binding on the specified property.

The identifier for the target dependency property to get the binding from. A BindingExpression if the target property has an active binding on this object; otherwise, returns **null**.

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

The state to transition to. **true** to use a VisualTransition to transition between states. **false** to skip using transitions and go directly to the requested state. The default is **false**. **true** if the control successfully transitions to the new state, or was already using that state; otherwise, **false**.

Invalidates the viewport state for a UIElement that is used to calculate the *effective viewport*.

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

The available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available. The size that this object determines it needs during layout, based on its calculations of the allocated sizes for child objects or based on other considerations such as a fixed container size.

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

Attaches a binding to a FrameworkElement, using the provided binding object.

The dependency property identifier of the property that is data bound. The binding to use for the property.

Creates an element tree of elements. FrameworkTemplate is a base class for classes that have specific templating behavior, including ControlTemplate and DataTemplate.

Provides base class initialization behavior for FrameworkTemplate -derived classes.

Represents the UI window of an application.

Initializes a new instance of the FrameworkView class.

Initializes the view.

The view object.

Loads the view.

An identifier, such as a class name from the application code, that provides additional information about the view.

Passes execution to the view provider.

Associates a Window with a view.

The Window to associate.

Returns the view to the uninitialized state.

Creates views, specifically FrameworkView instances. This is infrastructure and does not need to be accessed in most app scenarios.

Initializes a new instance of the FrameworkViewSource class.

Creates a FrameworkView.

The created FrameworkView.

Represents a measurement for control logic that explicitly supports **Star** (\*) sizing and **Auto** sizing.

A value of the GridUnitType enumeration that qualifies how **Value** is interpreted as a measure.

The measure for this GridLength, which is not necessarily a pixel measure.

Provides helper methods to evaluate or set GridLength values. C# and Microsoft Visual Basic code should use methods of GridLength instead.

Gets a static GridLength value that corresponds to the special "Auto" value. C# and Microsoft Visual Basic code should use GridLength.Auto instead.

A GridLength value that corresponds to the special "Auto" value.

Provides comparison of the values of two GridLength values. C# and Microsoft Visual Basic code should use the Equality operator or GridLength.Equals method instead.

The first GridLength to compare. The second GridLength to compare. **true** if the two GridLength values hold equivalent values as their structure value information; otherwise, **false**.

Creates a new GridLength value based on a fixed number of pixels. C# and Microsoft Visual Basic code should use the GridLength(Double) constructor instead.

The pixel height or width to specify. The created GridLength.

Creates a new GridLength value based on a possible number of pixels, and a GridUnitType. C# and Microsoft Visual Basic code should use the GridLength(Double,GridUnitType) constructor instead.

A numeric value. This might be a pixel height or width to specify, if *type* is specified as **Pixel**, or a factor, if *type* is specified as **Star**. This value is ignored if *type* is specified as **Auto**. A value of the enumeration that specifies which unit type the GridLength represents. The created GridLength.

Returns whether the evaluated GridLength is the special "Absolute" value. C# and Microsoft Visual Basic code should use GridLength.IsAbsolute instead.

The GridLength to evaluate. **true** if the evaluated GridLength is the special "Absolute" value; otherwise, **false**.

Returns whether the evaluated GridLength is the special "Auto" value. C# and Microsoft Visual Basic code should use GridLength.IsAuto instead.

The GridLength to evaluate. **true** if the evaluated GridLength is the special "Auto" value; otherwise, **false**.

Returns whether the evaluated GridLength is the special "*" (star sizing) value. C# and Microsoft Visual Basic code should use GridLength.IsStar instead.

The GridLength to evaluate. **true** if the evaluated GridLength is the special "*" (star sizing) value; otherwise, **false**.

Describes the kind of value that a GridLength object is holding.

The size is determined by the size properties of the content object.

The value is expressed in pixels.

The value is expressed as a weighted proportion of available space.

Indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element.

An element aligned to the center of the layout slot for the parent element.

An element aligned to the left of the layout slot for the parent element.

An element aligned to the right of the layout slot for the parent element.

An element stretched to fill the entire layout slot of the parent element.

Defines helper methods for phased rendering of a data template.

Provides phased rendering of bound data in a data template.

Gets the number of times the method has been called. **true** if there are more phases to be processed; otherwise, **false**.

Updates a list item container element with bound data.

Information about the item, item index, and rendering phase. The phase at which the next call to ProcessBindings will occur. A value of -1 indicates that no further callbacks are requested.

Disconnects any event listeners so the data template can be recycled.

Supports the creation and recycling of UIElement objects.

Gets an UIElement object.

An instance of ElementFactoryGetArgs. A UIElement object.

Recycles a UIElement that was previously retrieved using GetElement.

An instance of ElementFactoryRecycleArgs.

Represents the method that will handle the Application.LeavingBackground event.

The object where the handler is attached. Event data for the event.

Describes the mechanism by which a line box is determined for each line.

The stack height is determined by adding LineHeight to the baseline of the previous line.

The stack height is determined by the block element's LineHeight property value.

The stack height is the minimum of the extended block progression dimension (height) of all the inline elements when properly aligned and the LineHeight value, if specified.

Provides event data for media failed events.

Gets the trace information for a media failed event.

The error trace for the failed media event.

Specifies how side bearing values in per-character typography are handled when aligning to a text container boundary.

Use side bearings that come from font typography values. This is the default.

Don't use side bearings that come from font typography values, and align the side of the glyph to where the "ink" part of the glyph begins.

Provides helper methods to set Point values. C# and Microsoft Visual Basic code should use methods of Point instead.

Creates a new Point value using x- and y-coordinate values in pixels. C# and Microsoft Visual Basic code should use the Point(Double,Double) constructor instead.

The pixel value to set for **X**. The pixel value to set for **Y**. The created Point.

Represents the callback that is invoked when the effective property value of a dependency property changes.

The DependencyObject on which the property has changed value. Event data that is issued by any event that tracks changes to the effective value of this property.

Defines behavior aspects of a dependency property, including conditions it was registered with. For more info on how PropertyMetadata is used for dependency properties, see Custom dependency properties.

Initializes a new instance of the PropertyMetadata class, using a property default value.

A default value for the property where this PropertyMetadata is applied.

Initializes a new instance of the PropertyMetadata class, using a property default value and callback reference.

A default value for the property where this PropertyMetadata is applied. A reference to the callback to call for property changed behavior.

Gets a reference to the callback method that provides a default property value.

A reference to the callback method that provides a default property value.

Gets the default value for the dependency property.

The default value for the dependency property.

Creates a PropertyMetadata value, specifying a fixed default value for a dependency property.

The dependency property default value to apply. The newly created dependency property metadata.

Creates a PropertyMetadata value, specifying a fixed default value for a dependency property, and a property-changed callback.

The dependency property default value to apply. A reference to the callback method that is invoked by the property system when a dependency property value changes. The newly created dependency property metadata.

Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property.

A reference to the callback method that provides a default property value. The newly created dependency property metadata.

Creates a PropertyMetadata value, specifying a callback that establishes a default value for a dependency property, and a property-changed callback.

A reference to the callback method that provides a default property value. A reference to the callback method that is invoked by the property system when a dependency property value changes. The newly created dependency property metadata.

Implements a data structure for describing a property as a path below another property, or below an owning type. Property paths are used in data binding to objects.

Initializes a new instance of the PropertyPath class based on a path string.

The path string to construct with.

Gets the path value held by this PropertyPath.

The path value held by this PropertyPath.

Provides helper methods to evaluate or set Rect values. C# and Microsoft Visual Basic code should use members of Rect instead.

Gets a static Rect value where the Rect has no size or position (all values 0). C# and Microsoft Visual Basic code should use Rect.Empty instead.

A Rect with all values as 0.

Returns whether a given Point is within the bounds of a given Rect, for a shared coordinate reference. C# and Microsoft Visual Basic code should use Rect.Contains instead.

The Rect to evaluate. The Point to check for containment. **true** if *point* is within the *target* bounds; otherwise, **false**.

Provides comparison of the values of two Rect values. C# and Microsoft Visual Basic code should use the Equality (=) operator or Equals method instead.

The first Rect to compare. The second Rect to compare. **true** if *target* and *value* hold equivalent values; otherwise, **false**.

Creates a new Rect value based on the element values of a Rect structure. C# and Microsoft Visual Basic code should use the Rect(Double,Double,Double,Double) constructor instead.

The pixel value to set for **X**. The pixel value to set for **Y**. The pixel value to set for **Width**. The pixel value to set for **Height**. The created Rect.

Creates a new Rect value based on a Point that specifies the upper-left origin, and a Size that specifies the width and height. C# and Microsoft Visual Basic code should use the Rect(Point,Size) constructor instead.

The Point location of the origin (upper left). The Size that specifies width and height. The created Rect value.

Creates a new Rect value based on two points. C# and Microsoft Visual Basic code should use the Rect(Point,Point) constructor instead.

The first point. The second point. The created Rect.

Gets a "Bottom" value for the specified Rect. So long as **Height** is positive, "Bottom" is evaluated as **Y** + **Height**. C# and Microsoft Visual Basic code should use Rect.Bottom instead.

The Rect to evaluate. The evaluated "Bottom" value.

Returns whether a specified Rect is equivalent to an Empty Rect. C# and Microsoft Visual Basic code should use Rect.IsEmpty instead.

The Rect to evaluate. **true** if the specified Rect is equivalent to an Empty Rect; otherwise, **false**.

Gets a "Left" value for the specified Rect. So long as **Width** is positive, "Left" is evaluated as **X**. C# and Microsoft Visual Basic code should use Rect.Left instead.

The Rect to evaluate. The evaluated "Left" value.

Gets a "Right" value for the specified Rect. So long as **Width** is positive, "Right" is evaluated as **X** + **Width**. C# and Microsoft Visual Basic code should use Rect.Right instead.

The Rect to evaluate. The evaluated "Right" value.

Gets a "Top" value for the specified Rect. So long as **Height** is positive, "Top" is evaluated as **Y**. C# and Microsoft Visual Basic code should use Rect.Top instead.

The Rect to evaluate. The evaluated "Top" value.

Returns the areas of two specified Rect values that intersect, as a new Rect. C# and Microsoft Visual Basic code should use Rect.Intersect instead.

The first Rect to check for intersection. The second Rect to check for intersection. A Rect that represents the areas of *target* and *rect* that intersect. Can be an Empty value if there is no intersection.

Creates a rectangle that is exactly large enough to contain the a specified rectangle and a specified point. C# and Microsoft Visual Basic code should use Rect.Union(Point) instead.

The rectangle to include. The point to include. A rectangle that is exactly large enough to contain the specified rectangle and point.

Creates a rectangle that is exactly large enough to contain the two specified rectangles. C# and Microsoft Visual Basic code should use Rect.Union(Rect) instead.

The first rectangle to include. The second rectangle to include. A rectangle that is exactly large enough to contain the two specified rectangles.

Defines a repository for XAML resources, such as styles, that your app uses. You define the resources in XAML and can then retrieve them in XAML using the {StaticResource} markup extension and {ThemeResource} markup extension s. You can also access resources with code, but that is less common.

Initializes a new instance of the ResourceDictionary class.

Gets a collection of the ResourceDictionary dictionaries that constitute the various resource dictionaries in the merged dictionaries.

A list collection of the ResourceDictionary dictionaries that constitute the various resource dictionaries in the merged dictionaries.

Gets the number of elements contained in the collection.

The number of elements contained in the collection.

Gets or sets a Uniform Resource Identifier (URI) that provides the source location of a merged resource dictionary.

A Uniform Resource Identifier (URI) that provides the source location of a merged resource dictionary. This is typically a path that references a XAML resource within the app, or a reference to a loose XAML file.

Gets a collection of merged resource dictionaries that are specifically keyed and composed to address theme scenarios, for example supplying theme values for "HighContrast".

A dictionary of ResourceDictionary theme dictionaries. Each must be keyed with **x:Key**.

Removes all items from this ResourceDictionary.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Retrieves a view against the ResourceDictionary.

The view object.

Returns whether the ResourceDictionary has an entry with the requested key.

The requested key. **true** if the ResourceDictionary has an entry with the requested key; otherwise, **false**.

Adds a new entry to the ResourceDictionary.

The object key for the resource to insert. The object value for the resource to insert. **true** if calling the method replaced a value that already existed for the key; **false** if calling the method defined a new key.

Returns the value from the requested key, if an entry with that key exists.

The requested key. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes a specific item from the ResourceDictionary.

The key of the item to remove.

Represents a routed event to the Windows Runtime event system.

Contains state information and event data associated with a routed event.

Initializes a new instance of the RoutedEventArgs class.

Gets a reference to the object that raised the event. This is often a template part of a control rather than an element that was declared in your app UI.

The object that raised the event.

Represents the method that will handle routed events.

The object where the event handler is attached. The event data.

Provides the animated transition behavior when an element's Opacity or Rotation properties change.

Initializes a new instance of the ScalarTransition class.

Gets or sets the duration of the transition.

The duration of the transition.

Applies a value to a property in a Style or a VisualState.

Initializes a new instance of the Setter class with no initial Property or Value.

Initializes a new instance of the Setter class with initial Property and Value information.

The dependency property identifier for the property that is being styled. The value to assign to the value when the Setter applies.

Gets or sets the property to apply the Value to.

A DependencyProperty to which the Value will be applied. The default is **null**.

Gets or sets the path of a property on a target element to apply the Value to.

The path of a property on a target element to apply the Value to.

Gets or sets the value to apply to the property that is specified by the Setter.

The value to apply to the property that is specified by the Setter.

Represents the base class for value setters.

Gets a value that indicates whether this object is in an immutable state.

**true** if this object is in an immutable state; otherwise, **false**.

Represents a collection of objects that inherit from SetterBase.

Initializes a new instance of the SetterBaseCollection class.

Gets a value that indicates whether the collection is in a read-only state.

**true** if this object is in a read-only state and cannot be changed; otherwise, **false**.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the SetterBase located at the specified index.

The integer index for the value to retrieve. The SetterBase value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items returned.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the SetterBase value specified.

The index at which to set the value. The value to set.

Provides data related to the FrameworkElement.SizeChanged event.

Gets the new size of the object reporting the size change.

The new size. The Size structure contains the new height and width.

Gets the previous size of the object reporting the size change.

The previous size.

Represents the method that will handle the SizeChanged event.

The object where the event handler is attached. The event data.

Provides helper methods to evaluate or set Size values. C# and Microsoft Visual Basic code should use members of Size instead.

Gets a static Size value where the Size has no height or width (all values 0). C# and Microsoft Visual Basic code should use Size.Empty instead.

A Size with all values as 0.

Provides comparison of the values of two Size values. C# and Microsoft Visual Basic code should use the Equality (=) operator or Equals method instead.

The first Size to compare. The second Size to compare. **true** if *target* and *value* hold equivalent values; otherwise, **false**.

Creates a new Size based on width and height element values. C# and Microsoft Visual Basic code should use the Size(Double,Double) constructor instead.

The initial **Width**. The initial **Height**. The created Size.

Returns whether a specified Size is equivalent to an Empty Size. C# and Microsoft Visual Basic code should use Size.IsEmpty instead.

The Size to evaluate. **true** if the specified Size is equivalent to an Empty Size; otherwise, **false**.

Represents a trigger that applies visual states conditionally.

Initializes a new instance of the StateTrigger class.

Gets or sets a value that indicates whether the trigger should be applied.

**true** if the system should apply the trigger; otherwise, **false**.

Identifies the IsActive  dependency property.

The identifier for the IsActive  dependency property.

Represents the base class for state triggers.

Initializes a new instance of the StateTriggerBase class.

Sets the value that indicates whether the state trigger is active.

**true** if the system should apply the trigger; otherwise, **false**.

Contains property setters that can be shared between instances of a type. A Style is usually declared in a resources collection so that it can be shared and used for applying control templates and other styles.

Initializes a new instance of the Style class, with no initial TargetType and an empty Setters collection.

Initializes a new instance of the Style class, with a specified initial TargetType and an empty Setters collection.

The TargetType to set for the Style.

Gets or sets a defined style that is the basis of the current style.

A defined style that is the basis of the current style. The default value is null.

Gets a value that indicates whether the style is read-only and cannot be changed.

**true** if the style is read-only; otherwise, **false**.

Gets a collection of Setter objects.

A collection of Setter objects. The default is an empty collection.

Gets or sets the type for which the style is intended. TargetType can be used to declare an implicit style resource if there's no resource key specified.

The type of object to which the style is applied. This value is usually set in XAML, not code. See Remarks.

Locks the style so that the TargetType property or any Setter in the Setters collection cannot be changed.

Represents an attribute that is applied to the class definition and determines the **TargetTypes** of the properties that are of type Style.

Initializes a new instance of the StyleTypedPropertyAttribute class.

Represents the method that will handle the Suspending event.

The object where the handler is attached. Event data.

Represents the path to a property on a target element.

Initializes a new instance of the TargetPropertyPath class.

Initializes a new instance of the TargetPropertyPath class with the specified target property.

The target property.

Gets or sets the path to the property on the target element.

The path to the property on the target element.

Gets or sets the object that contains the property described by Path.

The object that contains the property described by Path.

Represents an attribute that is applied to the class definition to identify the types of the named parts that are used for templating.

Initializes a new instance of the TemplatePartAttribute class.

Specifies that a control can be in a certain state and that a VisualState is expected in the control's ControlTemplate.

Initializes a new instance of the TemplateVisualStateAttribute class.

Specifies whether text is centered, left-aligned, or right-aligned.

Text is centered within the container.

Text alignment is inferred from the text content.

The end of the text is aligned to the edge of the container.

Text is justified within the container.

Text is aligned to the left edge of the container.

Text is aligned to the right edge of the container.

The beginning of the text is aligned to the edge of the container.

Influences how a line box height is calculated

Uses normal line box height calculation, this is the default.

Top of line box height is the cap height from the font, bottom of line box height is the text baseline.

Bottom of line box height is the text baseline.

Top of line box height is the cap height from the font.

Provides a value for **TextReadingOrder** properties.

Do not detect flow direction from content. Use FlowDirection value (if any) for reading order decisions. (Windows 8.1 only. See Remarks.)

Consider using UseFlowDirection, which is an improved version of Default. For more info, see MSDN.

Detect flow direction from text content. For bidirectional text, text containers will infer the reading order for text based on the content. See Remarks.

Do not detect flow direction from content. Use FlowDirection value (if any) for reading order decisions. (Windows 10 only. See Remarks.)

Describes how text is trimmed when it overflows the edge of its containing box.

Text is trimmed at a character boundary. An ellipsis (...) is drawn in place of remaining text.

Text is trimmed at a pixel level, visually clipping the excess glyphs.

Default.

Text is trimmed at a word boundary. An ellipsis (...) is drawn in place of remaining text.

Specifies whether text wraps when it reaches the edge of its container.

No line wrapping is performed.

Line breaking occurs if a line of text overflows beyond the available width of its container. Line breaking occurs even if the text logic can't determine any line break opportunity. For example, if a very long word is constrained in a fixed-width container that can't scroll, it will wrap at a point that might be in the middle of a word.

Line-breaking occurs if the line overflows beyond the available block width. A line may overflow beyond the block width if the text logic can't determine a line break opportunity. For example, if a very long word is constrained in a fixed-width container that can't scroll, it will overflow the long word and continue the text after the long word on the next line. Not supported by all controls; see Remarks.

Describes the thickness of a frame around a rectangle. Four Double values describe the **Left**, **Top**, **Right**, and **Bottom** sides of the rectangle, respectively.

The bottom edge measure of the Thickness.

The left side measure of the Thickness.

The right side measure of the Thickness.

The top edge measure of the Thickness.

Provides helper methods to evaluate or set Thickness values. C# and Microsoft Visual Basic code should use members of Thickness instead.

Creates a Thickness value based on element values. C# and Microsoft Visual Basic code should use the Thickness(Double,Double,Double,Double) constructor instead.

The initial **Left**. The initial **Top**. The initial **Right**. The initial **Bottom**. The created Thickness.

Creates a new Thickness value using a uniform value for all the element values. C# and Microsoft Visual Basic code should use the Thickness(Double) constructor instead.

The uniform value to apply to all four of the Thickness element values. The created Thickness.

Serves as the base class for BeginStoryboard. Not commonly used. See Remarks.

Represents a collection of BeginStoryboard objects.

Initializes a new instance of the TriggerActionCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The TriggerAction value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the TriggerAction value specified.

The index at which to set the value. The value to set.

Serves as the base class for EventTrigger. Not commonly used. See Remarks.

Represents a collection of EventTrigger objects.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the TriggerBase value specified.

The index at which to set the value. The value to set.

UIElement is a base class for most of the Windows Runtime UI objects that have visual appearance and can process basic input as part of your app's user interface.

Gets or sets the access key (mnemonic) for this element.

The access key (mnemonic) for this element.

Identifies for the AccessKey dependency property.

The identifier for the AccessKey dependency property.

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

The element that defines the access key scope.

Identifies for the AccessKeyScopeOwner dependency property.

The identifier for the AccessKeyScopeOwner dependency property.

Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

The position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

Gets the size that this UIElement computed during the arrange pass of the layout process.

The size that this UIElement computed during the arrange pass of the layout process.

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

**true** if this UIElement can be a drop target for purposes of drag-and-drop operations; otherwise, **false**. The default is **false**.

Identifies the AllowDrop dependency property.

The identifier for the AllowDrop dependency property.

Gets the identifier for the BringIntoViewRequested routed event.

The identifier for the BringIntoViewRequested routed event.

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

A value that indicates that rendered content should be cached as a composited bitmap when possible. If you specify a value of CacheMode, rendering operations from RenderTransform and Opacity execute on the graphics processing unit (GPU), if available. The default is **null**, which does not enable a cached composition mode.

Identifies the CacheMode dependency property.

The identifier for the CacheMode dependency property.

Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring.

**true** if an element should be considered as a candidate for scroll anchoring; otherwise, **false**. The default is **false**.

Identifies the CanBeScrollAnchor dependency property.

The identifier for the CanBeScrollAnchor dependency property.

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

**true** if the element can be dragged as data in a drag-and-drop operation; otherwise, **false**. The default is **false**.

Identifies the CanDrag dependency property.

The identifier for the CanDrag dependency property.

Gets or sets the center point of the element, which is the point about which rotation or scaling occurs. Affects the rendering position of the element.

The center point of the element, which is the point about which rotation or scaling occurs.

Gets the identifier for the CharacterReceived routed event.

The identifier for the CharacterReceived routed event.

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

The rectangle geometry to be used for clipping area sizing. The default value is **null** (no clipping).

Identifies the Clip dependency property.

The identifier for the Clip dependency property.

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

A value of the enumeration. The default is **Inherit**, but see Remarks.

Identifies the CompositeMode dependency property.

The identifier for the CompositeMode dependency property.

Gets or sets the flyout associated with this element.

The flyout associated with this element, if any; otherwise, **null**. The default is **null**.

Identifies for the ContextFlyout dependency property.

The identifier for the ContextFlyout dependency property.

Gets the identifier for the ContextRequested routed event.

The identifier for the ContextRequested routed event.

Gets the size that this UIElement computed during the measure pass of the layout process.

The size that this UIElement computed during the measure pass of the layout process.

Gets the identifier for the DoubleTapped routed event.

The identifier for the DoubleTapped routed event.

Gets the identifier for the DragEnter routed event.

The identifier for the DragEnter routed event.

Gets the identifier for the DragLeave routed event.

The identifier for the DragLeave routed event.

Gets the identifier for the DragOver routed event.

The identifier for the DragOver routed event.

Gets the identifier for the Drop routed event.

The identifier for the Drop routed event.

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

**true** to dismiss the access key display when an access key is invoked; otherwise, **false**.

Identifies the ExitDisplayModeOnAccessKeyInvoked  dependency property.

The identifier for the ExitDisplayModeOnAccessKeyInvoked  dependency property.

Gets the identifier for the GettingFocus routed event.

The identifier for the GettingFocus routed event.

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

A value of the enumeration that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled. The default is **Application**.

Identifies the HighContrastAdjustment dependency property.

The identifier for the HighContrastAdjustment dependency property.

Gets the identifier for the Holding routed event.

The identifier for the Holding routed event.

Gets or sets a value that indicates whether an element defines its own access key scope.

**true** if an element defines its own scope; otherwise, **false**.

Identifies for the IsAccessKeyScope dependency property.

The identifier for the IsAccessKeyScope dependency property.

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

**true** if a DoubleTapped event can originate from this element; otherwise, **false**.

Identifies the IsDoubleTapEnabled dependency property.

The identifier for the IsDoubleTapEnabled dependency property.

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

**true** if the contained area of this UIElement can be used for hit testing; otherwise, **false**. The default is **true**.

Identifies the IsHitTestVisible dependency property.

The identifier for the IsHitTestVisible dependency property.

Gets or sets a value that determines whether the Holding event can originate from that element.

**true** if a Holding event can originate from this element; otherwise, **false**.

Identifies the IsHoldingEnabled dependency property.

The identifier for the IsHoldingEnabled dependency property.

Gets or sets a value that determines whether the RightTapped event can originate from that element.

**true** if a RightTapped event can originate from this element; otherwise, **false**.

Identifies the IsRightTapEnabled dependency property.

The identifier for the IsRightTapEnabled dependency property.

Gets or sets a value that determines whether the Tapped event can originate from that element.

**true** if a Tapped event can originate from this element; otherwise, **false**.

Identifies the IsTapEnabled dependency property.

The identifier for the IsTapEnabled dependency property.

Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

A value of the enumeration. The default is **Auto**.

Identifies the KeyboardAcceleratorPlacementMode dependency property.

The identifier for the KeyboardAcceleratorPlacementMode dependency property.

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

The control tooltip that displays the accelerator key combination.

Identifies the KeyboardAcceleratorPlacementTarget dependency property.

The identifier for the KeyboardAcceleratorPlacementTarget dependency property.

Gets the collection of key combinations that invoke an action using the keyboard.

The collection of **KeyboardAccelerator** objects.

Gets the identifier for the KeyDown routed event.

The identifier for the KeyDown routed event.

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

The number of pixels to move the Key Tip. Positive values move it right. Negative values move it left.

Identifies the KeyTipHorizontalOffset dependency property.

The identifier for the KeyTipHorizontalOffset dependency property.

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

A value of the enumeration. The default is **Auto**.

Identifies the KeyTipPlacementMode dependency property.

The identifier for the KeyTipPlacementMode dependency property.

Gets or sets a value that indicates the element targeted by the access key Key Tip.

The element targeted by the Key Tip.

Identifies the KeyTipTarget dependency property.

The identifier for the KeyTipTarget dependency property.

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

The number of pixels to move the Key Tip. Positive values move it down. Negative values move it up.

Identifies the KeyTipVerticalOffset dependency property.

The identifier for the KeyTipVerticalOffset dependency property.

Gets the identifier for the KeyUp routed event.

The identifier for the KeyUp routed event.

Gets the collection of XamlLight objects attached to this element.

The collection of XamlLight elements that apply to a UIElement.

Identifies the Lights dependency property.

The identifier for the Lights dependency property.

Gets the identifier for the LosingFocus routed event.

The identifier for the LosingFocus routed event.

Gets the identifier for the ManipulationCompleted routed event.

The identifier for the ManipulationCompleted routed event.

Gets the identifier for the ManipulationDelta routed event.

The identifier for the ManipulationDelta routed event.

Gets the identifier for the ManipulationInertiaStarting routed event.

The identifier for the ManipulationInertiaStarting routed event.

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

A value or values of the enumeration. The default is typically **System**, but this can vary on specific controls and elements. See Remarks.

Identifies the ManipulationMode dependency property.

The identifier for the ManipulationMode dependency property.

Gets the identifier for the ManipulationStarted routed event.

The identifier for the ManipulationStarted routed event.

Gets the identifier for the ManipulationStarting routed event.

The identifier for the ManipulationStarting routed event.

Gets the identifier for the NoFocusCandidateFound routed event.

The identifier for the NoFocusCandidateFound routed event.

Gets or sets the degree of the object's opacity.

A value between 0 and 1.0 that declares the opacity factor, with 1.0 meaning full opacity and 0 meaning transparent. The default value is 1.0.

Identifies the IsHitTestVisible dependency property.

The identifier for the IsHitTestVisible dependency property.

Gets or sets the ScalarTransition that animates changes to the Opacity property.

Gets the identifier for the PointerCanceled routed event.

The identifier for the PointerCanceled routed event.

Gets the identifier for the PointerCaptureLost routed event.

The identifier for the PointerCaptureLost routed event.

Gets the set of all captured pointers, represented as Pointer values.

The collection of captured pointers, each represented as a Pointer object.

Identifies the PointerCaptures dependency property.

The identifier for the PointerCaptures dependency property.

Gets the identifier for the PointerEntered routed event.

The identifier for the PointerEntered routed event.

Gets the identifier for the PointerExited routed event.

The identifier for the PointerExited routed event.

Gets the identifier for the PointerMoved routed event.

The identifier for the PointerMoved routed event.

Gets the identifier for the PointerPressed routed event.

The identifier for the PointerPressed routed event.

Gets the identifier for the PointerReleased routed event.

The identifier for the PointerReleased routed event.

Gets the identifier for the PointerWheelChanged routed event.

The identifier for the PointerWheelChanged routed event.

Gets the identifier for the PreviewKeyDown routed event.

The identifier for the PreviewKeyDown routed event.

Gets the identifier for the PreviewKeyUp routed event.

The identifier for the PreviewKeyUp routed event.

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

A 3-D projection effect applied to the element.

Identifies the Projection dependency property.

The identifier for the Projection dependency property.

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

The rendered size for this object. There is no default value.

Gets or sets transform information that affects the rendering position of a UIElement.

Describes the specifics of the desired render transform. The default value is null.

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

The origin point of the render transform. The default value is a Point with value 0,0.

Identifies the RenderTransformOrigin dependency property.

The identifier for the RenderTransformOrigin dependency property.

Identifies the RenderTransform dependency property.

The identifier for the RenderTransform dependency property.

Gets the identifier for the RightTapped routed event.

The identifier for the RightTapped routed event.

Gets or sets the angle of clockwise rotation, in degrees. Rotates relative to the RotationAxis and the CenterPoint. Affects the rendering position of the element.

The angle of clockwise rotation, in degrees.

Gets or sets the axis to rotate the element around.

The axis to rotate the element around.

Gets or sets the ScalarTransition that animates changes to the Rotation property.

The ScalarTransition that animates changes to the Rotation property.

Gets or sets the scale of the element. Scales relative to the element's CenterPoint. Affects the rendering position of the element.

The scale of the element, relative to the element's CenterPoint.

Gets or sets the Vector3Transition that animates changes to the Scale property.

The Vector3Transition that animates changes to the Scale property.

Gets or sets the shadow effect cast by the element.

The shadow effect cast by the element.

Identifies the Shadow dependency property.

The identifier for the Shadow dependency property.

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

A value of the enumeration. The default is **Local**.

Identifies the TabFocusNavigation dependency property.

The identifier for the TabFocusNavigation dependency property.

Gets the identifier for the Tapped routed event.

The identifier for the Tapped routed event.

Gets or sets the 3-D transform effect to apply when rendering this element.

The 3-D transform effect to apply when rendering this element. The default is **null**.

Identifies the Transform3D dependency property.

The identifier for the Transform3D dependency property.

Gets or sets the transformation matrix to apply to the element.

The transformation matrix to apply to the element.

Gets or sets the collection of Transition style elements that apply to a UIElement.

The strongly typed collection of Transition style elements that apply to a UIElement.

Identifies the Transitions dependency property.

The identifier for the Transitions dependency property.

Gets or sets the x, y, and z rendering position of the element.

The x, y, and z rendering position of the element.

Gets or sets the Vector3Transition that animates changes to the Translation property.

The Vector3Transition that animates changes to the Translation property.

Gets the context identifier for the element.

The context identifier for the element.

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

**true** if rendering and layout should use layout rounding to whole pixels; otherwise, **false**. The default is **true**.

Identifies the UseLayoutRounding dependency property.

The identifier for the UseLayoutRounding dependency property.

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

A value of the enumeration. The default value is **Visible**.

Identifies the Visibility dependency property.

The identifier for the Visibility dependency property.

Gets or sets the XamlRoot in which this element is being viewed.

The XamlRoot in which this element is being viewed. The default is **null**.

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusDownNavigationStrategy dependency property.

The identifier for the XYFocusDownNavigationStrategy dependency property.

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusKeyboardNavigation dependency property.

The identifier for the XYFocusKeyboardNavigation dependency property.

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusLeftNavigationStrategy dependency property.

The identifier for the XYFocusLeftNavigationStrategy dependency property.

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusRightNavigationStrategy dependency property.

The identifier for the XYFocusRightNavigationStrategy dependency property.

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusUpNavigationStrategy dependency property.

The identifier for the XYFocusUpNavigationStrategy dependency property.

Occurs when access keys should no longer be displayed.

Occurs when the user requests that access keys be displayed.

Occurs when a user completes an access key sequence.

Occurs when StartBringIntoView is called on this element or one of its descendants.

Occurs when a single, composed character is received by the input queue.

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

Occurs when the user has completed a context input gesture, such as a right-click.

Occurs when an otherwise unhandled **DoubleTap** interaction occurs over the hit test area of this element.

Occurs when the input system reports an underlying drag event with this element as the target.

Occurs when the input system reports an underlying drag event with this element as the origin.

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

Occurs when a drag operation is initiated.

Occurs when the input system reports an underlying drop event with this element as the drop target.

Occurs when a drag-and-drop operation with this element as the source is ended.

Occurs before a UIElement receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Occurs when an otherwise unhandled **Hold** interaction occurs over the hit test area of this element.

Occurs when a keyboard key is pressed while the UIElement has focus.

Occurs when a keyboard key is released while the UIElement has focus.

Occurs before a UIElement loses focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Occurs when a manipulation on the UIElement is complete.

Occurs when the input device changes position during a manipulation.

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

Occurs when an input device begins a manipulation on the UIElement.

Occurs when the manipulation processor is first created.

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

Occurs when a pointer that made contact abnormally loses contact.

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

Occurs when a pointer enters the hit test area of this element.

Occurs when a pointer leaves the hit test area of this element.

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

Occurs when the pointer device initiates a **Press** action within this element.

Occurs when the pointer device that previously initiated a **Press** action is released, while within this element. Note that the end of a **Press** action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

Occurs when the delta value of a pointer wheel changes.

Occurs when a keyboard key is pressed while the UIElement has focus.

Occurs when a keyboard key is released while the UIElement has focus.

Occurs when a keyboard shortcut (or accelerator) is pressed.

Occurs when a right-tap input stimulus happens while the pointer is over the element.

Occurs when an otherwise unhandled **Tap** interaction occurs over the hit test area of this element.

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify *handledEventsToo* as **true** to have the provided handler be invoked even if the event is handled elsewhere.

An identifier for the routed event to be handled. A reference to the handler implementation. **true** to register the handler such that it is invoked even when the routed event is marked handled in its event data.

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

The final size that the parent computes for the child in layout, provided as a Rect value.

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

**true** if a ScrollViewer parent exists and setting the value resulted in canceling the panning/zooming action. **false** if calling the method results in no action.

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

The pointer object reference. **true** if the object has pointer capture; otherwise, **false**.

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

The point being touched. The bounds used for touch tolerance. A set of point sets. These represent the vertices of sub elements that are intersected by the given touch point (plus tolerance).

Enables a UIElement subclass to expose child elements that take part in Tab focus.

A collection of the UIElement's child elements that take part in Tab focus.

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

Invalidates the measurement state (layout) for a UIElement.

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

The available space that a parent can allocate to a child object. A child object can request a larger space than what is available; the provided size might be accommodated if scrolling or other resize behavior is possible in that particular container.

Called before the BringIntoViewRequested event occurs.

The data for the event.

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

The class-specific AutomationPeer subclass to return.

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

The KeyboardAcceleratorInvokedEventArgs.

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

The ProcessKeyboardAcceleratorEventArgs.

Defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

When overridden in a derived class, defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

Registers an element as representing a scrollable viewport.

The element to register as a scrollable viewport.

Releases pointer captures for capture of one specific pointer by this UIElement.

The pointer reference. Use either saved references from previous captures, or pointer event data, to obtain this reference.

Releases all pointer captures held by this element.

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

The identifier of the routed event for which the handler is attached. The specific handler implementation to remove from the event handler collection on this UIElement.

Begins the specified animation on the element.

The animation to start.

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

Initiates a request to the XAML framework to bring the element into view using the specified options.

An instance of BringIntoViewOptions.

Initiates a drag-and-drop operation.

The coordinates of the pointer where the user interacts with the screen, and where the drag visual is attached. A DataPackageOperation value that indicates the type of drag-and-drop operation, and whether the operation was successful.

Stops the specified animation on the element.

The animation to stop.

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

The object to compare to the current object for purposes of obtaining the transform. The transform information as an object. Call methods on this object to get a practical transform.

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

The ProcessKeyboardAcceleratorEventArgs.

Resumes direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

The active touch point that initiated the manipulation. **true** if a ScrollViewer parent exists and setting the value resulted in resuming the panning/zooming action. **false** if calling the method results in no action.

Ensures that all positions of child objects of a UIElement are properly updated for layout.

Represents a collection of weak references to UIElement objects.

Initializes a new instance of the UIElementWeakCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object that represents the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The zero-based index at which to insert the item. The object to insert into the collection.

Removes the item at the specified index.

The zero-based index of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the specified UIElement value.

The index at which to set the value. The value to set.

Provides data for the UnhandledException event.

Gets the **HRESULT** code associated with the unhandled exception.

The **HRESULT** code (for Visual C++ component extensions (C++/CX)), or a mapped common language runtime (CLR) System.Exception.

Gets or sets a value that indicates whether the exception is handled.

**true** to mark the exception as handled, which indicates that the event system should not process it further; otherwise, **false**.

Gets the message string as passed by the originating unhandled exception.

The message string, which may be useful for debugging.

Represents the method that will handle the UnhandledException event.

The object where the handler is attached. Event data.

Provides the animated transition behavior when an element's Translation or Scale properties change.

Initializes a new instance of the Vector3Transition class.

Gets or sets a value that specifies whether to animate changes in the three subchannels of the Vector3.

A value that specifies whether to animate changes in the subchannels of the Vector3.

Gets or sets the duration of the transition.

The duration of the transition.

Defines constants that specify which axes to animate during the Vector3Transition animation.

Animate the X axis.

Animate the Y axis.

Animate the Z axis.

Describes how a child element is vertically positioned or stretched within a parent's layout slot.

The element is aligned to the bottom of the parent's layout slot.

The element is aligned to the center of the parent's layout slot.

The element is stretched to fill the entire layout slot of the parent element.

The element is aligned to the top of the parent's layout slot.

Specifies the display state of an element.

Do not display the element, and do not reserve space for it in layout.

Display the element.

Represents the visual appearance of a UI element when it is in a specific state. Visual states use Setters or a Storyboard to set UI properties within pages or control templates where the VisualState is defined.

Initializes a new instance of the VisualState class.

Gets the name of the VisualState.

The name of the VisualState.

Gets a collection of Setter objects that define discrete property values that control the appearance of UIElement s when this VisualState is applied.

A collection of Setter objects. The default is an empty collection.

Gets a collection of StateTriggerBase objects that indicate when this VisualState should be applied. If any (not all) of the triggers are active, the VisualState will be applied.

A collection of StateTriggerBase objects. The default is an empty collection.

Gets or sets a Storyboard that defines state-specific property values and appearance of the control when it is using this visual state.

A Storyboard that defines the property changes to apply to the control when this VisualState is used as the current visual state.

Provides data for the CurrentStateChanging and CurrentStateChanged events.

Initializes a new instance of the VisualStateChangedEventArgs class.

Gets the Control that is changing states.

The Control that is changing states.

Gets the state the Control is changing to or has changed to.

The state the Control is changing to or has changed to.

Gets the state the Control is changing from or has changed from.

The state the Control is changing from or has changed from.

Represents the method that will handle the CurrentStateChanging and CurrentStateChanged events.

The object where the event handler is attached. Event data for the event.

Contains mutually exclusive VisualState objects and VisualTransition objects that are used to go from one state to another.

Initializes a new instance of the VisualStateGroup class.

Gets the most recently set VisualState from a successful call to the GoToState method.

The most recently set VisualState from a successful call to the GoToState method, or **null**.

Gets the name of the VisualStateGroup.

The name of the VisualStateGroup.

Gets the collection of mutually exclusive VisualState objects.

The collection of mutually exclusive VisualState objects.

Gets the collection of VisualTransition objects.

The collection of VisualTransition objects.

Occurs after a control changes into a different state.

Occurs when a control begins changing into a different state.

Manages visual states and the logic for transitions between visual states for controls. Also provides the attached property support for VisualStateManager.VisualStateGroups, which is how you define visual states in XAML for a control template.

Initializes a new instance of the VisualStateManager class.

Identifies the **VisualStateManager.CustomVisualStateManager** dependency property.

The identifier for the **VisualStateManager.CustomVisualStateManager** dependency property.

Gets the value of the VisualStateManager.CustomVisualStateManager attached property.

The object to get the value from. The VisualStateManager that transitions between the states of a control.

Retrieves the collection of VisualStateGroup objects associated with the specified FrameworkElement.

The object to get the value from. A collection of VisualStateGroup objects.

Transitions a control between two states, by requesting a new VisualState by name.

The control to transition between states. The state to transition to. **true** to use a VisualTransition to transition between states. **false** to skip using transitions and go directly to the requested state. The default is **false**. **true** if the control successfully transitions to the new state, or was already using that state; otherwise, **false**.

When overridden in a derived class, transitions a control between states.

The control to transition between states. The root element of the control's ControlTemplate. The name of the state to transition to. The VisualStateGroup that the state belongs to. The representation of the state to transition to. **true** to use a VisualTransition to transition between states; otherwise, **false**. **true** if the control successfully transitions to the new state; otherwise, **false**.

When overridden in a derived class, fires the CurrentStateChanged event on the specified VisualStateGroup.

The object on which the CurrentStateChanging event occurred. The state that the control transitions from. The state that the control transitions to. The control that transitioned states.

When overridden in a derived class, fires the CurrentStateChanging event on the specified VisualStateGroup.

The object that the CurrentStateChanging event occurred on. The state that the control is transitioning from. The state that the control should transition to. The control where the transition animation between states is applied.

Sets the value of the VisualStateManager.CustomVisualStateManager attached property.

The target element where the property is set. The VisualStateManager that transitions between the states of a control.

Represents the visual behavior that occurs when the control transitions from one visual state to another.

Initializes a new instance of the VisualTransition class.

Gets or sets the name of the VisualState to transition from.

The name of the VisualState to transition from.

Gets or sets the amount of time it takes to move from one state to another, and the time that any implicit transition animations should run as part of the transition behavior.

The amount of time it takes to move from one state to another.

Gets or sets the easing function applied to the generated animations.

An easing function implementation that is applied to the generated animations.

Gets or sets the Storyboard that runs when the transition occurs.

The Storyboard that occurs when the transition occurs.

Gets or sets the name of the VisualState to transition to.

The name of the VisualState to transition to.

Represents an application window.

Gets a Rect value containing the height and width of the application window in units of effective (view) pixels.

A value that reports the height and width of the application window.

Gets the Compositor for this window.

The Compositor for this window.

Gets or sets the visual root of an application window.

The visual root of an application window.

Gets an internal *core* object for the application window.

A **CoreWindow** object.

Gets the currently activated window for an application.

The currently activated window.

Gets the CoreDispatcher object for the Window, which is generally the CoreDispatcher for the UI thread.

An object that references the UI thread for the Window.

Gets the context identifier for the window.

The context identifier for the window.

Gets a value that reports whether the window is visible.

**true** if the window is visible; **false** if the window is not visible.

Occurs when the window has successfully been activated.

Occurs when the window has closed.

Occurs when the app window has first rendered or has changed its rendering size.

Occurs when the value of the Visible property changes.

Attempts to activate the application window by bringing it to the foreground and setting the input focus to it.

Closes the application window.

Makes a XAML element interact with the system as if it’s the title bar.

Custom XAML content that should act as the title bar. To use multiple objects, wrap them in a container element such as one derived from Panel.

Represents the method that will handle the Activated event.

The object where the handler is attached. Event data for the event.

Represents the method that will handle the Closed event.

The object where the handler is attached. Event data for the event.

Provides data for the OnWindowCreated method.

Gets the window that was created.

The window that was created

Represents the method that will handle the Window.SizeChanged event.

The object where the handler is attached. Event data for the event.

Represents the method that will handle the VisibilityChanged event.

The object where the event handler is attached. Event data for the event.

Represents a tree of XAML content and information about the context in which it is hosted.

Gets the root element of the XAML element tree.

The root element of the XAML element tree.

Gets a value that indicates whether the XamlRoot is visible.

**true** if the XamlRoot is visible; otherwise, **false**.

Gets a value that represents the number of raw (physical) pixels for each view pixel.

A value that represents the number of raw (physical) pixels for each view pixel.

Gets the width and height of the content area.

The width and height of the content area.

Gets the context identifier for the view.

The context identifier for the view.

Occurs when a property of XamlRoot has changed.

Provides data for the XamlRoot.Changed event.

Contains values used as identifiers by IAnnotationProvider.

Gets the identifier for the AnnotationTypeId automation property.

The automation property identifier.

Gets the identifier for the AnnotationTypeName automation property.

The automation property identifier.

Gets the identifier for the Author automation property.

The automation property identifier.

Gets the identifier for the DateTime automation property.

The automation property identifier.

Gets the identifier for the Target automation property.

The automation property identifier.

Provides a set of constants that identify types of annotations in a document, as used by the ISpreadsheetItemProvider Microsoft UI Automation interface.

An advanced proofing issue.

Author info.

A circular reference error.

A comment. Comments can take different forms depending on the application.

A conflicting change.

A data validation error.

A deletion change.

An editing locked change.

Endnote content.

An external change.

The footer for a page in a document.

Footnote content.

A format change.

An error in a formula. Formula errors typically include red text and exclamation marks.

A grammatical error, often denoted by a green squiggly line.

The header for a page in a document.

Highlighted content, typically denoted by a contrasting background color.

An insertion change.

A move change.

A spelling error, often denoted by a red squiggly line.

A change that was made to the document.

The annotation type is unknown.

An unsynced change.

Defines values for the SelectionActiveEnd text attribute, which indicates the location of the caret relative to a text range that represents the currently selected text.

The caret is at the end of the text range.

The caret is not at either end of the text range.

The caret is at the beginning of the text range.

Defines the style of animation for the automation.

Blinking background animation.

Las Vegas lights style animation.

Marching black ants animation.

Marching red ants animation.

No animation.

Other animation.

Shimmer style animation.

Sparkling text animation.

Represents a single UI automation annotation.

Initializes a new instance of the class.

Initializes a new instance of the class using the supplied parameters.

Specifies the type of the annotation.

Initializes a new instance of the class using the supplied parameters.

Specifies the type of the annotation. Specifies the element that implements the annotation.

Gets or sets the element that implements the annotation.

The element that implements the annotation.

Gets the identifier of the property.

The identifier of the property.

Gets or sets the type of the annotation.

The type of the annotation.

Gets the identifier of the property.

The identifier of the property.

Defines the style of bullets used by the automation.

Dashed bullets.

Filled round bullets.

Filled square bullets.

Hollow round bullets.

Hollow square bullets.

No bullets.

Other style of bullets.

Defines the direction that the caret travels.

Left to right.

Right to left.

Defines the caret position.

Caret is at the beginning of the line.

Caret is at the end of the line.

Caret position is unknown.

Contains values used as automation property identifiers by UI Automation providers and UI Automation clients.

Identifies the accelerator key automation property. The accelerator key property value is returned by the GetAcceleratorKey method.

The automation property identifier.

Identifies the access key automation property. The access key property value is returned by the GetAccessKey method.

The automation property identifier.

Gets the identifier for the annotations automation property.

The identifier for the annotations automation property.

Identifies the automation element identifier automation property. The automation element identifier value is returned by the GetAutomationId method.

The automation property identifier.

Identifies the bounding rectangle automation property. The bounding rectangle property value is returned by the GetBoundingRectangle method.

The automation property identifier.

Identifies the class name automation property. The class name property value is returned by the GetClassName method.

The automation property identifier.

Identifies the clickable point automation property. A valid clickable point property value is returned by the GetClickablePoint method.

The automation property identifier.

Identifies the controlled peers automation property. A list of controlled peers is returned by the GetControlledPeers method.

The automation property identifier.

Identifies the control type automation property. The control type property value is returned by the GetAutomationControlType method.

The automation property identifier.

Identifies the Culture property, which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)).

The culture property identifier.

Identifies the described by automation property.

The automation property identifier.

Identifies the "flows from" automation property. The "flows from" property value is returned by the GetFlowsFrom method.

The automation property identifier.

Identifies the "flows to" automation property. The "flows to" property value is returned by the GetFlowsTo method.

The automation property identifier.

Identifies the full description automation property.

The automation property identifier.

Identifies the keyboard focus automation property. The keyboard focus state is returned by the HasKeyboardFocus method.

The automation property identifier.

Identifies the heading level automation property. The heading level property value is returned by the GetHeadingLevel method.

The automation property identifier.

Identifies the help text automation property. The help text property value is returned by the GetHelpText method.

The automation property identifier.

Identifies the content element determination automation property. The content element status indicates whether the element contains content that is valuable to the end user. The current status is returned by the IsContentElement method.

The automation property identifier.

Identifies the control element determination automation property. The control element status indicates whether the element contains user interface components that can be manipulated. The current status is returned by the IsControlElement method.

The automation property identifier.

Identifies the Boolean automation property that indicates if the data is valid for the form.

The automation property identifier.

Identifies the Boolean AutomationProperties.IsDialogProperty that indicates whether the automation element is a dialog window.

The automation property identifier.

Identifies the enabled determination automation property. The enabled status indicates whether the item referenced by the automation peer is enabled. The current status is returned by the IsEnabled method.

The automation property identifier.

Identifies the keyboard-focusable determination automation property. The keyboard focusable status is returned by the IsKeyboardFocusable method.

The automation property identifier.

Identifies the offscreen determination automation property. The offscreen status indicates whether the item referenced by the automation peer is off the screen. The current status is returned by the IsOffscreen method.

The automation property identifier.

Identifies the password determination automation property. The password status indicates whether the item referenced by the automation peer contains a password. The current status is returned by the IsPassword method.

The automation property identifier.

Identifies the Boolean automation property that indicates if the automation element represents peripheral UI.

The automation property identifier.

Identifies the form requirement determination automation property. The form requirement status indicates whether the element must be completed on a form. The current status is returned by the IsRequiredForForm method.

The automation property identifier.

Identifies the item status automation property. The current item status is returned by the GetItemStatus method.

The automation property identifier.

Identifies the item type automation property. The item type value is returned by GetItemType method.

The automation property identifier.

Identifies the labeled-by peer automation property. The labeling relationship for an automation peer is returned by the GetLabeledBy method.

The automation property identifier.

Gets the identifier for the landmark type automation property.

The identifier for the landmark type automation property.

Gets the identifier for the level automation property.

The identifier for the level automation property.

Identifies the live settings automation property. The live settings property value is returned by the GetLiveSetting method.

The automation property identifier.

Identifies the localized control type automation property which provides a mechanism to alter the control type read by Narrator.

The automation property identifier.

Gets the identifier for the localized landmark type automation property.

The identifier for the localized landmark type automation property.

Identifies the element name automation property. The current name is returned by the GetName method.

The automation property identifier.

Identifies the orientation automation property. The current orientation value is returned by the GetOrientation method.

The automation property identifier.

Gets the identifier for the position in set automation property.

The identifier for the position in set automation property.

Gets the identification of the size of set automation property.

The identification of the size of set automation property.

Defines the direction of flow.

Flow is from bottom to top.

Flow is in the default direction.

Flow is from right to left.

Flow is vertical.

Defines the outline style.

Embossed outline.

Engraved outline.

No outline.

Standard outline.

Drop shadow.

Provides support for getting or setting instance-level values of automation properties. These property values are set as attached properties (typically in XAML) and supplement or override automation property values from a control's AutomationPeer.

Identifies the AutomationProperties.AcceleratorKey attached property, which is a string containing the accelerator key (also called shortcut key) combinations for the automation element.

The identifier for the AutomationProperties.AcceleratorKey attached property.

Identifies the AutomationProperties.AccessibilityView attached property. Set this attached property on individual elements in order to change their element visibility to specific modes requested by a UI Automation client.

The identifier for the AutomationProperties.AccessibilityView attached property.

Identifies the AutomationProperties.AccessKey attached property, which is a string containing the access key character for the automation element.

The identifier for the AutomationProperties.AccessKey attached property.

Identifies a dependency property that's used for a list of annotation objects in a document, such as comment, header, footer, and so on.

The identifier for the **Annotations** attached property.

Identifies the AutomationProperties.AutomationId attached property, which is a string containing the UI Automation identifier (ID) for the automation element.

The identifier for the AutomationProperties.AutomationId attached property.

Identifies the ControlledPeers attached property, which is used for a collection of automation elements that can be manipulated by the specified automation element.

The identifier for the ControlledPeers attached property.

Gets the identifier for the culture attached property which contains a locale identifier for the automation element (for example, 0x0409 for "en-US" or English (United States)).

The identifier for the culture attached property.

Gets the identifier for the described by attached property, which is an array of elements that provide more information about the automation element.

The identifier for the described by attached property.

Gets the identifier for the **FlowsFrom** attached property, which is an array of automation elements that suggests the reading order before the current automation element.

The identifier for the **FlowsFrom** attached property.

Gets the identifier for the **FlowsTo** attached property, which is an array of automation elements that suggests the reading order after the current automation element.

The identifier for the "flows to" attached property.

Gets the identifier for the full description attached property, which exposes a localized string containing extended description text for an element.

The identifier for the full description attached property.

Gets the identifier for the **HeadingLevel** attached property, which indicates the heading level for a UI Automation element.

The identifier for the **HeadingLevel** attached property.

Identifies the AutomationProperties.HelpText attached property, which is a help text string associated with the automation element.

The identifier for the AutomationProperties.HelpText attached property.

Identifies the Boolean dependency property that indicates if the data is valid for the form.

The dependency property identifier.

Identifies the AutomationProperties.IsDialog attached property, which is a Boolean value that indicates whether the automation element is a dialog window.

The identifier for the AutomationProperties.IsDialog attached property.

Identifies the Boolean dependency property that indicates if the automation element represents peripheral UI.

The dependency property identifier.

Identifies the AutomationProperties.IsRequiredForForm attached property, which is a Boolean value that indicates whether the automation element is required to be filled out on a form.

The identifier for the AutomationProperties.IsRequiredForForm attached property.

Identifies the ItemStatus attached property, which describes the status of an automation element item.

A text string containing an identifier for the ItemStatus attached property.

Identifies the AutomationProperties.ItemType attached property, which is a text string describing the type of the automation element.

The identifier for the AutomationProperties.ItemType dependency property.

Identifies the AutomationProperties.LabeledBy attached property, which is an automation element that contains the text label for this element.

The identifier for the AutomationProperties.LabeledBy attached property.

Gets the identifier for the landmark type attached property, which is a Landmark Type Identifier associated with an element.

The identifier for the landmark type attached property.

Gets the identifier for the **Level** attached property, which is a 1-based integer associated with an automation element.

The identifier for the **Level** attached property.

Identifies the AutomationProperties.LiveSetting attached property, which is supported by an automation element that represents a live region.

The property identifier for the AutomationProperties.LiveSetting attached property.

Identifies the localized control type dependency property, which is a text string describing the type of control that the automation element represents.

The dependency property identifier.

Gets the identifier for the localized landmark type attached property, which is a localized text string describing the type of landmark that the automation element represents.

The identifier for the localized landmark type attached property.

Identifies the AutomationProperties.Name attached property, which is a string that holds the name of the automation element.

The identifier for the AutomationProperties.Name attached property.

Gets the identifier for the **PositionInSet** attached property, which is a 1-based integer associated with an automation element.

The identifier for the **PositionInSet** attached property.

Gets the identifier for the attached property.

The identifier for the attached property.

Gets the value of the AutomationProperties.AcceleratorKey attached property for the specified DependencyObject.

The DependencyObject to check. The accelerator key, as a string.

Gets the value of the AutomationProperties.AccessibilityView attached property for the specified DependencyObject.

The DependencyObject to check. The accessibility view setting, as a value of the enumeration.

Gets the value of the AutomationProperties.AccessKey attached property for the specified DependencyObject.

The DependencyObject to check. The access key, as a string.

Gets the value of the AutomationProperties.Annotations property for the specified DependencyObject.

The specified DependencyObject. The value of the AutomationProperties.Annotations property.

Gets the value of the AutomationProperties.AutomationId attached property for the specified DependencyObject.

The DependencyObject to check. The UI Automation identifier for the specified element.

A static utility method that retrieves the list of controlled peers from a target owner.

The owner object to retrieve controlled peers from. A list containing the peers that the target element controls.

Gets the value of the CultureProperty attached property for the specified DependencyObject.

The DependencyObject to check. The value of the culture property for the specified *element*.

Gets a collection of elements that provide more information about the specified automation element.

The automation element for which to get the described by collection. A collection of elements that provide more information about the automation element specified by the *element* parameter.

Gets a list of automation elements that suggests the reading order before the specified automation element.

The element for which to get the preceding reading order elements. A list of automation elements that suggests the reading order before the automation element specified by the *element* parameter.

Gets a list of automation elements that suggests the reading order after the specified automation element.

The element for which to get the following reading order elements. A list of automation elements that suggests the reading order after the automation element specified by the *element* parameter.

Gets a localized string that describes the visual appearance or contents of the specified DependencyObject.

The object for which to get the full description. A localized string that describes the visual appearance or contents of the object specified in the *element* parameter.

Gets the value of the AutomationProperties.HeadingLevel property for the specified DependencyObject.

The specified DependencyObject. The value of the AutomationProperties.HeadingLevel property.

Gets the value of the AutomationProperties.HelpText attached property for the specified DependencyObject.

The DependencyObject to check. The help text for the specified element.

Gets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the specified element.

The element for which to get data validation. A Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the object specified by the *element* parameter.

Gets the value of the AutomationProperties.IsDialog attached property for the specified DependencyObject.

The object to check. **true** if the specified element is identified as a dialog window; otherwise, **false**.

Gets a Boolean value that indicates whether the specified element represents peripheral UI.

The element to check for peripheral data. A Boolean value that indicates whether the DependencyObject specified by the *element* parameter represents peripheral UI.

Gets the value of the AutomationProperties.IsRequiredForForm attached property for the specified DependencyObject.

The DependencyObject to check. **true** if the specified element is required for completion of a form; otherwise, **false**.

Gets the value of the AutomationProperties.ItemStatus attached property for the specified DependencyObject.

The DependencyObject to check. The item status of the element.

Gets the value of the AutomationProperties.ItemType attached property for the specified DependencyObject.

The DependencyObject to check. The item type of the element.

Gets the value of the AutomationProperties.LabeledBy attached property for the specified DependencyObject.

The DependencyObject to check. The element that is targeted by the label.

Gets the value of the landmark type attached property for the specified DependencyObject.

The DependencyObject to check. The landmark type of the *element*

Gets the value of the property for the specified .

The specified . The value of the property.

Gets the value of the AutomationProperties.LiveSetting attached property for the specified DependencyObject.

The DependencyObject to check. The live setting value for the specified element.

Gets a localized string that indicates the type of the specified control.

The control for which to retrieve the type. A localized string that indicates the type of the control specified by the *element* parameter.

Gets the value of the localized landmark type attached property for the specified DependencyObject.

The DependencyObject to check. The localized string defining the landmark type of the *element*.

Gets the value of the AutomationProperties.Name attached property for the specified DependencyObject.

The DependencyObject to check. The name of the specified element.

Gets the value of the property for the specified .

The specified . The value of the property.

Gets the value of the property for the specified .

The specified . The value of the property.

Sets the value of the AutomationProperties.AcceleratorKey attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The accelerator key value to set.

Sets the value of the AutomationProperties.AccessibilityView attached property for the specified DependencyObject.

The DependencyObject to set the attached property on. The enumeration value to set.

Sets the value of the AutomationProperties.AccessKey attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The access key value to set.

Sets the value of the AutomationProperties.AutomationId attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The UI Automation identifier value to set.

Sets the value of the CultureProperty attached property for the specified DependencyObject.

The DependencyObject for which to set the culture property. The value of the culture property to set for the specified *element*.

Sets a localized string that describes the visual appearance or contents of the specified DependencyObject.

The object for which to set the full description. The localized full description of the object specified in the *element* parameter.

Sets the value of the AutomationProperties.HeadingLevel property for the specified DependencyObject.

The specified DependencyObject. The value for the heading level.

Sets the value of the AutomationProperties.HelpText attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The help text.

Sets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the specified element.

The element for which to set data validation. A Boolean value that indicates whether the entered or selected data is valid for the form.

Sets a Boolean value that indicates whether the specified element should be identified as a dialog window.

The object to identify as a dialog window. **true** if the element should be identified as a dialog window; otherwise, **false**.

Sets a Boolean value that indicates whether the specified element represents peripheral UI.

The element for which to set peripheral data. A Boolean value that indicates whether the DependencyObject specified by the *element* parameter represents peripheral UI.

Sets the value of the AutomationProperties.IsRequiredForForm attached property for the specified DependencyObject.

The DependencyObject for which to set the property. **true** to specify that the element is required to be filled out on a form; otherwise, **false**.

Sets the value of the AutomationProperties.ItemStatus attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The item status.

Sets the value of the AutomationProperties.ItemType attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The item type.

Sets the value of the AutomationProperties.LabeledBy attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The UI element that represents the label for *element*.

Sets the value of the landmark type attached property for the specified DependencyObject.

The specified DependencyObject. The value of the landmark type property.

Sets the value of the AutomationProperties.Level attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The value of the property.

Sets the value of the AutomationProperties.LiveSetting attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The AutomationLiveSetting value to set.

Sets a localized string that indicates the type of the specified control.

The control for which to set the type. A localized string that indicates the type of the control specified by the *element* parameter.

Sets the value of the localized landmark type attached property for the specified DependencyObject.

The specified DependencyObject. The localized string defining the landmark type of the *element*.

Sets the value of the AutomationProperties.Name attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The object name.

Sets the value of the AutomationProperties.PositionInSet attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The value of the property.

Sets the value of the AutomationProperties.SizeOfSet attached property for the specified DependencyObject.

The DependencyObject for which to set the property. The value of the property.

Identifies a property of AutomationElementIdentifiers or of a specific control pattern.

Defines the style of the text.

Text styled as Bulleted List.

Text styled as Emphasis.

Text styled as Heading 1.

Text styled as Heading 2.

Text styled as Heading 3.

Text styled as Heading 4.

Text styled as Heading 5.

Text styled as Heading 6.

Text styled as Heading 7.

Text styled as Heading 8.

Text styled as Heading 9.

Text styled as Normal.

Text styled as Quote.

Text styled as Subtitle.

Text styled as Title.

Defines the line style of text decorations.

Dashed line.

Dash-dot line.

Dash-dot-dot line.

Dotted line.

Double line.

Double wavy line.

Long dashed line.

No text decoration.

Other line.

Single line.

Thick dashed line.

Thick dash-dot line.

Thick dash-dot-dot line.

Thick dotted line.

Thick long dashed line.

Single thick line.

Thick wavy line.

Wavy line.

Words only.

Defines the type of text edit change.

Change is from an auto-correct action performed by a control.

Change is from an IME active composition within a control.

Change is from an IME composition going from active to finalized state within a control.

Not related to a specific change type.

Contains values used as identifiers by IDockProvider.

Identifies the DockPosition automation property.

The automation property identifier.

Contains values that specify the dock position of an object within a docking container. Used by IDockProvider.DockPosition.

Indicates that the UI Automation element is docked along the bottom edge of the docking container.

Indicates that the UI Automation element is docked along all edges of the docking container and fills all available space within the container.

Indicates that the UI Automation element is docked along the left edge of the docking container.

Indicates that the UI Automation element is not docked to any edge of the docking container.

Indicates that the UI Automation element is docked along the right edge of the docking container.

Indicates that the UI Automation element is docked along the top edge of the docking container.

Contains values used as identifiers by IDragProvider.

Gets the identifier for the DropEffect automation property.

The automation property identifier.

Gets the identifier for the DropEffects automation property.

The automation property identifier.

Gets the identifier for the GrabbedItems automation property.

The automation property identifier.

Gets the identifier for the IsGrabbed automation property.

The automation property identifier.

Contains values used as identifiers by IDropTargetProvider.

Gets the identifier for the DropEffect automation property.

The automation property identifier.

Gets the identifier for the DropEffects automation property.

The automation property identifier.

Contains values used as identifiers by IExpandCollapseProvider.

Identifies the ExpandCollapseState automation property.

The automation property identifier.

Contains values that specify the ExpandCollapseState automation property value of a UI Automation element.

No child nodes, controls, or content of the UI Automation element are displayed.

All child nodes, controls, and content of the UI Automation element are displayed.

The UI Automation element has no child nodes, controls, or content to display.

Some, but not all, child nodes, controls, or content of the UI Automation element are displayed.

Contains values used as identifiers by IGridItemProvider.

Identifies the Column automation property.

The automation property identifier.

Identifies the ColumnSpan automation property.

The automation property identifier.

Identifies the ContainingGrid automation property.

The automation property identifier.

Identifies the Row automation property.

The automation property identifier.

Identifies the RowSpan property.

The automation property identifier.

Contains values used as identifiers by IGridProvider.

Identifies the ColumnCount automation property.

The automation property identifier.

Identifies the RowCount automation property.

The automation property identifier.

Contains values used as identifiers by IMultipleViewProvider.

Identifies the CurrentView automation property.

The automation property identifier.

Identifies the automation property that gets the control-specific collection of views.

The automation property identifier.

Contains values used as identifiers by IRangeValueProvider.

Identifies the IsReadOnly automation property.

The automation property identifier.

Identifies the LargeChange automation property.

The automation property identifier.

Identifies the Maximum automation property.

The automation property identifier.

Identifies the Minimum automation property.

The automation property identifier.

Identifies the SmallChange automation property.

The automation property identifier.

Identifies the Value automation property.

The automation property identifier.

Specifies whether data in a table should be read primarily by row or by column.

Data in the table should be read column by column.

The best way to present the data is indeterminate.

Data in the table should be read row by row.

Contains values that are used by the IScrollProvider pattern to indicate the direction and distance to scroll.

Specifies that scrolling is performed in large decrements, which is equivalent to pressing the PAGE UP key or to clicking a blank part of a scrollbar. If the distance represented by the PAGE UP key is not a relevant amount for the control, or if no scrollbar exists, the value represents an amount equal to the size of the currently visible window.

Specifies that scrolling is performed in large increments, which is equivalent to pressing the PAGE DOWN key or to clicking a blank part of a scrollbar. If the distance represented by the PAGE DOWN key is not a relevant amount for the control, or if no scrollbar exists, the value represents an amount equal to the size of the currently visible region.

Specifies that scrolling should not be performed.

Specifies that scrolling is performed in small decrements, which is equivalent to pressing an arrow key or to clicking the arrow button on a scrollbar.

Specifies that scrolling is performed in small increments, which is equivalent to pressing an arrow key or to clicking the arrow button on a scrollbar.

Contains values used as identifiers by IScrollProvider, and also contains the NoScroll constant.

Identifies the HorizontallyScrollable automation property.

The automation property identifier.

Identifies the HorizontalScrollPercent automation property.

The automation property identifier.

Identifies the HorizontalViewSize automation property.

The automation property identifier.

Specifies that scrolling should not be performed.

The value – 1. This is the value to return if a client asks for the scrolling percentage, but scrolling is not enabled.

Identifies the VerticallyScrollable automation property.

The automation property identifier.

Identifies the VerticalScrollPercent automation property.

The automation property identifier.

Identifies the VerticalViewSize automation property.

The automation property identifier.

Contains values used as identifiers by ISelectionItemProvider.

Identifies the IsSelected automation property.

The automation property identifier.

Identifies the SelectionContainer automation property.

The automation property identifier.

Contains values used as identifiers by ISelectionProvider.

Identifies the CanSelectMultiple automation property.

The automation property identifier.

Identifies the IsSelectionRequired automation property.

The automation property identifier.

Identifies the property that gets the selected items in a container.

The automation property identifier.

Contains values used as automation property identifiers for properties of the ISpreadsheetItemProvider pattern.

Identifies the Formula automation property.

The automation property identifier.

Contains values used as identifiers by IStylesProvider.

Identifies the ExtendedProperties automation property.

The automation property identifier.

Identifies the FillColor automation property.

The automation property identifier.

Identifies the FillPatternColor automation property.

The automation property identifier.

Identifies the FillPatternStyle automation property.

The automation property identifier.

Identifies the Shape automation property.

The automation property identifier.

Identifies the StyleId automation property.

The automation property identifier.

Identifies the StyleName automation property.

The automation property identifier.

Contains values that specify whether a text provider supports selection and, if so, whether it supports a single, continuous selection or multiple, disjoint selections.

Supports multiple, disjoint text selections.

Does not support text selections.

Supports a single, continuous text selection.

Provides a of set constants that identify, as used by the ISynchronizedInputProvider Microsoft UI Automation interface.

A key has been pressed.

A key has been released.

The left mouse button has been pressed.

The left mouse button has been released.

The right mouse button has been pressed.

The right mouse button has been released.

Contains values used as identifiers by ITableProvider.

Identifies the automation property that retrieves all the column headers associated with a table item or cell.

The automation property identifier.

Identifies the automation property that retrieves all the row headers associated with a table item or cell.

The automation property identifier.

Contains values used as identifiers by ITableProvider.

Identifies the automation property that is accessed by the GetColumnHeaders method.

The automation property identifier.

Identifies the automation property that is accessed by the GetRowHeaders method.

The automation property identifier.

Identifies the RowOrColumnMajor automation property.

The automation property identifier.

Contains values used as identifiers by IToggleProvider.

Identifies the ToggleState automation property.

The automation property identifier.

Contains values that specify the ToggleState of a UI Automation element.

The UI Automation element is in an indeterminate state.

The UI Automation element isn't selected, checked, marked, or otherwise activated.

The UI Automation element is selected, checked, marked, or otherwise activated.

Contains values used as identifiers by ITransformProvider2.

Identifies the CanZoom automation property.

The automation property identifier.

Identifies the MaxZoom automation property.

The automation property identifier.

Identifies the MinZoom automation property.

The automation property identifier.

Identifies the ZoomLevel automation property.

The automation property identifier.

Contains values used as identifiers by ITransformProvider.

Identifies the CanMove automation property.

The automation property identifier.

Identifies the CanResize automation property.

The automation property identifier.

Identifies the CanRotate automation property.

The automation property identifier.

Contains values used as identifiers by IValueProvider.

Identifies the IsReadOnly property.

The automation property reference for the IsReadOnly property.

Identifies the Value automation property.

The automation property identifier.

Defines values that specify the current state of the window for purposes of user or programmatic interaction.

The window is blocked by a modal window.

The window is closing.

The window is not responding.

The window is ready for user interaction.

The window is running. This doesn't guarantee that the window is responding or ready for user interaction.

Contains values used as identifiers by IWindowProvider.

Identifies the Maximizable automation property.

The automation property identifier.

Identifies the Minimizable automation property.

The automation property identifier.

Identifies the IsModal automation property.

The automation property identifier.

Identifies the IsTopmost automation property.

The automation property identifier.

Identifies the InteractionState automation property.

The automation property identifier.

Identifies the VisualState automation property.

The automation property identifier.

Contains values that specify the visual state of a window for the IWindowProvider pattern.

Specifies that the window is maximized.

Specifies that the window is minimized.

Specifies that the window is normal (restored).

Contains possible values for the ZoomByUnit method, which zooms the viewport of a control by the specified unit.

Decrease zoom by a large decrement.

Increase zoom by a large increment.

No increase or decrease in zoom.

Decrease zoom by a small decrement.

Increase zoom by a small increment.

Declares how a control should included in different views of a Microsoft UI Automation tree.

The control is included in the **Content** view of a Microsoft UI Automation tree. This is the default.

The control is included in the **Control** view of a Microsoft UI Automation tree.

The control is included in the **Raw** view of a Microsoft UI Automation tree.

Exposes AppBar types to Microsoft UI Automation.

Initializes a new instance of the AppBarAutomationPeer class.

The AppBar control instance to create the peer for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Gets the interaction state of the app bar, such as running, closing, and so on.

The interaction state of the app bar.

Gets a Boolean value indicating if the app bar is modal.

**true** if the app bar is modal; otherwise, **false**.

Gets a Boolean value indicating if the app bar is the topmost element in the z-order of layout.

**true** if the app bar is topmost; otherwise, **false**.

Gets a Boolean value that indicates whether the app bar can be maximized.

**true** if the app bar can be maximized; otherwise, **false**.

Gets a Boolean value that indicates whether the app bar can be minimized.

**true** if the app bar can be minimized; otherwise, **false**.

Retrieves the toggle state of the owner AppBar.

The ToggleState of the owner control.

Gets the visual state of the app bar.

The visual state of the app bar, as a value of the enumeration.

Closes the app bar.

Hides all nodes, controls, or content that are descendants of the control.

Displays all child nodes, controls, or content of the control.

Changes the visual state of the app bar (such as minimizing or maximizing it).

The visual state of the app bar to change to, as a value of the enumeration.

Cycles through the toggle states of an AppBarAutomationPeer.

Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.

The amount of time, in milliseconds, to wait for the associated process to become idle. **true** if the app bar has entered the idle state; **false** if the timeout occurred.

Exposes AppBarButton types to Microsoft UI Automation.

Initializes a new instance of the AppBarButtonAutomationPeer class.

The AppBarButton to create the peer for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Hides all nodes, controls, or content that are descendants of the control.

Displays all child nodes, controls, or content of the control.

Exposes AppBarToggleButton types to Microsoft UI Automation.

Initializes a new instance of the AppBarToggleButtonAutomationPeer class.

The AppBarToggleButton to create the peer for.

Specifies the control type that is exposed to the Microsoft UI Automation client. Used by GetAutomationControlType.

**Introduced in .** An app bar control (AppBar ).

A button control.

A calendar control, such as a date picker.

A check box control.

A combo box control.

A control that is not one of the defined control types.

A data grid control.

A data item control.

A document control.

An edit control, such as a text box.

A group control, which acts as a container for other controls.

A header control, which is a container for the labels of rows and columns of information.

A header item, which is the label for a row or column of information.

A hyperlink control.

An image control.

A list control, such as a list box.

A list item control, which is a child item of a list control.

A menu control, such as a top-level menu in an application window.

A menu bar control, which generally contains a set of top-level menus.

A menu item control.

A pane control.

A progress bar control, which visually indicates the progress of a lengthy operation.

A radio button control, which is a selection mechanism allowing exactly one selected item in a group.

A scroll bar control, such as a scroll bar in an application window.

A semantic zoom control.

A separator, which creates a visual division in controls such as menus and toolbars.

A slider control.

A spinner control.

A split button, which is a button that performs a default action and can also expand to a list of other possible actions.

A status bar control.

A tab control.

A tab item control, which represents a page of a tab control.

A table.

An edit control, such as a text box or rich text box.

The control in a scrollbar that can be dragged to a different position.

The caption bar on a window.

A toolbar, such as the control that contains a set of command buttons in an application window.

A tooltip control, an informational window that appears as a result of moving the pointer over a control or sometimes when tabbing to a control using the keyboard.

A tree control.

A node in a tree control.

A window frame, which contains child objects.

Specifies the event that is raised by the element through the associated AutomationPeer. Used by RaiseAutomationEvent.

The event that is raised when content is loaded asynchronously.

The event that is raised when the focus has changed. See SetFocus.

The event that is raised when the conversion target has changed.

The event that is raised when a drag operation is canceled from a peer.

The event that is raised when a drag operation finishes from a peer.

The event that is raised when a drag operation targets a peer.

The event that is raised when a drag operation switches targets away from a peer.

The event that is raised when a drag operation originates from a peer.

The event that is raised when a drag operation drops on a peer.

The event that is raised when user input has been discarded.

The event that is raised when user input has reached the other element.

The event that is raised when user input has reached its target.

The event that is raised when a control is activated. See Invoke.

The event that is raised when the window layout has become invalidated. This event is also used for Auto-suggest accessibility.

The event that is raised as notification when a live region refreshes its content without having focus.

The event that is raised when a menu is closed.

The event that is raised when a menu is opened.

The event that is raised when a property has changed.

The event that is raised when an item is added to a collection of selected items. See AddToSelection.

The event that is raised when an item is removed from a collection of selected items. See RemoveFromSelection.

The event that is raised when a single item is selected (which clears any previous selection). See Select.

The event that is raised when a selection in a container has changed significantly.

The event that is raised when the UI Automation tree structure is changed.

The event that is raised when the text was changed in an edit control.

The event that is raised when textual content is modified.

The event that is raised when the text selection is modified.

The event that is raised when a tooltip is closed.

The event that is raised when a tooltip is opened.

The event that is raised when a window is closed.

The event that is raised when a window is opened.

Defines the heading levels for UI Automation elements.

Heading level 1.

Heading level 2.

Heading level 3.

Heading level 4.

Heading level 5.

Heading level 6.

Heading level 7.

Heading level 8.

Heading level 9.

Not a heading.

Defines the automation landmark types for elements.

Custom landmark type

Form landmark type

Main page landmark type

Navigation landmark type

No landmark type specified

Search landmark type

Describes the notification characteristics of a particular live region in an app UI. Used by GetLiveSetting and AutomationProperties.LiveSetting.

The element sends interruptive notifications if the content of the live region has changed. With this setting, Microsoft UI Automation clients and assistive technology are expected to interrupt the user to inform of changes to the live region.

The element does not send notifications if the content of the live region has changed.

The element sends non-interruptive notifications if the content of the live region has changed. With this setting, Microsoft UI Automation clients and assistive technology are expected to not interrupt the user to inform of changes to the live region.

Defines the directions of navigation within the Microsoft UI Automation tree.

Navigate to the first child of the current node.

Navigate to the last child of the current node.

Navigate to the next sibling of the current node.

Navigate to the parent of the current node.

Navigate to the previous sibling of the current node.

Indicates the type of notification when calling RaiseNotificationEvent

The current element has a notification that an action was abandoned.

The current element has a notification that an action was completed.

The current element container has had something added to it that should be presented to the user.

The current element has had something removed from inside it that should be presented to the user.

The current element has a notification not an add, remove, completed, or aborted action.

Specifies the order in which to process a notification.

These notifications should be presented to the user when possible. All of the notifications from this source should be delivered to the user.

These notifications should be presented to the user when possible. Don’t interrupt the current notification for this one. If new notifications come in from the same source while the current notification is being presented, then keep the most recent and ignore the rest until the current processing is completed. Then use the most recent message as the current message.

These notifications should be presented to the user as soon as possible. All of the notifications from this source should be delivered to the user.

These notifications should be presented to the user as soon as possible. The most recent notifications from this source should be delivered to the user because the most recent notification supersedes all of the other notifications.

These notifications should be presented to the user when possible. Interrupt the current notification for this one.

Specifies the orientation direction in which a control can be presented. Values are used by GetOrientation.

The control is presented horizontally.

The control does not have an orientation.

The control is presented vertically.

Provides a base class that exposes the automation peer for an associated owner class to Microsoft UI Automation.

Provides base class initialization behavior for AutomationPeer derived classes.

Gets or sets an AutomationPeer that is reported to the automation client as the source for all the events that come from this AutomationPeer. See Remarks.

The AutomationPeer that is the source of events.

Generates a runtime identifier for the element that is associated with the automation peer.

The runtime identifier for the element .

Gets the accelerator key combinations for the object that is associated with the UI Automation peer.

The accelerator key.

Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API.

The accelerator key.

Gets the access key for the element that is associated with the automation peer.

The access key.

Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API.

The access key.

Gets a reference to the list of UI automation annotations for the current automation peer.

The list of UI automation annotations.

Provides the behavior of the peer when a Microsoft UI Automation client calls GetAnnotations or an equivalent Microsoft UI Automation client API.

The behavior of the peer.

Gets the control type for the element that is associated with the UI Automation peer.

The control type.

Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API.

The control type.

Gets the **AutomationId** of the element that is associated with the automation peer.

The automation identifier.

Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API.

The automation identifier.

Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.

The bounding rectangle.

Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API.

The bounding rectangle.

Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer.

The collection of AutomationPeer objects for child elements.

Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API.

The collection of AutomationPeer objects for child elements.

Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer.

The class name.

Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API.

The class name.

Gets a point on the element that is associated with the automation peer that responds to a mouse click.

A point in the clickable area of the element.

Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API.

A point within the clickable area of the element.

Provides the peer's behavior when a Microsoft UI Automation client calls GetControlledPeers or an equivalent Microsoft UI Automation client API such as getting a property value as identified by **UIA_ControllerForPropertyId**.

A list of the controlled peers for the current automation peer.

Gets a list of the controlled peers for the current automation peer.

A list of the controlled peers for the current automation peer.

Calls GetCultureCore to get the culture value for the element that is associated with the automation peer.

The value of the culture property for the element that is associated with the automation peer.

Gets the culture value for the element that is associated with the automation peer.

The value of the culture property for the element that is associated with the automation peer.

Gets a collection of elements that provide more information about the automation element.

A collection of elements that provide more information about the automation element.

Gets an element from the specified point.

The specified point. The element at the specified point.

Provides the behavior of the peer when a Microsoft UI Automation client calls GetElementFromPoint or an equivalent Microsoft UI Automation client API.

The specified point. The behavior of the peer.

Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsFrom or an equivalent Microsoft UI Automation client API.

A list of automation elements that suggests the reading order before the current automation element.

Provides the peer's behavior when a Microsoft UI Automation client calls GetFlowsTo or an equivalent Microsoft UI Automation client API.

A list of automation elements that suggests the reading order after the current automation element.

Gets the element that currently has the focus.

The element that currently has the focus.

Provides the behavior of the peer when a Microsoft UI Automation client calls GetFocusedElement or an equivalent Microsoft UI Automation client API.

The behavior of the peer.

Gets a localized string that describes the actual visual appearance or contents of something such as an image or image control.

A localized string that describes the actual visual appearance or contents of something such as an image or image control.

Provides the peer's behavior when a Microsoft UI Automation client calls GetFullDescription or an equivalent Microsoft UI Automation client API.

A localized string that describes the actual visual appearance or contents of something such as an image or image control.

Gets the heading level of the UI Automation element that is associated with this automation peer.

The text heading level.

Provides the peer's behavior when a Microsoft UI Automation client calls GetHeadingLevel or an equivalent Microsoft UI Automation client API.

The heading level.

Gets text that describes the functionality of the control that is associated with the automation peer.

The help text.

Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API.

The help text.

Gets text that conveys the visual status of the element that is associated with this automation peer.

The item status.

Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API.

The item status.

Gets a string that describes what kind of item an element represents.

The kind of item.

Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API.

The kind of item.

Gets the AutomationPeer for the UIElement that is targeted to the element.

The AutomationPeer for the element that is targeted by the UIElement.

Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API.

The AutomationPeer for the element that is targeted by the UIElement.

Gets the landmark type for this automation peer.

The landmark type for this automation peer.

Provides the peer's behavior when a Microsoft UI Automation client calls GetLandmarkType or an equivalent Microsoft UI Automation client API.

The landmark type.

Returns the 1-based integer for the level (hierarchy) of the element that is associated with the automation peer.

The 1-based integer for the level of the element.

Provides the behavior of the peer when a Microsoft UI Automation client calls GetLevel or an equivalent Microsoft UI Automation client API.

The behavior of the peer.

Gets the live setting notification behavior information for the object that is associated with the UI Automation peer.

A value of the enumeration.

Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API.

A value of the enumeration that reports the live setting notification behavior for a peer implementation.

Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer.

The type of the control.

Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API.

The type of the control, as a string that is localized to be suitable for direct presentation to users by assistive technology.

Gets a localized string that represents the AutomationLandmarkType value for the element that is associated with this automation peer.

The landmark type of the element.

Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedLandmarkType or an equivalent Microsoft UI Automation client API.

The landmark type of the peer, as a string that is localized to be suitable for direct presentation to users by assistive technology.

Gets text that describes the element that is associated with this automation peer. The Microsoft UI Automation **Name** value is the primary identifier used by most assistive technology when they represent your app's UI by interacting with the Microsoft UI Automation framework.

The name of the element that is the peer's owner, as used by assistive technology and other Microsoft UI Automation clients.

Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API.

The name as used by assistive technology and other Microsoft UI Automation clients.

Gets a value that indicates the explicit control orientation, if any.

The orientation of the control as a value of the enumeration.

Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API.

The orientation of the control.

Gets the AutomationPeer that is the parent of this AutomationPeer.

Consider using Navigate with AutomationNavigationDirection::Parent, which is an improved version of GetParent. For more info, see MSDN. The parent automation peer.

Gets the control pattern that is associated with the specified PatternInterface.

A value from the PatternInterface enumeration. The object that implements the pattern interface; null if the peer does not support this interface.

Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API.

A value from the PatternInterface enumeration. The object that implements the pattern interface; **null** if the peer does not support this interface.

Gets an AutomationPeer from the specified point.

Consider using GetElementFromPoint, which is an improved version of GetPeerFromPoint. For more info, see MSDN. The relative position of the target UI element in the UI. The AutomationPeer for the UI element at the specified point.

Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API.

The relative position of the target UI element in the UI. The AutomationPeer for the UI element at the specified point.

Returns the 1-based integer for the ordinal position in the set for the element that is associated with the automation peer.

The 1-based integer for the ordinal position in the set.

Provides the peer’s behavior when a Microsoft UI Automation client calls GetPositionInSet or an equivalent Microsoft UI Automation client API.

The peer’s behavior.

Returns the 1-based integer for the size of the set where the element that is associated with the automation peer is located.

The 1-based integer for the size of the set.

Provides the peer’s behavior when a Microsoft UI Automation client calls GetSizeOfSet or an equivalent Microsoft UI Automation client API.

The peer’s behavior.

Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus.

**true** if the element has keyboard focus; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API.

**true** if the element has keyboard focus; otherwise, **false**.

Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed.

Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user.

**true** if the element is a content element; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API.

**true** if the element is a content element; otherwise, **false**.

Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI.

**true** if the element is a control; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API.

**true** if the element is a control; otherwise, **false**.

Gets a Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element.

A Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element. The default return value is **true**.

Provides the peer’s behavior when a Microsoft UI Automation client accesses IsDataValidForForm or an equivalent Microsoft UI Automation client API.

A Boolean value that indicates whether the entered or selected value is valid for the form rule associated with the automation element.

Gets a value that indicates whether the element associated with this automation peer is a dialog window.

**true** if the element is a dialog; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsDialog or an equivalent Microsoft UI Automation client API.

**true** if the element is a dialog; otherwise, **false**.

Gets a value that indicates whether the element associated with this automation peer supports interaction.

**true** if the element supports interaction; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API.

**true** if the element can be interacted with; otherwise, **false**.

Gets a value that indicates whether the element can accept keyboard focus.

**true** if the element can accept keyboard focus; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API.

**true** if the element can accept keyboard focus; otherwise, **false**.

Gets a value that indicates whether an element is off the screen.

**true** if the element is not on the screen; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API.

**true** if the element is not on the screen; otherwise, **false**.

Gets a value that indicates whether the element contains sensitive content.

**true** if the element contains sensitive content such as a password; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API.

**true** if the element contains sensitive content; otherwise, **false**.

Gets a Boolean value that indicates whether the automation element represents peripheral UI.

A Boolean value that indicates whether the automation element represents peripheral UI.

Provides the peer’s behavior when a Microsoft UI Automation client accesses IsPeripheral or an equivalent Microsoft UI Automation client API.

A Boolean value that indicates whether the automation element represents peripheral UI.

Gets a value that indicates whether the element that is associated with this peer must be completed on a form.

**true** if the element must be completed; otherwise, **false**.

Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API.

**true** if the element must be completed; otherwise, **false**.

Gets a value that indicates whether Microsoft UI Automation reports that a client is listening for the specified event.

One of the enumeration values. **true** if Microsoft UI Automation reports a client is listening for the specified event; otherwise, **false**.

Gets the element in the specified direction within the UI automation tree.

The specified direction. The element in the specified direction within the UI automation tree.

Provides the peer’s behavior when a Microsoft UI Automation client calls Navigate or an equivalent Microsoft UI Automation client API.

The specified direction. The element in the specified direction within the UI automation tree.

Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.

The class that implements IRawElementProviderSimple. The AutomationPeer.

Gets the IRawElementProviderSimple proxy for the specified AutomationPeer.

The automation peer. The proxy.

Raises an automation event.

The event identifier for the event to raise, as a value of the enumeration. See AutomationEvents.

Initiates a notification event.

Specifies the type of the notification. Specifies the order in which to process the notification. A display string describing the event. A unique non-localized string to identify an action or group of actions. Use this to pass additional information to the event handler.

Raises an event to notify the automation client of a changed property value.

The property that changed. The previous value of the property. The new value of the property.

Raises an event to notify the Microsoft UI Automation core that the tree structure has changed.

The type of change that has occurred. The element to which the change has been made.

Raises an event to notify the Microsoft UI Automation core that a text control has programmatically changed text.

The type of change that was made to the text. The new text.

Sets the keyboard focus on the element that is associated with this automation peer.

Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API.

Sets the AutomationPeer that is the parent of this AutomationPeer.

The parent automation peer.

Shows the available context menu for the owner element.

Provides the peer's behavior when a Microsoft UI Automation client calls ShowContextMenu or an equivalent Microsoft UI Automation client API.

Represents a single UI automation annotation.

Initializes a new instance of the class.

Initializes a new instance of the class using the defined parameter.

The type of annotation.

Initializes a new instance of the class using the defined parameters.

The type of annotation. The automation peer of the element that implements the annotation.

Gets or sets the automation peer of the element that implements the annotation.

The automation peer of the element that implements the annotation.

Identifies the AutomationPeerAnnotation.Peer property.

The AutomationPeerAnnotation.Peer property.

Gets or sets the type of the annotation.

The type of the annotation.

Identifies the AutomationPeerAnnotation.Type property.

The AutomationPeerAnnotation.Type property.

Defines the types of change in the Microsoft UI Automation tree structure.

A child has been added to the current node.

A child has been removed from the current node.

Children have been bulk added to the current node.

Children have been bulk removed from the current node.

One or more children of the current node have been invalidated.

The children of the current node have been reordered.

Exposes AutoSuggestBox types to Microsoft UI Automation.

Initializes a new instance of the AutoSuggestBoxAutomationPeer class.

The owner element to create for.

Sends a request to submit the auto-suggest query to the AutoSuggestBox associated with the automation peer.

Exposes Button types to Microsoft UI Automation.

Initializes a new instance of the ButtonAutomationPeer class.

The owner element to create for.

Sends a request to click the button associated with the automation peer.

Represents a base class for exposing classes derived from ButtonBase to Microsoft UI Automation.

Provides base class initialization behavior for ButtonBase derived classes.

The owner element to create for.

Exposes CalendarDatePicker types to Microsoft UI Automation.

Initializes a new instance of the CalendarDatePickerAutomationPeer class.

The owner element to create for.

Gets a value that specifies whether the value of a control is read-only.

**true** if the control value can be set; otherwise, **false**.

Gets the value of the control.

The value of the control, as a string.

Sends a request to open the CalendarDatePicker associated with the automation peer.

Sets the value of a control, as an implementation of the IValueProvider pattern.

The value to set.

Exposes CaptureElement types to Microsoft UI Automation.

Initializes a new instance of the CaptureElementAutomationPeer class.

The CaptureElement instance to create the peer for.

Exposes CheckBox types to Microsoft UI Automation.

Initializes a new instance of the CheckBoxAutomationPeer class.

The owner element to create for.

Exposes **ColorPickerSlider ** types to Microsoft UI Automation.

Initializes a new instance of the **ColorPickerSliderAutomationPeer** class.

The **ColorPickerSlider ** control instance to create the peer for.

Exposes **ColorSpectrum ** types to Microsoft UI Automation.

Initializes a new instance of the **ColorSpectrumAutomationPeer** class.

The **ColorSpectrum ** control instance to create the peer for.

Exposes ComboBox types to Microsoft UI Automation.

Initializes a new instance of the ComboBoxAutomationPeer class.

The owner element to create for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Gets the interaction state of the ComboBox control.

The interaction state of the ComboBox control, as a value of the enumeration.

Gets a Boolean value indicating if the ComboBox control is modal.

A Boolean value indicating if the ComboBox control is modal.

Gets a value that specifies whether the value of a control is read-only.

**true** if the control value can be set; otherwise, **false**.

Gets a Boolean value indicating if the ComboBox control is topmost.

A Boolean value indicating if the ComboBox control is topmost.

Gets a Boolean value indicating if the ComboBox control can be maximized.

A Boolean value indicating if the ComboBox control can be maximized.

Gets a Boolean value indicating if the ComboBox control can be minimized.

A Boolean value indicating if the ComboBox control can be minimized.

Gets the value of the control.

The value of the control, as a string.

Gets the WindowVisualState for the ComboBox control.

The WindowVisualState for the ComboBox control, as a value of the enumeration.

Attempts to close the ComboBox control.

Hides all nodes, controls, or content that are descendants of the control.

Displays all child nodes, controls, or content of the control.

Sets the value of a control, as an implementation of the IValueProvider pattern.

The value to set.

Changes the visual state of the ComboBox control.

The visual state for the ComboBox control, as a value of the enumeration.

Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first.

The amount of time, in milliseconds, to wait for the associated process to become idle. The maximum is **Int32.MaxValue**. **true** if the window has entered the idle state; **false** if the time-out occurred.

Exposes the ComboBoxItem contents in a ComboBox to Microsoft UI Automation.

Initializes a new instance of the ComboBoxItemAutomationPeer class.

The ComboBoxItem to create the peer for.

Exposes the data content of a ComboBoxItem to Microsoft UI Automation.

Initializes a new instance of the ComboBoxItemDataAutomationPeer class.

The item data. The owner to create for.

Scrolls the content area of a parent container in order to display the peer owner's content within the visible region (viewport) of the container.

Exposes DatePicker types to Microsoft UI Automation.

Initializes a new instance of the DatePickerAutomationPeer class.

The DatePicker to create the peer for.

Exposes DatePickerFlyoutPresenter types to Microsoft UI Automation.

Exposes FlipView types to Microsoft UI Automation.

Initializes a new instance of the FlipViewAutomationPeer class.

The FlipView to create the peer for.

Exposes a FlipViewItem to Microsoft UI Automation.

Initializes a new instance of the FlipViewItemAutomationPeer class.

The FlipViewItem to create the peer for.

Exposes the data content of a FlipViewItem to Microsoft UI Automation.

Initializes a new instance of the FlipViewItemDataAutomationPeer class.

The item data. The owner to create for.

Scrolls the content area of a parent container in order to display the peer owner's content within the visible region (viewport) of the container.

Exposes FlyoutPresenter types to Microsoft UI Automation.

Initializes a new instance of the FlyoutPresenterAutomationPeer class.

The FlyoutPresenter to create the peer for.

Exposes FrameworkElement derived types (including all controls) to Microsoft UI Automation.

Initializes a new instance of the FrameworkElementAutomationPeer class.

The owner element to create for.

Gets the UIElement owner that is associated with this FrameworkElementAutomationPeer.

The element that owns this instance of the peer class.

Creates a FrameworkElementAutomationPeer for the specified UIElement.

The UIElement that is associated with this FrameworkElementAutomationPeer. A FrameworkElementAutomationPeer.

Returns the FrameworkElementAutomationPeer for the specified UIElement.

The UIElement that is associated with this FrameworkElementAutomationPeer. The FrameworkElementAutomationPeer, or null if the FrameworkElementAutomationPeer could not be created.

Exposes GridView types to Microsoft UI Automation.

Initializes a new instance of the GridViewAutomationPeer class.

The GridView to create a peer for.

Exposes GridViewHeaderItem types to Microsoft UI Automation.

Initializes a new instance of the GridViewHeaderItemAutomationPeer class.

The GridViewHeaderItem to create the peer for.

Exposes a GridViewItem to Microsoft UI Automation.

Initializes a new instance of the GridViewItemAutomationPeer class.

The owner element to create for.

Exposes GridView items to Microsoft UI Automation, using a data representation of the item so that the peer supports scrolling to that item with data awareness.

Initializes a new instance of the GridViewItemDataAutomationPeer class.

The specific data item. The automation peer for the GridView that contains the item.

Scrolls the content area of a container object in order to display the control within the visible region (viewport) of the container.

Exposes a GroupItem to Microsoft UI Automation.

Initializes a new instance of the GroupItemAutomationPeer class.

The GroupItem to create the peer for.

Exposes Hub types to Microsoft UI Automation.

Initializes a new instance of the HubAutomationPeer class.

The Hub to create the peer for.

Exposes HubSection types to Microsoft UI Automation.

Initializes a new instance of the HubSectionAutomationPeer class.

The HubSection to create the peer for.

Scrolls the content area of the parent container in order to display the item within the visible region (viewport) of the container.

Exposes HyperlinkButton types to Microsoft UI Automation.

Initializes a new instance of the HyperlinkButtonAutomationPeer class.

The owner element to create for.

Sends a request to click the hyperlink button associated with the automation peer.

Exposes Image types to Microsoft UI Automation.

Initializes a new instance of the ImageAutomationPeer class.

The Image to create a peer for.

Exposes InkToolbar types to Microsoft UI Automation.

Exposes a data item in an Items collection to Microsoft UI Automation.

Initializes a new instance of the ItemAutomationPeer class.

The specific item to create for. The items-control owner to create for.

Gets the data item in the Items collection that is associated with this ItemAutomationPeer.

The data item.

Gets the ItemsControlAutomationPeer that is associated with the ItemsControl that holds the Items collection.

The ItemsControlAutomationPeer associated with the ItemsControl that holds the Items collection.

Makes the virtual item fully accessible as a Microsoft UI Automation element.

Exposes ItemsControl types to Microsoft UI Automation.

Initializes a new instance of the ItemsControlAutomationPeer class.

The owner element to create for.

Creates a new instance of the ItemAutomationPeer for a data item in the Items collection of this ItemsControl.

The data item that is associated with this ItemAutomationPeer. The new ItemAutomationPeer created.

Retrieves an element by the specified property value.

The item in the container after which to begin the search. The property that contains the value to retrieve. The value to retrieve. The first item that matches the search criterion if such an item exists; otherwise, **null**.

Invoked whenever a new instance of the ItemAutomationPeer is created for a data item in the Items collection of this ItemsControl.

The data item that is associated with this ItemAutomationPeer. The new ItemAutomationPeer created.

Exposes ListBox types to Microsoft UI Automation.

Initializes a new instance of the ListBoxAutomationPeer class.

The owner element to create for.

Exposes the items in the Items collection of a ListBox to Microsoft UI Automation.

Initializes a new instance of the ListBoxItemAutomationPeer class.

The owner element to create for.

Exposes ListBox items to Microsoft UI Automation, using a data representation of the item so that the peer supports scrolling to that item with data awareness.

Initializes a new instance of the ListBoxItemDataAutomationPeer class.

The specific data item. The automation peer for the ListBox that contains the item.

Scrolls the content area of a container object in order to display the control within the visible region (viewport) of the container.

Exposes ListPickerFlyoutPresenter types to Microsoft UI Automation.

Exposes ListView types to Microsoft UI Automation.

Initializes a new instance of the ListViewAutomationPeer class.

The ListView to create a peer for.

A base class that provides a Microsoft UI Automation peer implementation for types that derive from ListViewBase.

Initializes a new instance of the ListViewBaseAutomationPeer class.

The ListViewBase derived object to create a peer for.

Gets a string that indicates what will happen when the item is dropped.

A string that indicates what will happen when the item is dropped.

Gets an array of strings that enumerates possible drop effects when this item is dropped.

An array of strings that enumerates possible drop effects when this item is dropped.

Exposes ListViewBaseHeaderItem types to Microsoft UI Automation.

Initializes a new instance of the ListViewBaseHeaderItemAutomationPeer class.

The ListViewBaseHeaderItem to create the peer for.

Exposes ListViewHeaderItem types to Microsoft UI Automation.

Initializes a new instance of the ListViewHeaderItemAutomationPeer class.

The ListViewHeaderItem to create the peer for.

Exposes a ListViewItem to Microsoft UI Automation.

Initializes a new instance of the ListViewItemAutomationPeer class.

The ListViewItem to create a peer for.

Exposes ListView items to Microsoft UI Automation, using a data representation of the item so that the peer supports scrolling to that item with data awareness.

Initializes a new instance of the ListViewItemDataAutomationPeer class.

The specific data item. The automation peer for the ListViewBase derived type that contains the item.

Scrolls the content area of the parent container in order to display the peer's data within the visible region (viewport) of the container.

Exposes LoopingSelector types to Microsoft UI Automation.

Gets a value that indicates whether the control allows more than one child element to be selected concurrently.

**true** if multiple selection is allowed; otherwise, **false**.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Gets a value that indicates whether the control can scroll horizontally.

**true** if the control can scroll horizontally; otherwise, **false**.

Gets the current horizontal scroll position.

The horizontal scroll position as a percentage of the total content area within the control.

Gets the current horizontal view size.

The horizontal size of the viewable region as a percentage of the total content area within the control.

Gets a value that indicates whether the control requires at least one child element to be selected.

**true** if selection is required; otherwise, **false**.

Gets a value that indicates whether the control can scroll vertically.

**true** if the control can scroll vertically; otherwise, **false**.

Gets the current vertical scroll position.

The vertical scroll position as a percentage of the total content area within the control.

Gets the current vertical view size.

The vertical size of the viewable region as a percentage of the total content area within the control.

Hides all nodes, controls, or content that are descendants of the control.

Displays all child nodes, controls, or content of the control.

Retrieves an element by the specified property value.

The item in the container after which to begin the search. The property that contains the value to retrieve. The value to retrieve. The first item that matches the search criterion if such an item exists; otherwise, **null**.

Retrieves a Microsoft UI Automation provider for each child element that is selected.

A generic list of Microsoft UI Automation providers.

Scrolls the visible region of the content area horizontally, vertically, or both.

The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction. The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction. The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

Exposes LoopingSelectorItem types to Microsoft UI Automation.

Gets a value that indicates whether an item is selected.

**true** if the element is selected; otherwise, **false**.

Gets the UI automation provider that implements ISelectionProvider and acts as the container for the calling object.

The provider that supports ISelectionProvider.

Adds the current element to the collection of selected items.

Removes the current element from the collection of selected items.

Scrolls the content area of the parent container in order to display the item within the visible region (viewport) of the container.

Clears any existing selection and then selects the current element.

Exposes the data content of a LoopingSelectorItem to Microsoft UI Automation.

Makes the virtual item fully accessible as a Microsoft UI Automation element.

Exposes MapControl types to Microsoft UI Automation.

Gets a Boolean value indicating if the associated map can be repositioned.

A Boolean value indicating if the associated map can be repositioned.

Gets a Boolean value indicating if the associated map can be resized.

A Boolean value indicating if the associated map can be resized.

Gets a Boolean value indicating if the associated map can be rotated.

A Boolean value indicating if the associated map can be rotated.

Get a Boolean value indicating if the associated map can be zoomed.

A Boolean value indicating if the associated map can be zoomed.

Gets a Boolean value indicating if the map is scrollable in a horizontal direction.

Boolean value indicating if the map is scrollable in a horizontal direction.

Gets a Double value indicating the percentage of how far the map has been scrolled horizontally.

A Double value indicating the percentage of how far the map has been scrolled horizontally.

Gets the horizontal size of the map view.

The horizontal size of the map view.

Gets the maximum zoom level for the associated map.

The maximum zoom level for the associated map.

Gets the minimum zoom level for the associated map.

The minimum zoom level for the associated map.

Gets a Boolean value indicating if the map is scrollable in a vetrical direction.

Boolean value indicating if the map is scrollable in a vertical direction.

Gets a Double value indicating the percentage of how far the map has been scrolled vertically.

A Double value indicating the percentage of how far the map has been scrolled vertically.

Gets the vertical size of the map view.

The vertical size of the map view.

Gets the zoom level of the associated map, which is a value between 1 and 20 in 2D views.

The zoom level of the associated map.

Moves the map by the specified horizontal and vertical amounts.

The amount to move the map horizontally. The amount to move the map vertically.

Resizes the associated map to the specified width and height.

The new width for the associated map. The new height for the associated map.

Rotates the map's camera from its current position.

The degrees that the map's camera rotates in a horizontal clockwise direction.

Scrolls the map by the specified horizontal and vertical amounts.

The amount to scroll the map horizontally. The amount to scroll the map vertically.

Sets the percentage that the map is scrolled both horizontally and vertically.

The percentage that the map is scrolled horizontally. The percentage that the map is scrolled vertically.

Zooms the associated map to the specified ZoomLevel.

The ZoomLevel to which to set the associated map.

Zooms the viewport of the associated map by the specified ZoomUnit.

The amount to zoom the viewport of the associated map.

Exposes MediaElement types to Microsoft UI Automation.

Initializes a new instance of the MediaElementAutomationPeer class.

The owner element to create for.

Exposes MediaPlayerElement types to Microsoft UI Automation.

Initializes a new instance of the MediaPlayerElementAutomationPeer class.

The MediaPlayerElement to create a peer for.

Exposes MediaTransportControls types to Microsoft UI Automation.

Initializes a new instance of the MediaTransportControlsAutomationPeer class using the specified media transport controls.

The specified media transport controls.

Exposes MenuBar types to Microsoft UI Automation.

Initializes a new instance of the MenuBarAutomationPeer class using the specified MenuBar.

The specified MenuBar.

Exposes MenuBarItem types to Microsoft UI Automation.

Initializes a new instance of the MenuBarItemAutomationPeer class using the specified MenuBarItem.

The specified MenuBarItem.

Gets the state, expanded or collapsed, of the MenuBarItem.

A value of the enumeration.

Hides all nodes, controls, or content that are descendants of the MenuBarItem.

Displays all child nodes, controls, or content of the MenuBarItem.

Sends a request to click the MenuBarItem associated with the automation peer.

Exposes MenuFlyoutItem types to Microsoft UI Automation.

Initializes a new instance of the MenuFlyoutItemAutomationPeer class.

The owner element to create for.

Sends a request to invoke the menu flyout associated with the automation peer.

Exposes MenuFlyoutPresenter types to Microsoft UI Automation.

Initializes a new instance of the MenuFlyoutPresenterAutomationPeer class.

The owner element to create for.

Exposes **NavigationViewItem ** types to Microsoft UI Automation.

Initializes a new instance of the **NavigationViewItemAutomationPeer** class.

The **NavigationViewItem ** control instance to create the peer for.

Exposes PasswordBox types to Microsoft UI Automation.

Initializes a new instance of the PasswordBoxAutomationPeer class.

The PasswordBox to create a peer for.

Specifies the control pattern that the GetPattern method returns.

The IAnnotationProvider interface.

The CustomNavigation control pattern interface.

The IDockProvider control pattern interface.

The IDragProvider interface.

The IDropTargetProvider interface.

The IExpandCollapseProvider control pattern interface.

The IGridProvider control pattern interface.

The IGridItemProvider control pattern interface.

The IInvokeProvider control pattern interface.

The IItemContainerProvider control pattern interface.

The IMultipleViewProvider control pattern interface.

**Introduced in .** The IObjectModelProvider interface.

The IRangeValueProvider control pattern interface.

The IScrollProvider control pattern interface.

The IScrollItemProvider control pattern interface.

The ISelectionProvider control pattern interface.

The ISelectionItemProvider control pattern interface.

**Introduced in .** The ISpreadsheetProvider interface.

**Introduced in .** The ISpreadsheetItemProvider interface.

**Introduced in .** The IStylesProvider interface.

**Introduced in .** The ISynchronizedInputProvider interface.

The ITableProvider control pattern interface.

The ITableItemProvider control pattern interface.

The ITextProvider control pattern interface.

The ITextProvider2 interface.

The ITextChildProvider interface.

The TextEdit control pattern interface.

The ITextRangeProvider interface.

The IToggleProvider control pattern interface.

The ITransformProvider control pattern interface.

**Introduced in .** The ITransformProvider2 interface.

The IValueProvider control pattern interface.

The IVirtualizedItemProvider control pattern interface.

The IWindowProvider control pattern interface.

Exposes **PersonPicture ** types to Microsoft UI Automation.

Initializes a new instance of the **PersonPictureAutomationPeer** class.

The **PersonPicture ** control instance to create the peer for.

Exposes PickerFlyoutPresenter types to Microsoft UI Automation.

Exposes Pivot types to Microsoft UI Automation.

Initializes a new instance of the PivotAutomationPeer class.

The Pivot to create a peer for.

Gets a value that indicates whether the control allows more than one child element to be selected concurrently.

**true** if multiple selection is allowed; otherwise, **false**.

Gets a value that indicates whether the control can scroll horizontally.

**true** if the control can scroll horizontally; otherwise, **false**.

Gets the current horizontal scroll position.

The horizontal scroll position as a percentage of the total content area within the control.

Gets the current horizontal view size.

The horizontal size of the viewable region as a percentage of the total content area within the control.

Gets a value that indicates whether the control requires at least one child element to be selected.

**true** if selection is required; otherwise, **false**.

Gets a value that indicates whether the control can scroll vertically.

**true** if the control can scroll vertically; otherwise, **false**.

Gets the current vertical scroll position.

The vertical scroll position as a percentage of the total content area within the control.

Gets the current vertical view size.

The vertical size of the viewable region as a percentage of the total content area within the control.

Retrieves a Microsoft UI Automation provider for each child element that is selected.

A generic list of Microsoft UI Automation providers.

Scrolls the visible region of the content area horizontally, vertically, or both.

The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction. The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction. The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

Exposes PivotItem types to Microsoft UI Automation.

Initializes a new instance of the PivotItemAutomationPeer class.

The PivotItem to create a peer for.

Exposes the data content of a PivotItem to Microsoft UI Automation.

Initializes a new instance of the PivotItemDataAutomationPeer class.

The specific data item. The automation peer for the Pivot object that contains the item.

Gets a value that indicates whether an item is selected.

**true** if the element is selected; otherwise, **false**.

Gets the UI automation provider that implements ISelectionProvider and acts as the container for the calling object.

The provider that supports ISelectionProvider.

Adds the current element to the collection of selected items.

Makes the virtual item fully accessible as a Microsoft UI Automation element.

Removes the current element from the collection of selected items.

Scrolls the content area of the parent container in order to display the item within the visible region (viewport) of the container.

Clears any existing selection and then selects the current element.

Exposes ProgressBar types to Microsoft UI Automation.

Initializes a new instance of the ProgressBarAutomationPeer class.

The ProgressBar to create a peer for.

Exposes ProgressRing types to Microsoft UI Automation.

Initializes a new instance of the ProgressRingAutomationPeer class.

The ProgressRing to create a peer for.

Exposes RadioButton types to Microsoft UI Automation.

Initializes a new instance of the RadioButtonAutomationPeer class.

The owner element to create for.

Gets a value that indicates whether an item is selected.

**true** if the element is selected; otherwise, **false**.

Gets the UI automation provider that implements ISelectionProvider and acts as the container for the calling object.

The provider that supports ISelectionProvider.

Adds the current element to the collection of selected items.

Removes the current element from the collection of selected items.

Clears any existing selection and then selects the current element.

A base class that provides a Microsoft UI Automation peer implementation for types that derive from RangeBase.

Initializes a new instance of the RangeBaseAutomationPeer class.

The owner element to create for.

Gets a value that indicates whether the value of a control is read-only.

**true** if the value is read-only; **false** if it can be modified.

Gets the value that is added to or subtracted from the Value property when a large change is made, such as with the PAGE DOWN key.

The large-change value supported by the control.

Gets the maximum range value that is supported by the control.

The maximum range value supported by the control.

Gets the minimum range value that is supported by the control.

The minimum range value supported by the control.

Gets the value that is added to or subtracted from the Value property when a small change is made, such as with an arrow key.

The small-change value supported by the control.

Gets the value of the control.

The value of the control.

Sets the value of the control, as an implementation of the IValueProvider pattern.

The value to set.

Exposes **RatingControl ** types to Microsoft UI Automation.

Initializes a new instance of the **RatingControlAutomationPeer** class.

The **RatingControl ** control instance to create the peer for.

Represents the runtime ID for an element.

The first part of the identifier.

The second part of the identifier.

Exposes RepeatButton types to Microsoft UI Automation.

Initializes a new instance of the RepeatButtonAutomationPeer class.

The owner element to create for.

Sends a request to click the repeat button associated with the automation peer.

Exposes RichEditBox types to Microsoft UI Automation.

Initializes a new instance of the RichEditBoxAutomationPeer class.

The owner element to create for.

Exposes RichTextBlock types to Microsoft UI Automation.

Initializes a new instance of the RichTextBlockAutomationPeer class.

The RichTextBlock to create a peer for.

Exposes RichTextBlockOverflow types to Microsoft UI Automation.

Initializes a new instance of the RichTextBlockOverflowAutomationPeer class.

The RichTextBlockOverflow to create a peer for.

Exposes ScrollBar types to Microsoft UI Automation.

Initializes a new instance of the ScrollBarAutomationPeer class.

The owner element to create for.

Exposes ScrollViewer types to Microsoft UI Automation.

Initializes a new instance of the ScrollViewerAutomationPeer class.

The ScrollViewer to create a peer for.

Gets a value that indicates whether the control can scroll horizontally.

**true** if the control can scroll horizontally; otherwise, **false**.

Gets the current horizontal scroll position.

The horizontal scroll position as a percentage of the total content area within the control.

Gets the current horizontal view size.

The horizontal size of the viewable region as a percentage of the total content area within the control.

Gets a value that indicates whether the control can scroll vertically.

**true** if the control can scroll vertically; otherwise, **false**.

Gets the current vertical scroll position.

The vertical scroll position as a percentage of the total content area within the control.

Gets the vertical view size.

The vertical size of the viewable region as a percentage of the total content area within the control.

Scrolls the visible region of the content area horizontally, vertically, or both.

The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction. The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction. The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

Exposes SearchBox types to Microsoft UI Automation.

Initializes a new instance of the SearchBoxAutomationPeer class.

The SearchBox to create a peer for.

A base class that provides a Microsoft UI Automation peer implementation for types that derive from Selector.

Initializes a new instance of the SelectorAutomationPeer class.

The owner Selector implementation to create for.

Gets a value that indicates whether the Microsoft UI Automation provider allows more than one child element to be selected concurrently.

**true** if multiple selection is allowed; otherwise, **false**.

Gets a value that indicates whether the Microsoft UI Automation provider requires at least one child element to be selected.

**true** if selection is required; otherwise, **false**.

Retrieves a Microsoft UI Automation provider for each child element that is selected.

A generic list of Microsoft UI Automation providers.

Exposes the items in a Selector to Microsoft UI Automation.

Initializes a new instance of the SelectorItemAutomationPeer class.

The specific item. The parent items control to create for.

Gets a value that indicates whether an item is selected.

**true** if the element is selected; otherwise, **false**.

Gets the UI Automation provider that implements ISelectionProvider and acts as container for the calling object.

The UI Automation provider.

Adds the current element to the collection of selected items.

Removes the current element from the collection of selected items.

Clears any existing selection and then selects the current element.

Exposes SemanticZoom types to Microsoft UI Automation.

Initializes a new instance of the SemanticZoomAutomationPeer class.

The SemanticZoom to create a peer for.

Gets a value that indicates whether the Toggle method can be called and result in a toggled view.

**true** if calling Toggle will result in a toggled view; otherwise, **false**.

Cycles through the toggle states of a control.

Exposes SettingsFlyout types to Microsoft UI Automation.

Initializes a new instance of the SettingsFlyoutAutomationPeer class.

The SettingsFlyout to create the peer for.

Exposes Slider types to Microsoft UI Automation.

Initializes a new instance of the SliderAutomationPeer class.

The Slider to create a peer for.

Exposes TextBlock types to Microsoft UI Automation.

Initializes a new instance of the TextBlockAutomationPeer class.

The TextBlock to create a peer for.

Exposes TextBox types to Microsoft UI Automation.

Initializes a new instance of the TextBoxAutomationPeer class.

The TextBox to create a peer for.

Exposes Thumb types to Microsoft UI Automation.

Initializes a new instance of the ThumbAutomationPeer class.

The Thumb to create a peer for.

Exposes TimePicker types to Microsoft UI Automation.

Initializes a new instance of the TimePickerAutomationPeer class.

The TimePicker to create the peer for.

Exposes TimePickerFlyoutPresenter types to Microsoft UI Automation.

Exposes ToggleButton types to Microsoft UI Automation.

Initializes a new instance of the ToggleButtonAutomationPeer class.

The ToggleButton to create a peer for.

Gets the toggle state of the control.

The toggle state of the control.

Cycles through the toggle states of a control.

Exposes ToggleMenuFlyoutItem types to Microsoft UI Automation.

Initializes a new instance of the ToggleMenuFlyoutItemAutomationPeer class.

The owner element to create for.

Gets the toggle state of the control.

The toggle state of the control.

Cycles through the toggle states of a control.

Exposes ToggleSwitch types to Microsoft UI Automation.

Initializes a new instance of the ToggleSwitchAutomationPeer class.

The ToggleSwitch to create a peer for.

Gets the toggle state of the control.

The toggle state of the control.

Cycles through the toggle states of a control.

Exposes **TreeViewItem ** types to Microsoft UI Automation.

Initializes a new instance of the **TreeViewItemAutomationPeer** class.

The **TreeViewItem ** control instance to create the peer for.

Gets a value indicating the expanded or collapsed state of the associated **TreeViewItem **.

The expanded or collapsed state of the associated **TreeViewItem **. The default value is **Expanded**.

Collapses the associated **TreeViewItem **.

Expands the associated **TreeViewItem **.

Exposes **TreeViewList ** types to Microsoft UI Automation.

Initializes a new instance of the **TreeViewListAutomationPeer** class.

The **TreeViewList ** control instance to create the peer for.

Exposes the properties of an annotation in a document. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Annotation.

Gets the annotation type identifier of this annotation.

The annotation type identifier of this annotation.

Gets the name of this annotation type.

The name of this annotation type.

Gets the name of the annotation author.

The name of the annotation author.

Gets the date and time when this annotation was created.

The date and time when this annotation was created.

Gets the UI Automation element that is being annotated.

The UI Automation element that is being annotated.

Exposes a method to support access by a Microsoft UI Automation client to controls that support a custom navigation order. Implement ICustomNavigationProvider to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.CustomNavigation.

Gets the next element in the specified direction within the logical UI tree.

The specified direction. The next element.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that expose their dock properties in a docking container. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Dock.

Gets the current DockPosition of the control in a docking container.

The DockPosition of the control, relative to the boundaries of the docking container and to other elements in the container.

Docks the control in a docking container.

The dock position, relative to the boundaries of the docking container and to other elements in the container.

Enables a Microsoft UI Automation element to describe itself as an element that can be dragged as part of a drag-and-drop operation. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Drag.

Gets a string that indicates what will happen when the item is dropped.

A string that indicates what will happen when the item is dropped.

Gets an array of strings that enumerates possible drop effects when this item is dropped.

An array of strings that enumerates possible drop effects when this item is dropped.

Gets a value indicating whether an item is currently being dragged.

**true** if the item is being dragged. Otherwise, **false**.

Gets an array of UI Automation elements that are being dragged as part of this drag operation.

An array of UI Automation elements that are being dragged. Null if this item is an individual item being dragged. Used to enable providers that support dragging multiple items at a time to create an intermediary IDragProvider that encapsulates all of the items being dragged.

Enables a Microsoft UI Automation element to describe itself as an element that can receive a drop of a dragged element as part of a drag-and-drop operation. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.DropTarget.

Gets a string that indicates what will happen when the item is dropped.

A string that indicates what will happen when the item is dropped.

Gets an array of strings that enumerates possible drop effects when this item is dropped.

An array of strings that enumerates possible drop effects when this item is dropped.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that visually expand to display content and that collapse to hide content. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.ExpandCollapse.

Gets the state (expanded or collapsed) of the control.

The state (expanded or collapsed) of the control.

Hides all nodes, controls, or content that are descendants of the control.

Displays all child nodes, controls, or content of the control.

Exposes methods and properties to support access by a Microsoft UI Automation client to individual child controls of containers that implement IGridProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.GridItem.

Gets the ordinal number of the column that contains the cell or item.

A zero-based ordinal number that identifies the column that contains the cell or item.

Gets the number of columns that are spanned by a cell or item.

The number of columns.

Gets a UI Automation provider that implements IGridProvider and that represents the container of the cell or item.

A UI Automation provider that implements the **Grid** control pattern and that represents the cell or item container.

Gets the ordinal number of the row that contains the cell or item.

A zero-based ordinal number that identifies the row that contains the cell or item.

Gets the number of rows spanned by a cell or item.

The number of rows.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that act as containers for a collection of child elements. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Grid.

Gets the total number of columns in a grid.

The total number of columns in a grid.

Gets the total number of rows in a grid.

The total number of rows in a grid.

Retrieves the UI Automation provider for the specified cell.

The ordinal number of the row that contains the cell. The ordinal number of the column that contains the cell. The UI Automation provider for the specified cell.

Exposes a method to support Microsoft UI Automation access to controls that initiate or perform a single, unambiguous action and do not maintain state when activated. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Invoke.

Sends a request to initiate or perform the single, unambiguous action of the provider control. For example, the invoke action for a Button is click.

Exposes a Microsoft UI Automation method to enable applications to find an element in a container, such as a virtualized list. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.ItemContainer.

Retrieves an element by the specified property value.

The item in the container after which to begin the search. The property that contains the value to retrieve. The value to retrieve. The first item that matches the search criterion; otherwise, null.

Exposes methods and properties to support Microsoft UI Automation client access to controls that provide, and are able to switch between, multiple representations of the same set of information or child controls. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.MultipleView.

Gets the current control-specific view.

The view identifier for the current view of the UI Automation element.

Retrieves a collection of control-specific view identifiers.

A collection of values that identifies the views available for a UI Automation element.

Retrieves the name of a control-specific view.

The view identifier. A localized name for the view.

Sets the current control-specific view.

A view identifier.

Provides access to the underlying object model implemented by a control or app.

Returns an interface used to access the underlying object model of the provider.

An untyped interface for accessing the underlying object model.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that can be set to a value within a range. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.RangeValue.

Gets a value that indicates whether the value of a control is read-only.

**true** if the value is read-only; **false** if it can be modified.

Gets the value that is added to or subtracted from the Value property when a large change is made, such as with the PAGE DOWN key.

The large-change value that is supported by the control, or null if the control does not support LargeChange.

Gets the maximum range value that is supported by the control.

The maximum value that is supported by the control, or null if the control does not support Maximum.

Gets the minimum range value that is supported by the control.

The minimum value that is supported by the control, or null if the control does not support Minimum.

Gets the value that is added to or subtracted from the Value property when a small change is made, such as with an arrow key.

The small-change value supported by the control, or null if the control does not support SmallChange.

Gets the value of the control.

The value of the control, or null if the control does not support Value.

Sets the value of the control.

The value to set.

Provides methods and properties that expose basic information about a UI element. IRawElementProviderSimple is a Windows Runtime class, not an interface.

Exposes methods and properties to support access by Microsoft UI Automation client to individual child controls of containers that implement IScrollProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.ScrollItem.

Scrolls the content area of a container object in order to display the control within the visible region (viewport) of the container.

Exposes methods and properties to support access by a Microsoft UI Automation client to a control that acts as a scrollable container for a collection of child objects. The children of this element must implement IScrollItemProvider. Implement IScrollProvider in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Scroll.

Gets a value that indicates whether the control can scroll horizontally.

**true** if the control can scroll horizontally; otherwise, **false**.

Gets the current horizontal scroll position.

The horizontal scroll position as a percentage of the total content area within the control.

Gets the current horizontal view size.

The horizontal size of the viewable region as a percentage of the total content area within the control.

Gets a value that indicates whether the control can scroll vertically.

**true** if the control can scroll vertically; otherwise, **false**.

Gets the current vertical scroll position.

The vertical scroll position as a percentage of the total content area within the control.

Gets the vertical view size.

The vertical size of the viewable region as a percentage of the total content area within the control.

Scrolls the visible region of the content area horizontally, vertically, or both.

The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction. The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction. The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.

Exposes methods and properties to support access by a Microsoft UI Automation client to individual, selectable child controls of containers that implement ISelectionProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.SelectionItem.

Gets a value that indicates whether an item is selected.

**true** if the element is selected; otherwise, **false**.

Gets the UI Automation provider that implements ISelectionProvider and acts as the container for the calling object.

The UI Automation provider.

Adds the current element to the collection of selected items.

Removes the current element from the collection of selected items.

Clears any existing selection and then selects the current element.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that act as containers for a collection of individual, selectable child items. The children of this element must implement ISelectionItemProvider. Implement ISelectionProvider in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.SelectionItem.

Gets a value that indicates whether the Microsoft UI Automation provider allows more than one child element to be selected concurrently.

**true** if multiple selection is allowed; otherwise, **false**.

Gets a value that indicates whether the UI Automation provider requires at least one child element to be selected.

**true** if selection is required; otherwise, **false**.

Retrieves a UI Automation provider for each child element that is selected.

An array of UI Automation providers.

Provides access to information about an item (cell) in a spreadsheet.

Gets the formula for this spreadsheet cell, as a string.

The formula for this cell, as a string.

Returns an array of objects that represent the annotations associated with this spreadsheet cell.

An array of IRawElementProviderSimple interfaces for Microsoft UI Automation elements that represent the annotations associated with the spreadsheet cell.

Returns an array of annotation type identifiers indicating the types of annotations that are associated with this spreadsheet cell.

An array of annotation type identifiers, which contains one entry for each type of annotation associated with the spreadsheet cell. For a list of possible values, see AnnotationType.

Provides access to items (cells) in a spreadsheet.

Returns a Microsoft UI Automation element that represents the spreadsheet cell that has the specified name.

The name of the target cell. A Microsoft UI Automation element that represents the target cell.

Provides access to the visual styles associated with the content of a document.

Gets a string value that contains additional property info. The info is for properties are that are not included in this control pattern, but that provide information about the document content that might be useful to the user.

A localized, formatted string that contains the list of extended properties. The string must be formatted as a list of name/value pairs, as follows: "prop1=value;prop2=value2".

Gets the fill color of an element in a document.

The fill color, represented as a Windows Runtime Color value.

Gets the color of the pattern used to fill an element in a document.

The color of the fill pattern, represented as a Windows Runtime Color value.

Gets a string that represents the fill pattern style of an element in a document.

A localized string that indicates the fill pattern style, such as "Vertical Stripe".

Gets a string that represents the shape of an element in a document.

A localized string that indicates the shape.

Gets the identifier for a visual style of an element in a document.

The style identifier. For a list of possible values, see Style Identifiers.

Gets the name of the visual style of an element in a document.

The name of the style, or empty string if the style has no name.

Enables Microsoft UI Automation client applications to direct the mouse or keyboard input to a specific UI element.

Cancels listening for input.

Starts listening for input of the specified type.

The type of input that is requested to be synchronized.

Exposes methods and properties to support Microsoft UI Automation client access to child controls of containers that implement ITableProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.TableItem.

Retrieves an array of UI Automation providers representing all the column headers associated with a table item or cell.

An array of UI Automation providers.

Retrieves an array of UI Automation providers representing all the row headers associated with a table item or cell.

An array of UI Automation providers.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that act as containers for a collection of child elements. The children of this element must implement ITableItemProvider and be organized in a two-dimensional logical coordinate system that can be traversed (a Microsoft UI Automation client can move to adjacent controls, which are headers or cells of the table) by using the keyboard.

Gets the primary direction of traversal for the table.

The primary direction of traversal, as a value of the enumeration.

Returns a collection of UI Automation providers that represents all the column headers in a table.

An array of UI Automation providers.

Returns a collection of UI Automation providers that represents all row headers in the table.

An array of UI Automation providers.

Provides access to a text-based control that is a child of another text-based control. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.TextChild.

Gets this element's nearest ancestor provider that supports the **Text** (ITextProvider ) control pattern.

The nearest ancestor provider that supports the **Text** (ITextProvider ) control pattern.

Gets a text range that encloses this child element.

A text range that encloses this child element.

Extends the ITextProvider interface to support access by a Microsoft UI Automation client to controls that support programmatic text-edit actions. Implement ITextEditProvider in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.TextEdit.

Gets the active composition.

The active composition.

Gets the current conversion target.

The current conversion target.

Exposes methods and properties to support Microsoft UI Automation client access to controls that contain text. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Text.

Gets a text range that encloses the main text of a document.

A text range that encloses the main text of a document.

Gets a value that specifies whether a text provider supports selection, and if it does, the type of selection that is supported.

A value of SupportedTextSelection.

Retrieves a collection of disjoint text ranges that are associated with the current text selection or selections.

A collection of disjoint text ranges.

Retrieves an array of disjoint text ranges from a text container. Each text range begins with the first partially visible line and ends with the last partially visible line.

The collection of visible text ranges within a container or an empty array. This method never returns null.

Retrieves a text range that encloses a child element, such as an image, hyperlink, or other embedded object.

The enclosed object. A range that spans the child element.

Retrieves a text range from the vicinity of a screen coordinate.

The coordinate screen location. A range that contains text.

Extends the ITextProvider interface to enable Microsoft UI Automation providers to expose textual content that is the target of an annotation or selection. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Text2.

Retrieves a zero-length text range at the location of the caret that belongs to the text-based control.

**true** if the text-based control that contains the caret has keyboard focus; otherwise, **false**. A text range that represents the current location of the caret that belongs to the text-based control.

Exposes a text range that contains the text that is the target of the annotation associated with the specified annotation element.

The provider for an element that implements the IAnnotationProvider interface. The annotation element is a sibling of the element that implements the ITextProvider2 interface for the document. A text range that contains the annotation target text.

Exposes methods and properties to support Microsoft UI Automation client access to a span of continuous text in a text container that implements ITextProvider.

Adds to the collection of highlighted text in a text container that supports multiple disjoint selections.

Returns a new ITextRangeProvider that is identical to the original ITextRangeProvider and that inherits all the properties of the original.

The new text range. This method never returns null.

Returns a value that indicates whether the start and end points of a text range are the same as another text range.

A text range to compare to the implementing peer's text range. **true** if the span of both text ranges is identical; otherwise, **false**.

Returns a value that indicates whether two text ranges have identical endpoints.

The **Start** or **End** endpoint of the caller. The target range for comparison. The **Start** or **End** endpoint of the target. Returns a negative value if the caller's endpoint occurs earlier in the text than the target endpoint. Returns zero if the caller's endpoint is at the same location as the target endpoint. Returns a positive value if the caller's endpoint occurs later in the text than the target endpoint.

Expands the text range to the specified text unit.

The text measure unit.

Returns a text range subset that has the specified attribute ID and attribute value.

The attribute ID to search for. The attribute value to search for. This value must match the type specified for the attribute. **true** if the last occurring text range should be returned instead of the first; otherwise, **false**. A text range that has a matching attribute ID and attribute value; otherwise **null**.

Returns a text range subset that contains the specified text.

The text string to search for. **true** to return the last occurring text range instead of the first; otherwise, **false**. **true** to ignore case; otherwise, **false**. A text range that matches the specified text; otherwise null.

Retrieves the value of the specified attribute ID across the text range.

The text attribute ID. Retrieves an object that represents the value of the specified attribute.

Retrieves a collection of bounding rectangles for each fully or partially visible line of text in a text range.

An array of bounding rectangles for each full or partial line of text in a text range. An empty array for a degenerate range. An empty array for a text range that has screen coordinates placing it completely off-screen, scrolled out of view, or obscured by an overlapping window.

Retrieves a collection of all the embedded objects that exist within the text range.

A collection of child objects that exist within the range. Child objects that overlap with the text range but are not completely enclosed by it are also included in the collection. Returns an empty collection if no child objects exist.

Returns the innermost element that encloses the text range.

The enclosing control, typically the text provider that provides the text range. However, if the text provider supports child text elements such as tables or hyperlinks, the enclosing element can be a descendant of the text provider.

Retrieves the plain text of the range.

The maximum length of the string to return. Use – 1 to specify an unlimited length. The plain text of the text range, which might represent a portion of the full string truncated at the specified *maxLength*.

Moves the text range the specified number of text units.

The text unit boundary. The number of text units to move. A positive value moves the text range forward; a negative value moves the text range backward; and a value of 0 has no effect. The number of units actually moved. This value can be less than the *count* requested if either of the new text range endpoints is greater than or less than the DocumentRange endpoints. This value can be negative if navigation is happening in the backward direction.

Moves one endpoint of a text range to the specified endpoint of a second text range.

The endpoint to move. Another range from the same text provider. An endpoint on the other range.

Moves one endpoint of the text range the specified number of text units within the document range.

The endpoint to move. The text measure unit for moving. The number of units to move. A positive value moves the endpoint forward. A negative value moves it backward. A value of 0 has no effect. The number of units actually moved, which can be less than the number requested if moving the endpoint runs into the beginning or end of the document.

From the collection of highlighted text in a text container that supports multiple disjoint selections, removes a highlighted section of text that corresponds to the caller's text range endpoints.

Causes the text control to scroll vertically until the text range is visible in the viewport.

**true** if the text control should be scrolled so that the text range is flush with the top of the viewport; **false** if the text range is flush with the bottom of the viewport.

Highlights text in the text control that corresponds to the start and end endpoints of the text range.

Extends the ITextRange interface to enable Microsoft UI Automation providers to programmatically open context menus that are contextual to text input operations.

Shows the available context menu for the owner element.

Exposes methods and properties to support Microsoft UI Automation client access to controls that can cycle through a set of states and maintain a particular state. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Toggle.

Gets the toggle state of the control.

The toggle state of the control, as a value of the enumeration.

Cycles through the toggle states of a control.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls or elements that can be moved, resized, or rotated within a two-dimensional space. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Transform.

Gets a value that indicates whether the element can be moved.

**true** if the element can be moved; otherwise, **false**.

Gets a value that indicates whether the element can be resized.

**true** if the element can be resized; otherwise, **false**.

Gets a value that indicates whether the element can be rotated.

**true** if the element can be rotated; otherwise, **false**.

Moves the control.

The absolute screen coordinates of the left side of the control. The absolute screen coordinates of the top of the control.

Resizes the control.

The new width of the window, in pixels. The new height of the window, in pixels.

Rotates the control.

The number of degrees to rotate the control. A positive number rotates the control clockwise. A negative number rotates the control counterclockwise.

Extends the ITransformProvider interface to enable Microsoft UI Automation providers to expose API to support the viewport zooming functionality of a control.

Gets a value that indicates whether the control supports zooming of its viewport.

**true** if the viewport can be zoomed; otherwise, **false**.

Gets the maximum zoom level of the element.

The maximum zoom level, as a percentage.

Gets the minimum zoom level of the element.

The minimum zoom level, as a percentage.

Gets the zoom level of the control's viewport.

The zoom level, specified as a percentage. The provider should zoom the viewport to the nearest supported value.

Zooms the viewport of the control.

The amount to zoom the viewport, specified as a percentage. The provider should zoom the viewport to the nearest supported value.

Zooms the viewport of the control by the specified logical unit.

The logical unit by which to increase or decrease the zoom of the viewport.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that have an intrinsic value that does not span a range and that can be represented as a string. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Value.

Gets a value that indicates whether the value of a control is read-only.

**true** if the value is read-only; **false** if it can be modified.

Gets the value of the control.

The value of the control.

Sets the value of a control.

The value to set. The provider is responsible for converting the value to the appropriate data type.

Exposes a method to support the virtualized item control pattern. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.VirtualizedItem.

Makes the virtual item fully accessible as a UI Automation element.

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that provide fundamental window-based functionality within a traditional graphical user interface (GUI). Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Window.

Gets the interaction state of the window.

The interaction state of the control, as a value of the enumeration.

Gets a value that specifies whether the window is modal.

**true** if the window is modal; otherwise, **false**.

Gets a value that specifies whether the window is the topmost element in the z-order of layout.

**true** if the window is topmost; otherwise, **false**.

Gets a value that specifies whether the window can be maximized.

**true** if the window can be maximized; otherwise, **false**.

Gets a value that specifies whether the window can be minimized.

**true** if the window can be minimized; otherwise, **false**.

Gets the visual state of the window.

The visual state of the window, as a value of the enumeration.

Closes the window.

Changes the visual state of the window (such as minimizing or maximizing it).

The visual state of the window to change to, as a value of the enumeration.

Blocks the calling code for the specified time or until the associated process enters an idle state, whichever completes first.

The amount of time, in milliseconds, to wait for the associated process to become idle. **true** if the window has entered the idle state; **false** if the timeout occurred.

Identifies text range endpoints for methods of ITextRangeProvider.

The endpoint of the range.

The start point of the range.

Represents predefined units of text for the purposes of navigation within a document.

Specifies that the text unit is one character in length.

Specifies that the text unit is an entire document in length.

Specifies that the text unit is the length of a single, common format specification, such as bold, italic, or similar.

Specifies that the text unit is one line in length.

Specifies that the text unit is one document-specific page in length.

Specifies that the text unit is one paragraph in length.

Specifies that the text unit is one word in length.

Provides data for the ScrollViewer.AnchorRequested event.

Gets or sets the *anchor element* to use when performing scroll anchoring.

The UIElement to use as the CurrentAnchor. The default is **null**.

Gets the set of anchor candidates that are currently registered with the scrolling control (for example, ScrollViewer).

A list of UIElement anchor candidates.

Represents the container control that holds app UI components for commanding and experiences. For Windows 10, see Remarks.

Initializes a new instance of the AppBar class.

Gets or sets a value that indicates whether icon buttons are displayed when the app bar is not completely open.

A value that indicates whether icon buttons are displayed when the app bar is not completely open.

Identifies the ClosedDisplayMode dependency property.

The identifier for the ClosedDisplayMode dependency property.

Gets or sets a value that indicates whether the AppBar is open.

**true** if the app bar is open; otherwise, **false**.

Identifies the IsOpen dependency property.

The identifier for the IsOpen dependency property.

Gets or sets a value that indicates whether the AppBar does not close on light dismiss.

**true** if the AppBar does not close on light dismiss. **false** if the AppBar is hidden on light dismiss.

Identifies the IsSticky dependency property.

The identifier for the IsSticky dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for an AppBar control.

An object that provides calculated values for templates.

Occurs when the AppBar changes from visible to hidden.

Occurs when the AppBar starts to change from visible to hidden.

Occurs when the AppBar changes from hidden to visible.

Occurs when the AppBar starts to change from hidden to visible.

Invoked when the AppBar changes from visible to hidden.

Event data for the event.

Invoked when the AppBar starts to change from visible to hidden.

Event data for the event.

Invoked when the AppBar changes from hidden to visible, or is first displayed.

Event data for the event.

Invoked when the AppBar starts to change from hidden to visible, or starts to be first displayed.

Event data for the event.

Represents a templated button control to be displayed in an AppBar.

Initializes a new instance of the AppBarButton class.

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

The order in which this item is moved to the overflow menu relative to other items.

Identifies the DynamicOverflowOrder dependency property.

The identifier for the DynamicOverflowOrder dependency property.

Gets or sets the graphic content of the app bar button.

The graphic content of the app bar button.

Identifies the Icon dependency property.

The identifier for the Icon dependency property.

Gets or sets a value that indicates whether the button is shown with no label and reduced padding.

**true** if the button is shown in its compact state; otherwise, **false**. The default is **false**.

Identifies the IsCompact dependency property.

The identifier for the IsCompact dependency property.

Gets a value that indicates whether this item is in the overflow menu.

**true** if this item is in the overflow menu; otherwise, **false**.

Identifies the IsInOverflow dependency property.

The identifier for the IsInOverflow dependency property.

Gets or sets a string that overrides the default key combination string associated with a keyboard accelerator.

The string to replace the default key combination string. The default is null.

Identifies the AppBarButton.KeyboardAcceleratorTextOverride dependency property.

The identifier for the AppBarButton.KeyboardAcceleratorTextOverride dependency property.

Gets or sets the text description displayed on the app bar button.

The text description displayed on the app bar button.

Gets or sets a value that indicates the placement and visibility of the button's label.

An enumeration value that specifies the placement and visibility of the button's label. The default is **Default**.

Identifies the LabelPosition dependency property.

The identifier for the LabelPosition dependency property.

Identifies the Label dependency property.

The identifier for the Label dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for an AppBarButton control.

An object that provides calculated values for templates.

Defines constants that specify whether icon buttons are displayed when an app bar is not completely open.

Icon buttons are displayed but labels are not visible.

The app bar is not displayed.

Only the ellipsis is displayed. Neither icon buttons nor labels are visible.

Represents a container that allows an element that doesn't implement ICommandBarElement to be displayed in a command bar.

Initializes a new instance of the AppBarElementContainer class.

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

The order in which this item is moved to the overflow menu relative to other items.

Identifies the DynamicOverflowOrder dependency property.

The identifier for the DynamicOverflowOrder dependency property.

Gets or sets a value that indicates whether the element is shown in its compact state.

**true** if the element is shown in its compact state; otherwise, **false**. The default is **false**.

Identifies the IsCompact dependency property.

The identifier for the IsCompact dependency property.

Gets a value that indicates whether this item is in the overflow menu.

**true** if this item is in the overflow menu; otherwise, **false**.

Identifies the IsInOverflow dependency property.

The identifier for the IsInOverflow dependency property.

Represents a line that separates items in an AppBar or CommandBar.

Initializes a new instance of the AppBarSeparator class.

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

The order in which this item is moved to the overflow menu relative to other items.

Identifies the DynamicOverflowOrder dependency property.

The identifier for the DynamicOverflowOrder dependency property.

Gets or sets a value that indicates whether the separator is shown with reduced padding.

**True** if the separator is shown in its compact state; otherwise, **false**. The default is **false**.

Identifies the IsCompact dependency property.

The identifier for the IsCompact dependency property.

Gets a value that indicates whether this item is in the overflow menu.

**true** if this item is in the overflow menu; otherwise, **false**.

Identifies the IsInOverflow dependency property.

The identifier for the IsInOverflow dependency property.

Represents a button control that can switch states and be displayed in an AppBar.

Initializes a new instance of the AppBarToggleButton class.

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

The order in which this item is moved to the overflow menu relative to other items.

Identifies the DynamicOverflowOrder dependency property.

The identifier for the DynamicOverflowOrder dependency property.

Gets or sets the graphic content of the app bar toggle button.

The graphic content of the app bar toggle button.

Identifies the Icon dependency property.

The identifier for the Icon dependency property.

Gets or sets a value that indicates whether the button is shown with no label and reduced padding.

**True** if the button is shown in its compact state; otherwise, **false**. The default is **false**.

Identifies the IsCompact dependency property.

The identifier for the IsCompact dependency property.

Gets a value that indicates whether this item is in the overflow menu.

**true** if this item is in the overflow menu; otherwise, **false**.

Identifies the IsInOverflow dependency property.

The identifier for the IsInOverflow dependency property.

Gets or sets a string that overrides the default key combination string associated with a keyboard accelerator.

The string to replace the default key combination string. The default is null.

Identifies the AppBarToggleButton.KeyboardAcceleratorTextOverride dependency property.

The identifier for the AppBarToggleButton.KeyboardAcceleratorTextOverride dependency property.

Gets or sets the text description displayed on the app bar toggle button.

The text description displayed on the app bar toggle button.

Gets or sets a value that indicates the placement and visibility of the button's label.

An enumeration value that specifies the placement and visibility of the button's label. The default is **Default**.

Identifies the LabelPosition dependency property.

The identifier for the LabelPosition dependency property.

Identifies the Label dependency property.

The identifier for the Label dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for an AppBarToggleButton control.

An object that provides calculated values for templates.

Represents a text control that makes suggestions to users as they enter text using a keyboard or pen (using ink and handwriting recognition). The app is notified when text has been changed by the user and is responsible for providing relevant suggestions for this control to display.

Initializes a new instance of the AutoSuggestBox class.

Indicates if the suggestion area should be automatically maximized.

A Boolean value that indicates if the suggestion area should be automatically maximized.

Identifies the AutoMaximizeSuggestionArea dependency property.

The identifier for the AutoMaximizeSuggestionArea dependency property.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets the header object for the text box portion of this control.

The header object for the text box portion of this control.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets a Boolean value indicating whether the drop-down portion of the AutoSuggestBox is open.

A Boolean value indicating whether the drop-down portion of the AutoSuggestBox is open.

Identifies the IsSuggestionListOpen dependency property.

Identifier for the IsSuggestionListOpen dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or set the maximum height for the drop-down portion of the AutoSuggestBox control.

The maximum height for the drop-down portion of the AutoSuggestBox control.

Identifies the MaxSuggestionListHeight dependency property.

Identifier for the MaxSuggestionListHeight dependency property.

Gets or sets the placeholder text to be displayed in the control.

The placeholder text to be displayed in the control. The default is an empty string.

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets or sets the graphic content of the button that is clicked to initiate a query.

The graphic content of the button that is clicked to initiate a query, if present; otherwise, **null**. The default is **null**.

Identifies the QueryIcon dependency property.

The identifier for the QueryIcon dependency property.

Gets or sets the text that is shown in the control.

The text that is shown in the control.

Gets or sets the style of the auto-suggest text box.

The style of the auto-suggest text box.

Identifies the TextBoxStyle dependency property.

Identifier for the TextBoxStyle dependency property.

Gets or sets the property path that is used to get the value for display in the text box portion of the AutoSuggestBox control, when an item is selected.

The property path that is used to get the value for display in the text box portion of the AutoSuggestBox control, when an item is selected.

Identifies the TextMemberPath dependency property.

Identifier for the TextMemberPath dependency property.

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Used in conjunction with TextMemberPath, gets or sets a value indicating whether items in the view will trigger an update of the editable text part of the AutoSuggestBox when clicked.

A value indicating whether items in the view will trigger an update of the editable text part of the AutoSuggestBox when clicked.

Identifies the UpdateTextOnSelect dependency property.

Identifier for the UpdateTextOnSelect dependency property.

Occurs when the user submits a search query.

Raised before the text content of the editable control component is updated.

Raised after the text content of the editable control component is updated.

Provides event data for the AutoSuggestBox.QuerySubmitted event.

Initializes a new instance of the AutoSuggestBoxQuerySubmittedEventArgs class.

Gets the suggested result that the user chose.

The suggested result that the user chose.

Gets the query text of the current search.

The query text of the current search.

Provides data for the SuggestionChosen event.

Initializes a new instance of the AutoSuggestBoxSuggestionChosenEventArgs class.

Gets a reference to the selected item.

A reference to the selected item.

Provides data for the TextChanged event.

Initializes a new instance of the AutoSuggestBoxTextChangedEventArgs class.

Gets or sets a value that indicates the reason for the text changing in the AutoSuggestBox.

The reason for the text changing in the AutoSuggestBox.

Identifies the Reason dependency property.

Identifier for the Reason dependency property.

Returns a Boolean value indicating if the current value of the TextBox is unchanged from the point in time when the TextChanged event was raised.

Indicates if the current value of the TextBox is unchanged from the point in time when the TextChanged event was raised.

Values used to indicate the reason for the text changing in the AutoSuggestBox.

The text was changed via code.

The user selected one of the items in the auto-suggestion box.

The user edited the text.

Provides event data for the SettingsFlyout.BackClick event.

Initializes a new instance of the BackClickEventArgs class.

Gets or sets a value that can cancel the navigation. A **true** value for Handled cancels the default behavior.

**true** to cancel the navigation. **false** to use default behavior. The default is **false**.

Represents the method that will handle a BackClick event.

The object where the handler is attached. Event data for the event.

Defines constants that specify how far an element's background extends in relation to the element's border.

The element's background extends to the inner edge of the border, but does not extend under the border.

The element's background extends under the border to its outer edge, and is visible if the border is transparent.

Represents an icon that uses a bitmap as its content.

Initializes a new instance of the BitmapIcon class.

Gets or sets a value that indicates whether the bitmap is shown in a single color.

**true** to show the bitmap in a single color; **false** to show the bitmap in full color. The default is **true.**

Identifies the ShowAsMonochrome dependency property.

The identifier for the **ShowAsMonochrome** dependency property.

Gets or sets the Uniform Resource Identifier (URI) of the bitmap to use as the icon content.

The Uri of the bitmap to use as the icon content. The default is **null**.

Identifies the UriSource dependency property.

The identifier for the UriSource dependency property.

Represents an icon source that uses a bitmap as its content.

Initializes a new instance of the BitmapIconSource class.

Gets or sets a value that indicates whether the bitmap is shown in a single color.

**true** to show the bitmap in a single color; **false** to show the bitmap in full color. The default is **true.**

Identifies the ShowAsMonochrome dependency property.

The identifier for the ShowAsMonochrome dependency property.

Gets or sets the Uniform Resource Identifier (URI) of the bitmap to use as the icon content.

The Uri of the bitmap to use as the icon content. The default is **null**.

Identifies the UriSource dependency property.

The identifier for the UriSource dependency property.

Draws a border, background, or both, around another object.

Initializes a new instance of the Border class.

Gets or sets the Brush that fills the background (inner area) of the border.

The brush that fills the background. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Gets or sets an instance of BrushTransition to automatically animate changes to the Background property.

An instance of BrushTransition to automatically animate changes to the Background; otherwise, **null**. The default is **null**.

Gets or sets the Brush that is applied to the edge area of the Border.

The brush that fills the border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the thickness of the border.

The thickness of the border, in pixels. The default is 0 on all four sides.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets or sets the child element to draw the border around.

The UIElement to apply the border to.

Gets or sets the collection of Transition style elements that apply to child content of a Border.

The strongly typed collection of Transition style elements.

Identifies the ChildTransitions dependency property.

The identifier for the ChildTransitions dependency property.

Gets or sets the radius for the corners of the border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Gets or sets the distance between the border and its child object.

The dimensions of the space between the border and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Represents a templated button control that interprets a Click user interaction.

Initializes a new instance of the Button class.

Gets or sets the flyout associated with this button.

The flyout associated with this button, if any; otherwise, **null**. The default is **null**.

Identifies the Flyout dependency property.

The identifier for the Flyout dependency property.

Represents a control that allows a user to pick a date from a calendar display.

Initializes a new instance of the CalendarDatePicker class.

Gets or sets the calendar system to use.

The name of the calendar system to use.

Identifies the CalendarIdentifier dependency property.

The identifier for the CalendarIdentifier dependency property.

Gets or sets the Style associated with the control's internal CalendarView object.

The current style of the CalendarView object.

Identifies the CalendarViewStyle dependency property.

The identifier for the CalendarViewStyle dependency property.

Gets or sets the date currently set in the calendar picker.

The date currently set in the calendar picker.

Gets or sets the display format for the date value in the picker's text box.

The string format to use to display the date in the picker's text box.

Identifies the DateFormat dependency property.

The identifier for the DateFormat dependency property.

Identifies the Date dependency property.

The identifier for the Date dependency property.

Gets or sets the display format for the day of the week headers in the picker's CalendarView.

The string format to use to display the day of the week headers in the picker's CalendarView.

Identifies the DayOfWeekFormat dependency property.

The identifier for the DayOfWeekFormat dependency property.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets a value that indicates whether the calendar shows selections for month, year, or decade in the picker's CalendarView.

A value of the enumeration that indicates whether the calendar shows selections for month, year, or decade. The default is **Month**.

Identifies the DisplayMode dependency property.

The identifier for the DisplayMode dependency property.

Gets or sets a value that indicates which day is shown as the first day of the week in the picker's CalendarView.

A value of the enumeration that indicates which day is shown as the first day of the week.

Identifies the FirstDayOfWeek dependency property.

The identifier for the FirstDayOfWeek dependency property.

Gets or sets the content for the calendar picker's header.

The content of the header. The default value is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the calendar view of the CalendarDatePicker is currently shown.

**true** if the calendar view is shown; otherwise, **false**. The default is **false**.

Identifies the IsCalendarOpen dependency property.

The identifier for the IsCalendarOpen dependency property.

Gets or sets a value that indicates whether the month name is shown with the first day of the month in the picker's CalendarView.

**true** if the month name is shown with the first day of the month; otherwise, **false**. The default is **true**.

Identifies the IsGroupLabelVisible  dependency property.

The identifier for the IsGroupLabelVisible   dependency property.

Gets or sets a value that indicates whether out-of-scope calendar items are shown with a unique foreground color in the picker's CalendarView.

**true** if out-of-scope calendar items are shown with a unique color; **false** if they are shown with the same color as in-scope items. The default is **true**.

Identifies the IsOutOfScopeEnabled dependency property.

The identifier for the IsOutOfScopeEnabled dependency property.

Gets or sets a value that indicates whether the current date is highlighted in the picker's CalendarView.

**true** if the current date is highlighted; otherwise, **false**. The default is **true**.

Identifies the IsTodayHighlighted dependency property.

The identifier for the IsTodayHighlighted dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets the latest date that can be set in the picker.

The latest date that can be set.

Identifies the MaxDate dependency property.

The identifier for the MaxDate dependency property.

Gets or sets the earliest date that can be set in the picker.

The earliest date that can be set.

Identifies the MinDate dependency property.

The identifier for the MinDate dependency property.

Gets or sets the text that is displayed in the picker's text box until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is entered. The default is an empty string ("").

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Occurs when a CalendarViewDayItem is loading in the picker's CalendarView.

Occurs when the picker's CalendarView is hidden.

Occurs when the date value is changed.

Occurs when the picker's CalendarView is shown.

Shows the specified date in the calendar picker.

The date to show.

Sets the number of rows and columns to use in the **Year** and **Decade** display modes of the picker's CalendarView.

The number of columns in the view. The number of rows in the view.

Provides event data for the DateChanged event.

Gets the date that is currently selected in the CalendarDatePicker.

The date that is currently selected in the CalendarDatePicker.

Gets the date that was previously selected in the CalendarDatePicker.

The date that was previously selected in the CalendarDatePicker.

Represents a control that enables a user to select a date by using a visual calendar display.

Initializes a new instance of the CalendarView class.

Gets or sets a brush that provides the foreground of a date that can't be selected.

A brush that provides the foreground of a date that can't be selected.

Identifies the BlackoutForeground  dependency property.

The identifier for the BlackoutForeground   dependency property.

Gets or sets the calendar system to use.

The calendar system to use.

Identifies the CalendarIdentifier  dependency property.

The identifier for the   CalendarIdentifier dependency property.

Gets or sets a brush that provides the background of a calendar item.

A brush that provides the background of a calendar item.

Identifies the CalendarItemBackground  dependency property.

The identifier for the CalendarItemBackground   dependency property.

Gets or sets a brush that provides the border of a calendar item.

A brush that provides the border of a calendar item.

Identifies the CalendarItemBorderBrush  dependency property.

The identifier for the CalendarItemBorderBrush   dependency property.

Gets or sets the thickness of a calendar item's border.

The thickness of a calendar item's border.

Identifies the CalendarItemBorderThickness  dependency property.

The identifier for the CalendarItemBorderThickness   dependency property.

Gets or sets a brush that provides the foreground of a calendar item.

A brush that provides the foreground of a calendar item.

Identifies the CalendarItemForeground  dependency property.

The identifier for the   CalendarItemForeground dependency property.

Gets or sets the Style associated with the control's internal CalendarViewDayItem object.

The Style associated with the control's internal CalendarViewDayItem object.

Identifies the CalendarViewDayItemStyle  dependency property.

The identifier for the CalendarViewDayItemStyle   dependency property.

Gets or sets the font used to display day values in the calendar.

The font used to display day values in the calendar.

Identifies the DayItemFontFamily  dependency property.

The identifier for the DayItemFontFamily   dependency property.

Gets or sets the font size used to display day values in the calendar.

The font size used to display day values in the calendar.

Identifies the DayItemFontSize  dependency property.

The identifier for the DayItemFontSize   dependency property.

Gets or sets the font style used to display day values in the calendar.

The font style used to display day values in the calendar.

Identifies the DayItemFontStyle  dependency property.

The identifier for the DayItemFontStyle   dependency property.

Gets or sets the font weight used to display day values in the calendar.

The font weight used to display day values in the calendar.

Identifies the DayItemFontWeight  dependency property.

The identifier for the DayItemFontWeight   dependency property.

Gets or sets the display format for the day of the week headers.

The display format for the day of the week header values.

Identifies the DayOfWeekFormat  dependency property.

The identifier for the DayOfWeekFormat   dependency property.

Gets or sets a value that indicates whether the calendar shows a picker for month, year, or decade.

A value of the enumeration that indicates whether the calendar shows a picker for month, year, or decade. The default is **Month**.

Identifies the DisplayMode  dependency property.

The identifier for the   DisplayMode dependency property.

Gets or sets a value that indicates which day is shown as the first day of the week.

A value of the enumeration that indicates which day is shown as the first day of the week.

Identifies the FirstDayOfWeek  dependency property.

The identifier for the   FirstDayOfWeek dependency property.

Gets or sets the font used to display the first-of-month banner in the calendar.

The font used to display the first-of-month banner in the calendar.

Identifies the FirstOfMonthLabelFontFamily  dependency property.

The identifier for the   FirstOfMonthLabelFontFamily dependency property.

Gets or sets the font size used to display the first-of-month banner in the calendar.

The font size used to display the first-of-month banner in the calendar.

Identifies the FirstOfMonthLabelFontSize  dependency property.

The identifier for the FirstOfMonthLabelFontSize   dependency property.

Gets or sets the font style used to display the first-of-month banner in the calendar.

The font style used to display the first-of-month banner in the calendar.

Identifies the FirstOfMonthLabelFontStyle  dependency property.

The identifier for the FirstOfMonthLabelFontStyle   dependency property.

Gets or sets the font weight used to display the first-of-month banner in the calendar.

The font weight used to display the first-of-month banner in the calendar.

Identifies the FirstOfMonthLabelFontWeight  dependency property.

The identifier for the FirstOfMonthLabelFontWeight   dependency property.

Gets or sets the font used to display the first-of-year banner in the calendar.

The font used to display the first-of-year banner in the calendar.

Identifies the FirstOfYearDecadeLabelFontFamily  dependency property.

The identifier for the FirstOfYearDecadeLabelFontFamily   dependency property.

Gets or sets the font size used to display the first-of-year banner in the calendar.

The font size used to display the first-of-year banner in the calendar.

Identifies the FirstOfYearDecadeLabelFontSize  dependency property.

The identifier for the FirstOfYearDecadeLabelFontSize   dependency property.

Gets or sets the font style used to display the first-of-year banner in the calendar.

The font style used to display the first-of-year banner in the calendar.

Identifies the FirstOfYearDecadeLabelFontStyle  dependency property.

The identifier for the FirstOfYearDecadeLabelFontStyle   dependency property.

Gets or sets the font weight used to display the first-of-year banner in the calendar.

The font weight used to display the first-of-year banner in the calendar.

Identifies the FirstOfYearDecadeLabelFontWeight  dependency property.

The identifier for the FirstOfYearDecadeLabelFontWeight   dependency property.

Gets or sets a brush that provides the border of a calendar item that has focus.

A brush that provides the border of a calendar item that has focus.

Identifies the FocusBorderBrush  dependency property.

The identifier for the FocusBorderBrush   dependency property.

Gets or sets the horizontal alignment of day items in the calendar.

An enumeration value that indicates the horizontal alignment of day items in the calendar.

Identifies the  HorizontalDayItemAlignment dependency property.

The identifier for the HorizontalDayItemAlignment   dependency property.

Gets or sets the horizontal alignment of the first-of-month banner text.

An enumeration value that indicates the horizontal alignment of the first-of-month banner text.

Identifies the HorizontalFirstOfMonthLabelAlignment  dependency property.

The identifier for the HorizontalFirstOfMonthLabelAlignment   dependency property.

Gets or sets a brush that provides the border of a calendar item while the pointer is over it.

A brush that provides the border of a calendar item while the pointer is over it.

Identifies the HoverBorderBrush  dependency property.

The identifier for the HoverBorderBrush   dependency property.

Gets or sets a value that indicates whether the month name is shown with the first day of the

**true** if the month name is shown with the first day of the month; otherwise, **false**. The default is **false**.

Identifies the IsGroupLabelVisible dependency property.

The identifier for the IsGroupLabelVisible dependency property.

Gets or sets a value that indicates whether out-of-scope calendar items are shown with a unique foreground color.

**true** if out-of-scope calendar items are shown with a unique color; **false** if they are shown with the same color as in-scope items. The default is **true**.

Identifies the IsOutOfScopeEnabled  dependency property.

The identifier for the IsOutOfScopeEnabled   dependency property.

Gets or sets a value that indicates whether the current date is highlighted.

**true** if the current date is highlighted; otherwise, **false**. The default is **true**.

Identifies the IsTodayHighlighted  dependency property.

The identifier for the IsTodayHighlighted   dependency property.

Gets or sets the last date to be displayed.

The last date to display.

Identifies the MaxDate  dependency property.

The identifier for the   MaxDate dependency property.

Gets or sets the first date to display.

The first date to display.

Identifies the MinDate  dependency property.

The identifier for the   MinDate dependency property.

Gets or sets the font used to display the month and year items in the calendar.

The font used to display the month and year items in the calendar.

Identifies the MonthYearItemFontFamily  dependency property.

The identifier for the MonthYearItemFontFamily   dependency property.

Gets or sets the font size used to display the month and year items in the calendar.

The font size used to display the month and year items in the calendar.

Identifies the MonthYearItemFontSize  dependency property.

The identifier for the   MonthYearItemFontSize dependency property.

Gets or sets the font style used to display the month and year items in the calendar.

The font style used to display the month and year items in the calendar.

Identifies the MonthYearItemFontStyle  dependency property.

The identifier for the MonthYearItemFontStyle   dependency property.

Gets or sets the font weight used to display the month and year items in the calendar.

The font weight used to display the month and year items in the calendar.

Identifies the MonthYearItemFontWeight  dependency property.

The identifier for the MonthYearItemFontWeight   dependency property.

Gets or sets the number of weeks shown in the calendar view.

The number of weeks shown in the calendar view. The default is 6.

Identifies the NumberOfWeeksInView  dependency property.

The identifier for the NumberOfWeeksInView   dependency property.

Gets or sets a brush that provides the background of a date that's out of scope.

A brush that provides the background of a date that's out of scope.

Identifies the OutOfScopeBackground  dependency property.

The identifier for the   OutOfScopeBackground dependency property.

Gets or sets a brush that provides the foreground of calendar items that are outside the current scope (month, year, or decade).

A brush that provides the foreground of calendar items that are outside the current scope.

Identifies the  OutOfScopeForeground dependency property.

The identifier for the OutOfScopeForeground   dependency property.

Gets or sets a brush that provides the border of a calendar item while it's pressed.

A brush that provides the border of a calendar item while it's pressed.

Identifies the PressedBorderBrush  dependency property.

The identifier for the PressedBorderBrush   dependency property.

Gets or sets a brush that provides the foreground of a calendar item while it's pressed.

A brush that provides the foreground of a calendar item while it's pressed.

Identifies the PressedForeground  dependency property.

The identifier for the PressedForeground   dependency property.

Gets or sets a brush that provides the border of the currently selected calendar item.

A brush that provides the border of the currently selected calendar item.

Identifies the  SelectedBorderBrush dependency property.

The identifier for the SelectedBorderBrush   dependency property.

Gets a collection of selected dates.

A collection that contains the currently selected dates. The default is an empty collection.

Identifies the SelectedDates  dependency property.

The identifier for the   SelectedDates dependency property.

Gets or sets a brush that provides the foreground of a calendar item that's selected.

A brush that provides the foreground of a calendar item that's selected.

Identifies the SelectedForeground  dependency property.

The identifier for the SelectedForeground   dependency property.

Gets or sets a brush that provides the border of a selected calendar item while the pointer is over it.

A brush that provides the border of a selected calendar item while the pointer is over it.

Identifies the  SelectedHoverBorderBrush dependency property.

The identifier for the SelectedHoverBorderBrush   dependency property.

Gets or sets a brush that provides the border of a selected calendar item while it's pressed.

A brush that provides the border of a selected calendar item while it's pressed.

Identifies the  SelectedPressedBorderBrush dependency property.

The identifier for the   SelectedPressedBorderBrush dependency property.

Gets or sets a value that indicates what kind of selections are allowed.

An enumeration value that indicates the current selection mode. The default is **Single**.

Identifies the SelectionMode  dependency property.

The identifier for the SelectionMode   dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for a CalendarView control.

An object that provides calculated values for templates.

Identifies the TemplateSettings  dependency property.

The identifier for the TemplateSettings   dependency property.

Gets or sets the font weight used to display the current date in the calendar.

The font weight used to display the current date in the calendar.

Identifies the TodayFontWeight  dependency property.

The identifier for the TodayFontWeight   dependency property.

Gets or sets a brush that provides the foreground of the calendar item for the current date.

A brush that provides the foreground of the calendar item for the current date.

Identifies the TodayForeground  dependency property.

The identifier for the TodayForeground   dependency property.

Gets or sets the vertical alignment of day items in the calendar.

An enumeration value that indicates the vertical alignment of day items in the calendar.

Identifies the VerticalDayItemAlignment  dependency property.

The identifier for the VerticalDayItemAlignment   dependency property.

Gets or sets the vertical alignment of the first-of-month banner text.

An enumeration value that indicates the vertical alignment of the first-of-month banner text.

Identifies the VerticalFirstOfMonthLabelAlignment  dependency property.

The identifier for the VerticalFirstOfMonthLabelAlignment   dependency property.

Occurs when a CalendarViewDayItem is loading.

Occurs when the collection of selected dates is changed.

Shows the specified date in the calendar.

The date to show in the calendar.

Sets the number of rows and columns to use in the Year and Decade display modes.

The number of columns in the view. The number of rows in the view.

Represents a day on a CalendarView.

Initializes a new instance of the CalendarViewDayItem class.

Gets the date represented by this item.

The date represented by this item.

Identifies the Date  dependency property.

The identifier for the Date  dependency property.

Gets or sets a value that indicates whether the date is unavailable.

**true** if the date unavailable; otherwise, **false**. The default is **false**.

Identifies the IsBlackout  dependency property.

The identifier for the IsBlackout  dependency property.

Sets the collection of Color values used to display the density bar.

The collection of Color values used to display the density bar.

Provides data for the CalendarViewDayItemChanging event.

Gets a value that indicates whether this container is in the recycle queue of the CalendarView and is not being used to visualize a calendar item.

**true** if the container is in the recycle queue of the CalendarView; otherwise, **false**.

Gets the calendar day item associated with this container.

The CalendarViewDayItem associated with this container, or **null** if no item is associated with this container.

Gets the number of times this container and day item pair has been called.

The number of times this container and day item pair has been called.

Registers the event handler to be called again during the specified phase.

The phase during which the callback should occur. The event handler function.

Registers the event handler to be called again during the next phase.

The event handler function.

Represents the method that will handle the CalendarViewDayItemChanging event.

The object where the event handler is attached. The event data.

Defines constants that specify which view of the calendar is shown.

The decade selector view is shown.

The month view is shown.

The year selector view is shown.

Provides data for the SelectedDatesChanged event.

Gets a collection that contains the items that were selected.

The items that were selected since the last time the SelectedDatesChanged event occurred.

Gets a collection that contains the items that were unselected.

The items that were unselected since the last time the SelectedDatesChanged event occurred.

Defines constants that specify what kind of date selections are allowed in the calendar.

One or more dates can be selected at a time.

Date selection is disabled.

One date can be selected at a time.

Defines constants that specify how the Input Method Editor (IME) window for text predictions is aligned with a text edit control.

When the hardware keyboard is used, the Input Method Editor (IME) aligns to the bottom edge and left side of the text edit control. When the Soft Input Panel (SIP) is used, the Input Method Editor (IME) is docked to the Soft Input Panel (SIP).

When the hardware keyboard is used, the Input Method Editor (IME) follows the cursor. When the Soft Input Panel (SIP) is used, the Input Method Editor (IME) is docked to the Soft Input Panel (SIP).

Provides event data for the **CandidateWindowBoundsChanged** event.

Gets the Rect that defines the size and location of the Input Method Editor (IME) window, in the coordinate space of the text edit control.

The Rect that defines the size and location of the Input Method Editor (IME) window

Defines an area within which you can explicitly position child objects, using coordinates that are relative to the Canvas area.

Initializes a new instance of the Canvas class.

Identifies the Canvas.Left XAML attached property.

The identifier for the Canvas.Left XAML attached property.

Identifies the Canvas.Top XAML attached property.

The identifier for the Canvas.Top XAML attached property.

Identifies the Canvas.ZIndex XAML attached property.

The identifier for the Canvas.ZIndex XAML attached property.

Gets the value of the Canvas.Left XAML attached property for the target element.

The object from which the property value is read. The Canvas.Left XAML attached property value of the specified object.

Gets the value of the Canvas.Top XAML attached property for the target element.

The object from which the property value is read. The Canvas.Top XAML attached property value of the specified object.

Gets the value of the Canvas.ZIndex XAML attached property for the target element.

The object from which the property value is read. The Canvas.ZIndex XAML attached property value of the requested object.

Sets the value of the Canvas.Left XAML attached property for a target element.

The object to which the property value is written. The value to set.

Sets the value of the Canvas.Top XAML attached property for a target element.

The object to which the property value is written. The value to set.

Sets the value of the Canvas.ZIndex XAML attached property for a target element.

The object to which the property value is written. The value to set.

Renders a stream from a capture device, such as a camera or webcam. CaptureElement is used in conjunction with the Windows.Media.Capture.MediaCapture API, and must be hooked up in the code behind.

Initializes a new instance of the CaptureElement class.

Gets or sets the source MediaCapture that this CaptureElement represents.

The source MediaCapture

Identifies the Source dependency property.

The identifier for the Source dependency property.

Gets or sets how content from Source is resized to fill its allocated space, as declared by the Height and Width properties of the CaptureElement.

A value of the enumeration.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Defines constants that specify how a control modifies the case of characters as they are typed.

Characters are changed to lowercase.

The case of characters is left unchanged.

Characters are changed to uppercase.

Represents a control that a user can select (check) or clear (uncheck). A CheckBox can also report its value as indeterminate.

Initializes a new instance of the CheckBox class.

Provides event data for the ListViewBase.ChoosingGroupHeaderContainer event.

Initializes a new instance of the ChoosingGroupHeaderContainerEventArgs class.

Gets the data group associated with this GroupHeaderContainer.

The data group associated with this GroupHeaderContainer.

Gets or sets the UI container that will be used to display the current data group.

The UI container that will be used to display the current data group.

Gets the index in the ItemsSource of the data group for which a container is being selected.

The index in the ItemsSource of the data group for which a container is being selected.

Provides event data for the ListViewBase.ChoosingItemContainer event.

Initializes a new instance of the ChoosingItemContainerEventArgs class.

Gets or sets a value that indicates whether the container is ready for use.

**true** if the container is ready for use; otherwise, **false**.

Gets the data item associated with this ItemContainer.

The data item associated with this ItemContainer.

Gets or sets the UI container that will be used to display the current data item.

The UI container that will be used to display the current data item.

Gets the index in the ItemsSource of the data item for which a container is being selected.

The index in the ItemsSource of the data item for which a container is being selected.

Provides data for the CleanUpVirtualizedItemEvent event.

Gets or sets a value that indicates whether this item should not be revirtualized.

**true** if you want to prevent revirtualization of this item; otherwise, **false**.

Gets an instance of the visual element that represents the data value.

The UIElement that represents the data value.

Gets an object that represents the original data value.

The Object that represents the original data value.

Represents the method that handles the CleanUpVirtualizedItemEvent attached event.

The source of the event. The event data.

Specifies when the Click event should be raised for a control.

Specifies that the Click event should be raised when the mouse pointer moves over the control.

Specifies that the Click event should be raised when the mouse button is pressed and the mouse pointer is over the control. If you are using the keyboard, specifies that the Click event should be raised when the SPACEBAR or ENTER key is pressed and the control has keyboard focus.

Specifies that the Click event should be raised when the left mouse button is pressed and released, and the mouse pointer is over the control. If you are using the keyboard, specifies that the Click event should be raised when the SPACEBAR or ENTER key is pressed and released, and the control has keyboard focus.

Provides event data for the ColorChanged event.

Gets the color that is currently selected in the control.

The color that is currently selected in the control.

Gets the color that was previously selected in the control.

The color that was previously selected in the control.

Represents a control that lets a user pick a color using a color spectrum, sliders, and text input.

Initializes a new instance of the ColorPicker class.

Gets or sets the current color value.

The current color value.

Identifies the Color dependency property.

The identifier for the Color dependency property.

Gets or sets a value that indicates how the Hue-Saturation-Value (HSV) color components are mapped onto the ColorSpectrum.

A value of the enumeration. The default is **HueSaturation**.

Identifies the ColorSpectrumComponents dependency property.

The identifier for the ColorSpectrumComponents dependency property.

Gets or sets a value that indicates whether the ColorSpectrum is shown as a square or a circle.

A value of the enumeration. The default is **Box**, which shows the spectrum as a square.

Identifies the ColorSpectrumShape dependency property.

The identifier for the ColorSpectrumShape dependency property.

Gets or sets a value that indicates whether the alpha channel can be modified.

**true** if the alpha channel is enabled; otherwise, **false**. The default is **false**.

Identifies the IsAlphaEnabled dependency property.

The identifier for the IsAlphaEnabled dependency property.

Gets or sets a value that indicates whether the slider control for the alpha channel is shown.

**true** if the alpha channel slider is shown; otherwise, **false**. The default is **true**.

Identifies the IsAlphaSliderVisible dependency property.

The identifier for the IsAlphaSliderVisible dependency property.

Gets or sets a value that indicates whether the text input box for the alpha channel is shown.

**true** if the alpha channel text input box is shown; otherwise, **false**. The default is **true**.

Identifies the IsAlphaTextInputVisible dependency property.

The identifier for the IsAlphaTextInputVisible dependency property.

Gets or sets a value that indicates whether the text input boxes for the color channels are shown.

**true** if the color channel text input boxes are shown; otherwise, **false**. The default is **true**.

Identifies the IsColorChannelTextInputVisible dependency property.

The identifier for the IsColorChannelTextInputVisible dependency property.

Gets or sets a value that indicates whether the color preview bar is shown.

**true** if the color preview bar is shown; otherwise, **false**. The default is **true**.

Identifies the IsColorPreviewVisible dependency property.

The identifier for the IsColorPreviewVisible dependency property.

Gets or sets a value that indicates whether the slider control for the color value is shown.

**true** if the color slider is shown; otherwise, **false**. The default is **true**.

Identifies the IsColorSliderVisible dependency property.

The identifier for the IsColorSliderVisible dependency property.

Gets or sets a value that indicates whether the color spectrum control is shown.

**true** if the color spectrum is shown; otherwise, **false**. The default is **true**.

Identifies the IsColorSpectrumVisible dependency property.

The identifier for the IsColorSpectrumVisible dependency property.

Gets or sets a value that indicates whether the text input box for a HEX color value is shown.

**true** if the HEX color text input box is shown; otherwise, **false**. The default is **true**.

Identifies the IsHexInputVisible dependency property.

The identifier for the IsHexInputVisible dependency property.

Gets or sets a value that indicates whether the 'more' button is shown.

**true** if the 'more' button is shown; otherwise, **false**. The default is **false**.

Identifies the IsMoreButtonVisible dependency property.

The identifier for the IsMoreButtonVisible dependency property.

Gets or sets the maximum Hue value in the range 0-359.

The maximum Hue value in the range 0-359. The default is 359.

Identifies the MaxHue dependency property.

The identifier for the MaxHue dependency property.

Gets or sets the maximum Saturation value in the range 0-100.

The maximum Saturation value in the range 0-100. The default is 100.

Identifies the MaxSaturation dependency property.

The identifier for the MaxSaturation dependency property.

Gets or sets the maximum Value value in the range 0-100.

The maximum Value value in the range 0-100. The default is 100.

Identifies the MaxValue dependency property.

The identifier for the MaxValue dependency property.

Gets or sets the minimum Hue value in the range 0-359.

The minimum Hue value in the range 0-359. The default is 0.

Identifies the MinHue dependency property.

The identifier for the MinHue dependency property.

Gets or sets the minimum Saturation value in the range 0-100.

The minimum Saturation value in the range 0-100. The default is 100.

Identifies the MinSaturation dependency property.

The identifier for the MinSaturation dependency property.

Gets or sets the minimum Value value in the range 0-100.

The minimum Value value in the range 0-100. The default is 100.

Identifies the MinValue dependency property.

The identifier for the MinValue dependency property.

Gets or sets the previous color.

The previous color. The default is **null**.

Identifies the PreviousColor dependency property.

The identifier for the PreviousColor dependency property.

Occurs when the Color property has changed.

Defines contstants that specify which Hue-Saturation-Value-Alpha component a slider in a ColorPicker controls.

The slider controls the Alpha channel.

The slider controls the Hue channel.

The slider controls the Saturation channel.

The slider controls the Value channel.

Defines constants that specify how the Hue-Saturation-Value (HSV) color components are mapped onto the ColorSpectrum.

Hue is mapped to the X axis. Saturation is mapped to the Y axis.

Hue is mapped to the X axis. Value is mapped to the Y axis.

Saturation is mapped to the X axis. Hue is mapped to the Y axis.

Saturation is mapped to the X axis. Value is mapped to the Y axis.

Value is mapped to the X axis. Hue is mapped to the Y axis.

Value is mapped to the X axis. Saturation is mapped to the Y axis.

Defines constants that specify how the ColorSpectrum control is shown.

The ColorSpectrum control is shown as a square.

The ColorSpectrum control is shown as a circle.

Defines column-specific properties that apply to Grid objects.

Initializes a new instance of the ColumnDefinition class.

Gets a value that represents the actual calculated width of a ColumnDefinition.

A Double that represents the actual calculated width in pixels. The default is 0.

Gets or sets a value that represents the maximum width of a ColumnDefinition.

A Double that represents the maximum width in pixels. The default is PositiveInfinity.

Identifies the MaxWidth dependency property.

The identifier for the MaxWidth dependency property.

Gets or sets a value that represents the minimum width of a ColumnDefinition.

A Double that represents the minimum width in pixels. The default is 0.

Identifies the MinWidth dependency property.

The identifier for the MinWidth dependency property.

Gets the calculated width of a ColumnDefinition element, or sets the GridLength value of a column that is defined by the ColumnDefinition.

The GridLength that represents the width of the column. The default value is a GridLength representing a "1\*" sizing.

Identifies the Width dependency property.

The identifier for the Width dependency property.

Provides access to an ordered, strongly typed collection of ColumnDefinition objects.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the ColumnDefinition located at the specified index.

The integer index for the value to retrieve. The ColumnDefinition value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The item to find in the collection. The index of the item, if it is found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the ColumnDefinition value specified.

The index at which to set the value. The value to set.

Represents a selection control that combines a non-editable text box and a drop-down list box that allows users to select an item from a list.

Initializes a new instance of the ComboBox class.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the drop-down portion of the ComboBox is currently open.

**True** if the drop-down portion is open; otherwise, **false**. The default is **false**.

Identifies the IsDropDownOpen dependency property.

The identifier for the IsDropDownOpen dependency property.

Gets or sets a value that indicates whether the user can edit text in the text box portion of the ComboBox. See remarks.

**true** if the user can edit text in the ComboBox, otherwise **false**. The default is **false**. See remarks.

Identifies the IsEditable dependency property.

The identifier for the IsEditable dependency property.

Gets a value that indicates whether the SelectionBoxItem component is highlighted.

**True** if the SelectionBoxItem is highlighted; otherwise, **false**. The default is **true**.

Gets or sets a value that specifies whether a user can jump to a value by typing.

**true** if a user can jump to a value by typing; otherwise, **false**. The default is **true**.

Identifies the IsTextSearchEnabled dependency property.

The identifier for the IsTextSearchEnabled dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets the maximum height for a combo box drop-down.

The maximum height of the drop-down. The default is infinity.

Identifies the MaxDropDownHeight dependency property.

The identifier for the MaxDropDownHeight dependency property.

Gets or sets a brush that describes the color of placeholder text.

The brush that describes the color of placeholder text.

Identifies the PlaceholderForeground dependency property.

The identifier for the PlaceholderForeground dependency property.

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is selected. The default is an empty string ("").

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets the item shown when the ComboBox is closed.

The item shown when the ComboBox is closed.

Gets the template applied to the selection box content.

The template applied to the selection box content.

Gets or sets a value that indicates what action causes a SelectionChanged event to occur.

A value of the enumeration. The default is **Committed**.

Identifies the SelectionChangedTrigger dependency property.

The identifier for the **SelectionChangedTrigger** dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a ComboBox control.

An object that provides calculated values for templates.

Gets or sets the text in the ComboBox.

Gets or sets the style of the TextBox in the ComboBox when the ComboBox is editable.

The style of the TextBox in the ComboBox when the ComboBox is editable.

Identifies the TextBoxStyle dependency property.

The identifier for the TextBoxStyle dependency property.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Occurs when the drop-down portion of the ComboBox closes.

Occurs when the drop-down portion of the ComboBox opens.

Occurs when the user submits some text that does not correspond to an item in the ComboBox dropdown list.

Invoked when the DropDownClosed event is raised.

Event data for the event.

Invoked when the DropDownOpened event is raised.

Event data for the event.

Represents the container for an item in a ComboBox control.

Initializes a new instance of the ComboBoxItem class.

Defines constants that specify what action causes a SelectionChanged event to occur.

A change event occurs each time the user navigates to a new selection in the combo box.

A change event occurs when the user commits a selection in the combo box.

Provides data when the user enters custom text into the ComboBox.

Gets or sets whether the TextSubmitted event was handled or not. If **true**, the framework will not automatically update the selected item of the ComboBox to the new value.

Gets the custom text value entered by the user.

Represents a specialized app bar that provides layout for AppBarButton and related command elements.

Initializes a new instance of the CommandBar class.

Gets or sets the Style applied to the overflow content of the CommandBar.

The applied Style for the overflow content of the CommandBar, if present; otherwise, **null**. The default is **null**.

Identifies the CommandBarOverflowPresenterStyle dependency property.

The identifier for the CommandBarOverflowPresenterStyle dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for a CommandBar control.

An object that provides calculated values for templates.

Gets or sets a value that indicates the placement and visibility of the labels on the command bar's buttons.

An enumeration value that indicates the placement and visibility of the labels on the command bar's buttons. The default is **Bottom**.

Identifies the DefaultLabelPosition dependency property.

The identifier for the DefaultLabelPosition dependency property.

Gets or sets a value that indicates whether primary commands automatically move to the overflow menu when space is limited.

**true** if primary commands automatically move to the overflow menu when space is limited; otherwise, **false**. The default is **true**.

Identifies the IsDynamicOverflowEnabled dependency property.

The identifier for the IsDynamicOverflowEnabled dependency property.

Gets or sets a value that indicates when a command bar's overflow button is shown.

An enumeration value that indicates when a command bar's overflow button is shown. The default is **Auto**.

Identifies the OverflowButtonVisibility dependency property.

The identifier for the OverflowButtonVisibility dependency property.

Gets the collection of primary command elements for the CommandBar.

The collection of primary command elements for the CommandBar. The default is an empty collection.

Identifies the PrimaryCommands dependency property.

The identifier for the PrimaryCommands dependency property.

Gets the collection of secondary command elements for the CommandBar.

The collection of secondary command elements for the CommandBar. The default is an empty collection.

Identifies the SecondaryCommands dependency property.

The identifier for the SecondaryCommands dependency property.

Occurs when items move into or out of the overflow menu.

Defines constants that specify the placement and visibility of AppBarButton labels in a CommandBar.

App bar button labels are shown below the icon. Labels are visible only when the command bar is open.

App bar button labels are always hidden whether the command bar is open or closed.

App bar button labels are shown to the right of the icon. Labels are visible even when the command bar is closed.

Defines constants that specify whether items were added to or removed from the CommandBar overflow menu.

Items are added to the overflow menu.

Items are removed from the overflow menu.

Represents a specialized flyout that provides layout for AppBarButton and related command elements.

Initializes a new instance of the CommandBarFlyout class.

Gets the collection of primary command elements for the CommandBarFlyout.

The collection of primary command elements for the CommandBarFlyout. The default is an empty collection.

Gets the collection of secondary command elements for the CommandBarFlyout.

The collection of secondary command elements for the CommandBarFlyout. The default is an empty collection.

Defines constants that specify the placement and visibility of an app bar button's label.

The app bar button's label is always hidden whether the command bar is open or closed.

The placement and visibility of the app bar button's label is determined by the value of the CommandBar.DefaultLabelPosition property.

Defines constants that specify when a command bar's overflow button is shown.

The overflow button automatically hides when there are no secondary commands and the closed state of the CommandBar is the same as the open state.

The overflow button is never shown.

The overflow button is always shown.

Displays the overflow content of a CommandBar.

Initializes a new instance of the CommandBarOverflowPresenter class.

Provides data for the ContainerContentChanging event.

Initializes a new instance of the ContainerContentChangingEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets a value that indicates whether this container is in the recycle queue of the ListViewBase and is not being used to visualize a data item.

**true** if the container is in the recycle queue of the ListViewBase; otherwise, **false**.

Gets the data item associated with this container.

The data item associated with this container, or **null** if no data is associated with this container.

Gets the UI container used to display the current data item.

The UI container used to display the current data item.

Gets the index in the ItemsSource of the data item associated with this container.

The index in the ItemsSource of the data item associated with this container. The default is -1.

Gets the number of times this container and data item pair has been called.

The number of times this container and data item pair has been called.

Registers the event handler to be called again during the specified phase.

The phase during which the callback should occur. The event handler function.

Registers the event handler to be called again during the next phase.

The event handler function.

Represents a control with a single piece of content. Controls such as Button, CheckBox, and ScrollViewer directly or indirectly inherit from this class.

Initializes a new instance of the ContentControl class.

Gets or sets the content of a ContentControl.

An object that contains the control's content. The default is **null**.

Identifies the Content dependency property.

The identifier for the Content dependency property.

Gets or sets the data template that is used to display the content of the ContentControl.

The data template that is used to display the content of the ContentControl.

Identifies the ContentTemplate dependency property

The identifier for the ContentTemplate dependency property.

Gets the root element of the data template specified by the ContentTemplate property.

The root element of the data template specified by the ContentTemplate property. The default is **null**.

Gets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time.

A selection object that changes the DataTemplate to apply for content.

Identifies the ContentTemplateSelector dependency property.

The identifier for the ContentTemplateSelector dependency property.

Gets or sets the collection of Transition style elements that apply to the content of a ContentControl.

The strongly typed collection of Transition style elements.

Identifies the ContentTransitions dependency property.

The identifier for the ContentTransitions dependency property.

Invoked when the value of the Content property changes.

The old value of the Content property. The new value of the Content property.

Invoked when the value of the ContentTemplate property changes.

The old value of the ContentTemplate property. The new value of the ContentTemplate property.

Invoked when the value of the ContentTemplateSelector property changes.

The old value of the ContentTemplateSelector property. The new value of the ContentTemplateSelector property.

Represents a dialog box that can be customized to contain checkboxes, hyperlinks, buttons and any other XAML content.

Initializes a new instance of the ContentDialog class.

Gets or sets the command to invoke when the close button is tapped.

The command to invoke when the primary button is tapped.

Gets or sets the parameter to pass to the command for the close button.

The parameter to pass to the command for the close button. The default is **null.**

Gets the identifier of the CloseButtonCommandParameter dependency property.

The identifier of the CloseButtonCommandParameter dependency property.

Gets the identifier of the CloseButtonCommand dependency property.

The identifier of the CloseButtonCommand dependency property.

Gets or sets the Style to apply to the dialog's close button.

The applied style for the button, if present; otherwise, **null**.

Gets the identifier of the CloseButtonStyle dependency property.

The identifier of the CloseButtonStyle dependency property.

Gets or sets the text to display on the close button.

The text to display on the close button.

Gets the identifier of the CloseButtonText dependency property.

The identifier of the CloseButtonText dependency property.

Gets or sets a value that indicates which button on the dialog is the default action.

A value of the enumeration. The default is **None.**

Gets the identifier of the DefaultButton dependency property.

The identifier of the DefaultButton dependency property.

Gets or sets a value that indicates whether a request is being made to display the dialog full screen.

**true** to request that the dialog is displayed full screen; otherwise, **false**. The default is **false**.

Gets the identifier of the FullSizeDesired dependency property.

The identifier of the FullSizeDesired dependency property.

Gets or sets whether the dialog's primary button is enabled.

True if the primary button of the dialog is enabled; Otherwise, false.

Gets the identifier of the IsPrimaryButtonEnabled dependency property.

The identifier of the IsPrimaryButtonEnabled dependency property.

Gets or sets whether the dialog's secondary button is enabled.

True if the secondary button of the dialog is enabled; Otherwise, false.

Gets the identifier of the IsSecondaryButtonEnabled dependency property.

The identifier of the IsSecondaryButtonEnabled dependency property.

Gets or sets the command to invoke when the primary button is tapped.

The command to invoke when the primary button is tapped.

Gets or sets the parameter to pass to the command for the primary button.

The parameter to pass to the command for the primary button. The default is null.

Gets the identifier of the PrimaryButtonCommandParameter dependency property.

The identifier of the PrimaryButtonCommandParameter dependency property

Gets the identifier of the PrimaryButtonCommand dependency property.

The identifier of the PrimaryButtonCommand dependency property.

Gets or sets the Style to apply to the dialog's primary button.

The applied style for the button, if present; otherwise, **null**.

Gets the identifier of the PrimaryButtonStyle dependency property.

The identifier of the PrimaryButtonStyle dependency property.

Gets or sets the text to display on the primary button.

The text to display on the primary button. To hide this button, set the text to **null** or string.empty. The default is empty.

Gets the identifier of the PrimaryButtonText dependency property.

The identifier of the PrimaryButtonText dependency property.

Gets or sets the command to invoke when the secondary button is tapped.

The command to invoke when the secondary button is tapped.

Gets or sets the parameter to pass to the command for the secondary button.

The command parameter for the secondary button. The default is null.

Gets the identifier of the SecondaryButtonCommandParameter dependency property.

The identifier of the SecondaryButtonCommandParameter dependency property.

Gets the identifier of the SecondaryButtonCommand dependency property.

The identifier of the SecondaryButtonCommand dependency property.

Gets or sets the Style to apply to the dialog's secondary button.

The applied style for the button, if present; otherwise, **null**.

Gets the identifier of the SecondaryButtonStyle dependency property.

The identifier of the SecondaryButtonStyle dependency property.

Gets or sets the text to be displayed on the secondary button.

The text to be displayed on the secondary button. To hide this button, set the value to **null** or **string.empty**.

Gets the identifier of the SecondaryButtonText dependency property.

The identifier of the SecondaryButtonText dependency property.

Gets or sets the title of the dialog.

The title of the dialog.

Gets the identifier of the Title dependency property.

The identifier of the Title dependency property.

Gets or sets the title template.

The title template.

Gets the identifier of the TitleTemplate dependency property.

The identifier of the TitleTemplate dependency property.

Occurs after the close button has been tapped.

Occurs after the dialog is closed.

Occurs after the dialog starts to close, but before it is closed and before the Closed event occurs.

Occurs after the dialog is opened.

Occurs after the primary button has been tapped.

Occurs after the secondary button has been tapped.

Hides the dialog.

Begins an asynchronous operation to show the dialog.

An asynchronous operation showing the dialog. When complete, returns a ContentDialogResult.

Begins an asynchronous operation to show the dialog with the specified placement.

A value that specifies whether the dialog is placed in the PopupRoot or in its parent's visual tree. An asynchronous operation showing the dialog. When complete, returns a ContentDialogResult.

Defines constants that specify the default button on a content dialog.

The close button is the default.

No button is specified as the default.

The primary button is the default.

The secondary button is the default.

Represents a deferral that can be used by an app to respond asynchronously to a button click event.

Notifies the system that the app has finished processing the button click event.

Provides data for the button click events.

Gets or sets a value that can cancel the button click. A **true** value for Cancel cancels the default behavior.

True to cancel the button click; Otherwise, false.

Gets a ContentDialogButtonClickDeferral that the app can use to respond asynchronously to a button click event.

A ContentDialogButtonClickDeferral that the app can use to respond asynchronously to a button click event.

Provides data for the Closed event.

Gets the ContentDialogResult of the button click event.

The result of the button click event.

Represents a deferral that can be used by an app to respond asynchronously to the closing event of the ContentDialog.

Notifies the system that the app has finished processing the closing event.

Provides data for the closing event.

Gets or sets a value that can cancel the closing of the dialog.. A **true** value for Cancel cancels the default behavior.

True to cancel the closing of the dialog; Otherwise, false.

Gets the ContentDialogResult of the closing event.

The ContentDialogResult of the closing event.

Gets a ContentDialogClosingDeferral that the app can use to respond asynchronously to the closing event.

A ContentDialogClosingDeferral that the app can use to respond asynchronously to the closing event.

Provides data for the Opened event.

Defines constants that specify where in the XAML visual tree a ContentDialog is rooted.

If the dialog has a parent element, the dialog is rooted in the parent's visual tree. Otherwise, it falls back to the **Popup** behavior.

The dialog is rooted in the PopupRoot element of the XAML Window.

Specifies identifiers to indicate the return value of a ContentDialog

No button was tapped.

The primary button was tapped by the user.

The secondary button was tapped by the user.

Provides data for the RichEditBox.ContentLinkChanged event.

Gets a value that indicates how the content link is changed.

An enumeration value that indicates how the content link is changed.

Gets an object that contains information about the content link.

An object that contains information about the content link.

Gets the text range that contains the content link.

The text range that contains the content link.

Defines constants that specify what kind of change is being made to a ContentLink.

The content link is being changed.

The content link is being added.

The content link is being removed.

Displays the content of a ContentControl. Can also provide content presentation for non-controls. Provides a base class for specialized presenters such as ScrollContentPresenter.

Initializes a new instance of the ContentPresenter class.

Gets or sets the Brush to apply to the background of content handled by the ContentPresenter.

The brush used as the background brush for the contents. The default is a null brush from a pure code perspective, but system style defaults set this to White (for **Light** theme) or Black (for **Dark** theme).

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Gets or sets an instance of BrushTransition to automatically animate changes to the Background property.

An instance of BrushTransition to automatically animate changes to the Background; otherwise, **null**. The default is **null**.

Gets or sets a brush that describes the border fill of the content presenter.

The brush that is used to fill the content presenter's border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the border thickness of the content presenter.

The border thickness of the content presenter, as a Thickness value.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Identifies the CharacterSpacing dependency property.

The identifier for the CharacterSpacing dependency property.

Gets or sets the data that is used to generate the child elements of a ContentPresenter.

The data that is used to generate the child elements. The default is null.

Identifies the Content dependency property

The identifier for the Content dependency property.

Gets or sets the template that is used to display the content of the control.

A DataTemplate that defines the visualization of the content. The default is null.

Identifies the ContentTemplate dependency property.

The identifier for the ContentTemplate dependency property.

Gets or sets a selection object that changes the DataTemplate to apply for content presented in the ContentPresenter, based on processing information about the content item or its container at run time.

A selection object that changes the DataTemplate to apply for content.

Identifies the ContentTemplateSelector dependency property.

The identifier for the ContentTemplateSelector dependency property.

Gets or sets the collection of Transition style elements that apply to content presented by the ContentPresenter.

The strongly typed collection of Transition style elements.

Identifies the ContentTransitions dependency property.

The identifier for the ContentTransitions dependency property.

Gets or sets the radius for the corners of the content presenter's border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Gets or sets the preferred top-level font family for the text content presented by the ContentPresenter.

A FontFamily object that specifies the preferred font family, or a primary preferred font family with one or more fallback font families. For information about defaults, see the FontFamily class topic.

Identifies the FontFamily  dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the font size for the text content presented by the ContentPresenter.

A non-negative value that specifies the font size, measured in pixels.

Identifies the FontSize  dependency property.

The identifier for the FontSize dependency property.

Gets or sets the font stretch for the text content presented by the ContentPresenter.

The requested font stretch, as a FontStretch constant. The default is Normal.

Identifies the FontStretch  dependency property.

The identifier for the FontStretch dependency property.

Gets or sets the font style for the presented content.

The requested font style, which is a FontStyle constant name. The default is Normal.

Identifies the FontStyle  dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the top-level font weight for the text content presented by the ContentPresenter.

The requested font weight, which is a FontWeight that is obtained from one of the FontWeights property values. The default is Normal.

Identifies the FontWeight  dependency property.

The identifier for the FontWeight dependency property.

Gets or sets the Brush to apply to the text content handled by the ContentPresenter.

The brush used as the foreground brush for the text contents. The default is a null brush from a pure code perspective, but system style defaults set this to Black (for **Light** theme) or White (for **Dark** theme).

Identifies the Foreground  dependency property.

The identifier for the Foreground dependency property.

Gets or sets the horizontal alignment of the content.

One of the HorizontalAlignment values.

Identifies the HorizontalContentAlignment dependency property.

The identifier for the HorizontalContentAlignment dependency property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets the height of each line of text content presented by the ContentPresenter.

The height in pixels of each line of text content. A value of 0 indicates that the line height is determined automatically from the current font characteristics. The default is 0.

Identifies the LineHeight  dependency property.

The identifier for the LineHeight dependency property.

Gets or sets a value that indicates how a line box is determined for each line of text.

A value that indicates how a line box is determined for each line of text. The default is **MaxHeight**.

Identifies the LineStackingStrategy dependency property.

The identifier for the LineStackingStrategy dependency property.

Gets or sets the maximum lines of text shown.

The maximum lines of text shown. The default is 0, which is a special value that represents "Auto" behavior. The value cannot be negative.

Identifies the MaxLines dependency property.

The identifier for the MaxLines dependency property.

Get or sets a value that indicates how the font is modified to align with fonts of different sizes.

A value of the enumeration that indicates how the font is modified to align at different sizes. The default is **None**.

Identifies the OpticalMarginAlignment dependency property.

The identifier for the OpticalMarginAlignment dependency property.

Gets or sets the distance between the border and its child object.

The dimensions of the space between the border and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Gets or sets a value that indicates how the line box height is determined for each line of text displayed in the ContentPresenter.

A value that indicates how the line box height is determined for each line of text. The default is **Full**.

Identifies the TextLineBounds dependency property.

The identifier for the TextLineBounds dependency property.

Gets or sets how the element wraps text.

A value that indicates how the element wraps text. The default is **NoWrap**.

Identifies the TextWrapping dependency property.

The identifier for the TextWrapping dependency property.

Gets or sets the vertical alignment of the content.

One of the VerticalAlignment values.

Identifies the VerticalContentAlignment dependency property.

The identifier for the VerticalContentAlignment dependency property.

Invoked when the value of the ContentTemplate property changes.

The old value of the ContentTemplate property. The new value of the ContentTemplate property.

Invoked when the value of the ContentTemplateSelector property changes.

The old value of the ContentTemplateSelector property. The new value of the ContentTemplateSelector property.

Provides event data for the **ContextMenuOpening** event that exists on several text-related UI elements.

Gets the pixel offset of the text cursor horizontal position.

A value in pixels.

Gets the pixel offset of the text cursor vertical position.

A value in pixels.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**True** to mark the routed event handled. **False** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Represents the method that will handle the **ContextMenuOpening** event that exists on several text-related UI elements.

The object where the event handler is attached. Event data for the event.

Represents the base class for UI elements that use a ControlTemplate to define their appearance. Parent class for ContentControl, UserControl, ItemsControl and several practical controls.

Provides base class initialization behavior for Control derived classes.

Gets or sets a brush that provides the background of the control.

The brush that provides the background of the control. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Gets or sets a brush that describes the border fill of a control.

The brush that is used to fill the control's border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the border thickness of a control.

The border thickness of a control, as a Thickness value.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Identifies the CharacterSpacing dependency property.

The identifier for the CharacterSpacing dependency property.

Gets or sets the radius for the corners of the control's border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses.

The key that references the default style for the control. To work correctly as part of theme style lookup, this value is expected to be a System.Type value.

Identifies the DefaultStyleKey dependency property.

The identifier for the DefaultStyleKey dependency property.

Gets or sets the path to the resource file that contains the default style for the control.

The path to the resource file that contains the default style for the control.

Identifies the **DefaultStyleResourceUri** dependency property.

The identifier for the **DefaultStyleResourceUri** dependency property.

Get or sets a value that specifies a control's preference for whether sounds are played.

A value of the enumeration that specifies a control's preference for whether sounds are played. The default is **Auto**.

Identifies the ElementSoundMode dependency property.

The identifier for the ElementSoundMode dependency property.

Gets a value that specifies whether this control has focus, and the mode by which focus was obtained.

A value of the enumeration. A value of **Unfocused** indicates that the control does not have focus.

Identifies the FocusState dependency property.

The identifier for the FocusState dependency property.

Gets or sets the font used to display text in the control.

The font used to display text in the control.

Identifies the FontFamily dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the size of the text in this control.

The size of the text in the Control, in pixels.

Identifies the FontSize dependency property.

The identifier for the FontSize dependency property.

Gets or sets the degree to which a font is condensed or expanded on the screen.

One of the values that specifies the degree to which a font is condensed or expanded on the screen. The default is **Normal**.

Identifies the FontStretch dependency property.

The identifier for the FontStretch dependency property.

Gets or sets the style in which the text is rendered.

One of the values that specifies the style in which the text is rendered. The default is **Normal**.

Identifies the FontStyle dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the thickness of the specified font.

One of the values that specifies the thickness of the specified font. The default is Normal.

Identifies the FontWeight dependency property.

The identifier for the FontWeight dependency property.

Gets or sets a brush that describes the foreground color.

The brush that paints the foreground of the control. The default value is a SolidColorBrush with color of Black.

Identifies the Foreground dependency property.

The identifier for the Foreground dependency property.

Gets or sets the horizontal alignment of the control's content.

One of the HorizontalAlignment values. The default is **Left**.

Identifies the HorizontalContentAlignment dependency property.

The identifier for the HorizontalContentAlignment dependency property.

Gets or sets a value indicating whether the user can interact with the control.

**true** if the user can interact with the control; otherwise, **false**.

Identifies the IsEnabled dependency property.

The identifier for the IsEnabled dependency property.

Get or sets a value that indicates whether focus is constrained within the control boundaries (for game pad/remote interaction).

**true** if focus is constrained within the control boundaries; otherwise, **false**.

Identifies the IsFocusEngaged dependency property.

The identifier for the IsFocusEngaged dependency property.

Get or sets a value that indicates whether focus can be constrained within the control boundaries (for game pad/remote interaction).

**true** if focus can be constrained within the control boundaries; otherwise, **false**.

Identifies the IsFocusEngagementEnabled dependency property.

The identifier for the IsFocusEngagementEnabled dependency property.

Gets or sets a value that indicates whether a control is included in tab navigation.

**true** if the control is included in tab navigation; otherwise, **false**. The default is **true**.

Identifies the IsTabStop  dependency property.

The identifier for the IsTabStop  dependency property.

Identifies the Control.IsTemplateFocusTarget XAML attached property.

The identifier for the Control.IsTemplateFocusTarget XAML attached property.

Identifies the Control.IsTemplateKeyTipTarget  XAML attached property.

The identifier for the Control.IsTemplateKeyTipTarget XAML attached property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets the padding inside a control.

The amount of space between the content of a Control and its Margin or Border. The default is a Thickness with values of 0 on all four sides.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Gets or sets whether a UI element supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as an Xbox gamepad or remote control.

The pointer emulation mode. The default is **Never**.

Identifies the RequiresPointer dependency property.

The identifier for the RequiresPointer dependency property.

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.

A value that determines the order of logical navigation for a device. The default value is MaxValue.

Identifies the TabIndex  dependency property.

The identifier for the TabIndex  dependency property.

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

A value of the enumeration. The default is **Local**.

Identifies the TabNavigation  dependency property.

The identifier for the TabNavigation  dependency property.

Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup.

The template that defines the appearance of the Control. The ControlTemplate must have exactly one root element as its content.

Identifies the Template  dependency property.

The identifier for the Template  dependency property.

Gets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template.

**true** if the control uses focus visuals drawn by the system; **false** if the control uses focus visuals defined in the ControlTemplate. The default is **false**; see Remarks.

Identifies the UseSystemFocusVisuals dependency property.

The identifier for the UseSystemFocusVisuals dependency property.

Gets or sets the vertical alignment of the control's content.

One of the VerticalAlignment values. The default is **Top**.

Identifies the VerticalContentAlignment dependency property.

The identifier for the VerticalContentAlignment dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

The object that gets focus when a user presses the Directional Pad (D-pad) down.

Identifies the XYFocusDown dependency property.

The identifier for the XYFocusDown dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

The object that gets focus when a user presses the Directional Pad (D-pad) left.

Identifies the XYFocusLeft dependency property.

The identifier for the XYFocusLeft dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

The object that gets focus when a user presses the Directional Pad (D-pad) right.

Identifies the XYFocusRight dependency property.

The identifier for the XYFocusRight dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

The object that gets focus when a user presses the Directional Pad (D-pad) up.

Identifies the XYFocusUp dependency property.

The identifier for the XYFocusUp dependency property.

Occurs when focus is released from the control boundaries (for game pad/remote interaction).

Occurs when focus is constrained within the control boundaries (for game pad/remote interaction).

Occurs when the IsEnabled property changes.

Loads the relevant control template so that its parts can be referenced.

A value that indicates whether the visual tree was rebuilt by this call. **True** if the tree was rebuilt; **false** if the previous visual tree was retained.

Attempts to set the focus on the control.

Specifies how focus was set, as a value of the enumeration. **true** if focus was set to the control, or focus was already on the control. **false** if the control is not focusable.

Gets the value of the Control.IsTemplateFocusTarget XAML attached property for the target element.

The object from which the property value is read. The Control.IsTemplateFocusTarget XAML attached property value of the specified object.

Gets the value of the Control.IsTemplateKeyTipTarget  XAML attached property for the target element.

The object from which the property value is read. The Control.IsTemplateKeyTipTarget XAML attached property value of the specified object.

Retrieves the named element in the instantiated ControlTemplate visual tree.

The name of the element to find. The named element from the template, if the element is found. Can return null if no element with name *childName* was found in the template.

Called before the CharacterReceived event occurs.

Event data for the event.

Called before the DoubleTapped event occurs.

Event data for the event.

Called before the DragEnter event occurs.

Event data for the event.

Called before the DragLeave event occurs.

Event data for the event.

Called before the DragOver event occurs.

Event data for the event.

Called before the Drop event occurs.

Event data for the event.

Called before the GotFocus event occurs.

The data for the event.

Called before the Holding event occurs.

Event data for the event.

Called before the KeyDown event occurs.

The data for the event.

Called before the KeyUp event occurs.

The data for the event.

Called before the LostFocus event occurs.

The data for the event.

Called before the ManipulationCompleted event occurs.

Event data for the event.

Called before the ManipulationDelta event occurs.

Event data for the event.

Called before the ManipulationInertiaStarting event occurs.

Event data for the event.

Called before the ManipulationStarted event occurs.

Event data for the event.

Called before the ManipulationStarting event occurs.

Event data for the event.

Called before the PointerCanceled event occurs.

Event data for the event.

Called before the PointerCaptureLost event occurs.

Event data for the event.

Called before the PointerEntered event occurs.

Event data for the event.

Called before the PointerExited event occurs.

Event data for the event.

Called before the PointerMoved event occurs.

Event data for the event.

Called before the PointerPressed event occurs.

Event data for the event.

Called before the PointerReleased event occurs.

Event data for the event.

Called before the PointerWheelChanged event occurs.

Event data for the event.

Called before the PreviewKeyDown event occurs.

The data for the event.

Called before the PreviewKeyUp event occurs.

The data for the event.

Called before the RightTapped event occurs.

Event data for the event.

Called before the Tapped event occurs.

Event data for the event.

Releases focus from the control boundaries for a control that has focus engagement (for game pad/remote interaction).

Sets the value of the Control.IsTemplateFocusTarget XAML attached property for a target element.

The object to which the property value is written. The value to set.

Sets the value of the Control.IsTemplateKeyTipTarget XAML attached property for a target element.

The object to which the property value is written. The value to set.

Defines the element tree that is used as the control template for a control.

Initializes a new instance of the ControlTemplate class.

Gets or sets the type to which the ControlTemplate is applied.

The type to which the ControlTemplate is applied. This value is usually set in XAML, not code. See Remarks.

Enables custom template selection logic at the application level.

Initializes a new instance of the DataTemplateSelector class.

Creates or retrieves an existing instance of the UIElement object declared in the DataTemplate returned by SelectTemplate.

An instance of ElementFactoryGetArgs. An instance of the root UIElement declared in the selected DataTemplate or, **null** if the root of the selected DataTemplate is not a UIElement.

Recycles a UIElement object that was created using GetElement.

An instance of ElementFactoryRecycleArgs.

Returns a specific DataTemplate for a given item.

The item to return a template for. The template to use for the given item and/or container.

Returns a specific DataTemplate for a given item and container.

The item to return a template for. The parent container for the templated item. The template to use for the given item and/or container.

When implemented by a derived class, returns a specific DataTemplate for a given item or container.

The item to return a template for. The template to use for the given item and/or container.

When implemented by a derived class, returns a specific DataTemplate for a given item or container.

The item to return a template for. The parent container for the templated item. The template to use for the given item and/or container.

Provides data for the DatePicked event.

Initializes a new instance of the DatePickedEventArgs class.

Gets the date that was selected by the user.

The date that was selected by the user.

Gets the previous date.

The previous date.

Represents a control that allows a user to pick a date value.

Initializes a new instance of the DatePicker class.

Gets or sets the calendar system to use.

The calendar system to use.

Gets the identifier for the CalendarIdentifier dependency property.

The identifier for the CalendarIdentifier dependency property.

Gets or sets the date currently set in the date picker.

The date currently set in the picker.

Gets the identifier for the Date dependency property.

The identifier for the Date dependency property.

Gets or sets the display format for the day value.

The display format for the day value.

Gets the identifier for the DayFormat dependency property.

The identifier for the DayFormat dependency property.

Gets or sets a value that indicates whether the day selector is shown.

**true** if the day selector is shown; otherwise, **false**. The default is **true**.

Gets the identifier for the DayVisible dependency property.

The identifier for the DayVisible dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets the maximum Gregorian year available for picking.

The maximum Gregorian year available for picking.

Gets the identifier for the MaxYear dependency property.

The identifier for the MaxYear dependency property.

Gets or sets the minimum Gregorian year available for picking.

The minimum Gregorian year available for picking.

Gets the identifier for the MinYear dependency property.

The identifier for the MinYear dependency property.

Gets or sets the display format for the month value.

The display format for the month value.

Gets the identifier for the MonthFormat dependency property.

The identifier for the MonthFormat dependency property.

Gets or sets a value that indicates whether the month selector is shown.

**true** if the month selector is shown; otherwise, **false**. The default is **true**.

Gets the identifier for the MonthVisible dependency property.

The identifier for the MonthVisible dependency property.

Gets or sets a value that indicates whether the day, month, and year selectors are stacked horizontally or vertically.

A named constant of the enumeration that indicates whether the day, month, and year selectors are stacked horizontally or vertically. The default is Horizontal.

Gets the identifier for the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets or sets the date currently selected in the date picker, or **null** if no date is selected.

The date currently selected in the picker, or **null** if no date is selected.

Identifies the SelectedDate dependency property.

The identifier for the SelectedDate dependency property.

Gets or sets the display format for the year value.

The display format for the year value.

Gets the identifier for the YearFormat dependency property.

The identifier for the YearFormat dependency property.

Gets or sets a value that indicates whether the year selector is shown.

**true** if the year selector is shown; otherwise, **false**. The default is **true**.

Gets the identifier for the YearVisible dependency property.

The identifier for the YearVisible dependency property.

Occurs when the date value is changed.

Occurs when the date value is changed.

Represents a control that allows a user to pick a date.

Initializes a new instance of the DatePickerFlyout class.

Gets or sets the calendar system to use.

The name of the calendar system to use. For a list of supported calendar systems, see CalendarIdentifiers.

Gets the identifier for the CalendarIdentifier dependency property.

The identifier for the CalendarIdentifier dependency property.

Gets or sets the date currently set in the date picker.

The date currently set in the picker.

Gets the identifier for the Date dependency property.

The identifier for the Date dependency property.

Gets or sets the display format for the day value.

The display format for the day value.

Identifies the DayFormat dependency property.

The identifier for the DayFormat dependency property.

Gets or sets a value that indicates whether the day selector is shown.

True if the day selector is shown; otherwise, false. The default is true.

Gets the identifier for the DayVisible dependency property.

The identifier for the DayVisible dependency property.

Gets or sets the maximum Gregorian year available for picking.

The maximum Gregorian year available for picking.S

Gets the identifier for the MaxYear dependency property.

The identifier for the MaxYear dependency property.

Gets or sets the minimum Gregorian year available for picking.

The minimum Gregorian year available for picking.

Gets the identifier for the MinYear dependency property.

The identifier for the MinYear dependency property.

Gets or sets the display format for the month value.

The display format for the month value.

Identifies the MonthFormat dependency property.

The identifier for the MonthFormat dependency property.

Gets or sets a value that indicates whether the month selector is shown.

True if the month selector is shown; otherwise, false. The default is true.

Gets the identifier for the MonthVisible dependency property.

The identifier for the MonthVisible dependency property.

Gets or sets the display format for the year value.

The display format for the year value.

Identifies the YearFormat dependency property.

The identifier for the YearFormat dependency property.

Gets or sets a value that indicates whether the year selector is shown.

True if the year selector is shown; otherwise, false. The default is true.

Gets the identifier for the YearVisible dependency property.

The identifier for the YearVisible dependency property.

Occurs when a date has been picked by the user.

Begins an asynchronous operation to show the date picker placed in relation to the specified element.

The element to use as the flyout's placement target. An asynchronous operation

Represents the container for an item in the DatePickerFlyout control.

Gets or sets the primary text of the item.

The primary text of the item.

Identifies the PrimaryText dependency property.

The identifier for the PrimaryText dependency property.

Gets or sets the secondary text of the item.

The secondary text of the item.

Identifies the SecondaryText dependency property.

The identifier for the SecondaryText dependency property.

Gets the type of the item.

The type of the item, specified as a TypeName wrapper.

Retrieves an ICustomProperty object by specifying a property name.

The name of the property. The custom property support object.

Retrieves a custom property's ICustomProperty support object by specifying a property name and the type of the indexed collection.

The name of the custom property. The type of the indexed collection, specified as a TypeName (for Visual C++ component extensions (C++/CX)) or System.Type (for C#/VB). The returned support object for the custom property, or **null**.

Provides support for "GetStringFromObject" and/or "ToString" logic on the assumption that the implementation supports System.Object. This logic might be accessed by features or services such as generating UI Automation values based on data content.

The provided string.

Represents a control to allow a user to pick a date.

Gets or sets a value that indicates whether the default shadow effect is shown.

**true** if the default shadow effect is shown; otherwise, **false**. The default is **true**.

Identifies the IsDefaultShadowEnabled dependency property.

The identifier for the IsDefaultShadowEnabled dependency property.

Provides event data for the DatePicker.SelectedDateChanged event.

Gets the new date selected in the picker.

The new date selected in the picker.

Gets the date previously selected in the picker.

The date previously selected in the picker.

Provides event data for the DatePicker.DateChanged event.

Gets the new date selected in the picker.

The new date selected in the picker.

Gets the date previously selected in the picker.

The date previously selected in the picker.

Defines constants that specify which keyboard shortcuts for formatting are disabled in a RichEditBox.

All keyboard shortcuts are disabled.

The keyboard shortcut for bold (Ctrl+B) is disabled.

The keyboard shortcut for italic (Ctrl+I) is disabled.

No keyboard shortcuts are disabled.

The keyboard shortcut for underline (Ctrl+U) is disabled.

Provides event data for the DragItemsCompleted event.

Gets a value that indicates what operation was performed on the dragged data, and whether it was successful.

A value of the enumeration that indicates what operation was performed on the dragged data.

Gets the loosely typed collection of objects that are selected for the item drag action.

A loosely typed collection of objects.

Provides event data for the DragItemsStarting event.

Initializes a new instance of the DragItemsStartingEventArgs class.

Gets or sets a value that indicates whether the item drag action should be canceled.

**True** to cancel the item drag action; otherwise, **false**.

Gets the data payload associated with an items drag action.

The data payload.

Gets the loosely typed collection of objects that are selected for the item drag action.

A loosely typed collection of objects.

Represents the method that will handle the DragItemsStarting event.

The object where the handler is attached. Event data for the event.

Represents a button with a chevron intended to open a menu.

Initializes a new instance of the DropDownButton class.

Exposes DropDownButton types to Microsoft UI Automation.

Initializes a new instance of the DropDownButtonAutomationPeer class.

The DropDownButton control instance to create the peer for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Hides the control's drop down menu.

Displays the control's drop down menu.

Provides data for the CommandBar.DynamicOverflowItemsChanging event.

Initializes a new instance of the DynamicOverflowItemsChangingEventArgs class.

Gets a value that indicates whether items were added to or removed from the CommandBar overflow menu.

A value that indicates whether items were added to or removed from the CommandBar overflow menu.

Represents an items control that displays one item at a time, and enables "flip" behavior for traversing its collection of items.

Initializes a new instance of the FlipView class.

Gets or sets a value that indicates whether transition animations are always used whether the navigation is touch-based, button-based or programmatic.

**true** if transition animations are always used; **false** if transition animations are used only for touch navigation. The default is **true**.

Identifies the UseTouchAnimationsForAllNavigation dependency property.

The identifier for the UseTouchAnimationsForAllNavigation dependency property.

Represents the container for an item in a FlipView control.

Initializes a new instance of the FlipViewItem class.

Represents a control that displays lightweight UI that is either information, or requires user interaction. Unlike a dialog, a Flyout can be light dismissed by clicking or tapping outside of it, pressing the device’s back button, or pressing the ‘Esc’ key.

Initializes a new instance of the Flyout class.

Gets or sets the content of the Flyout.

The content of the Flyout.

Gets the identifier for the Content dependency property.

The identifier for the Content dependency property.

Gets or sets the Style applied to the Flyout content.

The applied Style for the Flyout content, if present; otherwise, **null**. The default is **null**.

Gets the identifier for the FlyoutPresenterStyle dependency property.

The identifier for the FlyoutPresenterStyle dependency property.

Displays the content of a Flyout.

Initializes a new instance of the FlyoutPresenter class.

Gets or sets a value that indicates whether the default shadow effect is shown.

**true** if the default shadow effect is shown; otherwise, **false**. The default is **true**.

Identifies the IsDefaultShadowEnabled dependency property.

The identifier for the IsDefaultShadowEnabled dependency property.

Provides data for the FocusDisengaged event.

Provides data for the FocusEngaged event.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Represents an icon that uses a glyph from the specified font.

Initializes a new instance of the FontIcon class.

Gets or sets the font used to display the icon glyph.

The font used to display the icon glyph.

Gets the identifier for the FontFamily dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the size of the icon glyph.

A non-negative value that specifies the font size, measured in pixels.

Gets the identifier for the FontSize dependency property.

The identifier for the FontSize dependency property.

Gets or sets the font style for the icon glyph.

A named constant of the enumeration that specifies the style in which the icon glyph is rendered. The default is **Normal**.

Gets the identifier for the FontStyle dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the thickness of the icon glyph.

A value that specifies the thickness of the icon glyph. The default is **Normal**.

Gets the identifier for the FontWeight dependency property.

The identifier for the FontWeight dependency property.

Gets or sets the character code that identifies the icon glyph.

The hexadecimal character code for the icon glyph.

Gets the identifier for the Glyph dependency property.

The identifier for the Glyph dependency property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets a value that indicates whether the icon is mirrored when the FlowDirection is **RightToLeft**.

**true** if the icon is mirrored when the FlowDirection is FlowDirection.RightToLeft; otherwise, **false**. The default is **false**.

Identifies the MirroredWhenRightToLeft dependency property.

The identifier for the MirroredWhenRightToLeft dependency property.

Represents an icon source that uses a glyph from the specified font.

Initializes a new instance of the FontIconSource class.

Gets or sets the font used to display the icon glyph.

The font used to display the icon glyph.

Gets the identifier for the FontFamily dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the size of the icon glyph.

A non-negative value that specifies the font size, measured in pixels.

Gets the identifier for the FontSize dependency property.

The identifier for the FontSize dependency property.

Gets or sets the font style for the icon glyph.

A named constant of the enumeration that specifies the style in which the icon glyph is rendered. The default is **Normal**.

Gets the identifier for the FontStyle dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the thickness of the icon glyph.

A value that specifies the thickness of the icon glyph. The default is **Normal**.

Gets the identifier for the FontWeight dependency property.

The identifier for the FontWeight dependency property.

Gets or sets the character code that identifies the icon glyph.

The hexadecimal character code for the icon glyph.

Gets the identifier for the Glyph dependency property.

The identifier for the Glyph dependency property.

Gets or sets a value that indicates whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Gets the identifier for the IsTextScaleFactorEnabled dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets a value that indicates whether the icon is mirrored when its containing element's FlowDirection is **RightToLeft**.

**true** if the icon is mirrored when the FlowDirection is FlowDirection.RightToLeft; otherwise, **false**. The default is **false**.

Gets the identifier for the MirroredWhenRightToLeft dependency property.

The identifier for the MirroredWhenRightToLeft dependency property.

Displays Page instances, supports navigation to new pages, and maintains a navigation history to support forward and backward navigation.

Initializes a new instance of the Frame class.

Gets a collection of PageStackEntry instances representing the backward navigation history of the Frame.

The backward navigation stack.

Gets the number of entries in the navigation back stack.

The number of entries in the navigation back stack.

Identifies the BackStackDepth dependency property.

The identifier for the BackStackDepth dependency property.

Identifies the BackStack dependency property.

The identifier for the BackStack dependency property.

Gets or sets the number of pages in the navigation history that can be cached for the frame.

The number of pages that can be in the navigation history.

Identifies the CacheSize dependency property.

The identifier for the CacheSize dependency property.

Gets a value that indicates whether there is at least one entry in back navigation history.

**true** if there is at least one entry in back navigation history; **false** if there are no entries in back navigation history or the Frame does not own its own navigation history.

Identifies the CanGoBack dependency property.

The identifier for the CanGoBack dependency property.

Gets a value that indicates whether there is at least one entry in forward navigation history.

**true** if there is at least one entry in forward navigation history; **false** if there are no entries in forward navigation history or the Frame does not own its own navigation history.

Identifies the CanGoForward dependency property.

The identifier for the CanGoForward dependency property.

Gets a type reference for the content that is currently displayed.

A type reference for the content that is currently displayed.

Identifies the CurrentSourcePageType dependency property.

The identifier for the CurrentSourcePageType dependency property.

Gets a collection of PageStackEntry instances representing the forward navigation history of the Frame.

The forward navigation stack.

Identifies the ForwardStack dependency property.

The identifier for the ForwardStack dependency property.

Gets or sets a value that indicates whether navigation is recorded in the Frame's ForwardStack or BackStack.

**true** if navigation is recorded in the Frame's ForwardStack or BackStack; otherwise, **false**. The default is **true**.

Identifies the IsNavigationStackEnabled dependency property.

The identifier for the IsNavigationStackEnabled dependency property.

Gets or sets a type reference of the current content, or the content that should be navigated to.

A type reference for the current content, or the content to navigate to.

Identifies the SourcePageType dependency property.

The identifier for the SourcePageType dependency property.

Occurs when the content that is being navigated to has been found and is available from the Content property, although it may not have completed loading.

Occurs when a new navigation is requested.

Occurs when an error is raised while navigating to the requested content.

Occurs when

Serializes the Frame navigation history into a string.

The string-form serialized navigation history. See Remarks.

Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history.

Navigates to the most recent item in back navigation history, if a Frame manages its own navigation history, and specifies the animated transition to use.

Info about the animated transition to use.

Navigates to the most recent item in forward navigation history, if a Frame manages its own navigation history.

Causes the Frame to load content represented by the specified Page.

The page to navigate to, specified as a type reference to its partial class type. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)). **false** if a NavigationFailed event handler has set Handled to **true**; otherwise, **true**. See Remarks for more info.

Causes the Frame to load content represented by the specified Page, also passing a parameter to be interpreted by the target of the navigation.

The page to navigate to, specified as a type reference to its partial class type. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)). The navigation parameter to pass to the target page; must have a basic type (string, char, numeric, or GUID ) to support parameter serialization using GetNavigationState. **false** if a NavigationFailed event handler has set Handled to **true**; otherwise, **true**. See Remarks for more info.

Causes the Frame to load content represented by the specified Page -derived data type, also passing a parameter to be interpreted by the target of the navigation, and a value indicating the animated transition to use.

The page to navigate to, specified as a type reference to its partial class type. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)). The navigation parameter to pass to the target page; must have a basic type (string, char, numeric, or GUID ) to support parameter serialization using GetNavigationState. Info about the animated transition. **false** if a NavigationFailed event handler has set Handled to **true**; otherwise, **true**. See Remarks for more info.

Causes the Frame to load content represented by the specified Page, also passing a parameter to be interpreted by the target of the navigation.

The page to navigate to, specified as a type reference to its partial class type. (A type reference is given as System.Type for Microsoft .NET, or a TypeName helper struct for Visual C++ component extensions (C++/CX)). The navigation parameter to pass to the target page; must have a basic type (string, char, numeric, or GUID ) to support parameter serialization using GetNavigationState. Options for the navigation, including whether it is recorded in the navigation stack and what transition animation is used. **false** if a NavigationFailed event handler has set Handled to **true**; otherwise, **true**.

Reads and restores the navigation history of a Frame from a provided serialization string.

The serialization string that supplies the restore point for navigation history.

Reads and restores the navigation history of a Frame from a provided serialization string.

The serialization string that supplies the restore point for navigation history. **true** to restore navigation history without navigating to the current page; otherwise, **false**.

Defines a flexible grid area that consists of columns and rows. Child elements of the Grid are measured and arranged according to their row/column assignments (set by using Grid.Row and Grid.Column attached properties) and other logic.

Initializes a new instance of the Grid class.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Gets or sets a brush that describes the border fill of the panel.

The brush that is used to fill the panel's border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the border thickness of the panel.

The border thickness of the panel, as a Thickness value.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets a list of ColumnDefinition objects defined on this instance of Grid.

A list of ColumnDefinition objects defined on this instance of Grid.

Identifies the Grid.Column XAML attached property.

The identifier for the Grid.Column XAML attached property.

Gets or sets the uniform distance (in pixels) between grid columns.

The uniform distance (in pixels) between grid columns.

Identifies the ColumnSpacing dependency property.

The identifier for the ColumnSpacing dependency property.

Identifies the Grid.ColumnSpan XAML attached property.

The identifier for the Grid.ColumnSpan XAML attached property.

Gets or sets the radius for the corners of the panel's border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Gets or sets the distance between the border and its child object.

The dimensions of the space between the border and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Gets a list of RowDefinition objects defined on this instance of Grid.

A list of RowDefinition objects defined on this instance of Grid.

Identifies the Grid.Row XAML attached property.

The identifier for the Grid.Row XAML attached property.

Gets or sets the uniform distance (in pixels) between grid rows.

The uniform distance (in pixels) between grid rows.

Identifies the RowSpacing dependency property.

The identifier for the RowSpacing dependency property.

Identifies the Grid.RowSpan XAML attached property.

The identifier for the Grid.RowSpan XAML attached property.

Gets the value of the Grid.Column XAML attached property from the specified FrameworkElement.

The element from which to read the property value. The value of the Grid.Column XAML attached property on the target element. This is a zero-based index.

Gets the value of the Grid.ColumnSpan XAML attached property from the specified FrameworkElement.

The element from which to read the property value. The value of the Grid.ColumnSpan XAML attached property on the target element.

Gets the value of the Grid.Row XAML attached property from the specified FrameworkElement.

The element from which to read the property value. The value of the Grid.Row XAML attached property on the target element.

Gets the value of the Grid.RowSpan XAML attached property from the specified FrameworkElement.

The element from which to read the property value. The value of the Grid.RowSpan XAML attached property on the target element.

Sets the value of the Grid.Column XAML attached property on the specified FrameworkElement.

The target element on which to set the Grid.Column XAML attached property. The property value to set.

Sets the value of the Grid.ColumnSpan XAML attached property on the specified FrameworkElement.

The element on which to set the Grid.ColumnSpan XAML attached property. The property value to set.

Sets the value of the Grid.Row XAML attached property on the specified FrameworkElement.

The target element on which to set the Grid.Row XAML attached property. The property value to set.

Sets the value of the Grid.RowSpan XAML attached property on the specified FrameworkElement.

The target element on which to set the Grid.RowSpan XAML attached property. The property value to set.

Represents a control that displays data items in rows and columns.

Initializes a new instance of the GridView class.

Represents items in the header for grouped data inside a GridView.

Initializes a new instance of the GridViewHeaderItem class.

Represents the container for an item in a GridView control.

Initializes a new instance of the GridViewItem class.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a GridViewItem.

An object that provides calculated values for templates.

Represents the root element for a subtree that is created for a group.

Initializes a new instance of the GroupItem class.

Describes how to display the grouped items in a collection, such as the collection from GroupItems.

Initializes a new instance of the GroupStyle class.

Gets or sets the style that is applied to the GroupItem generated for each item.

The style that is applied to the GroupItem generated for each item. The default is **null**.

Gets or sets a reference to a custom StyleSelector logic class. The StyleSelector referenced by this property returns a style to apply to each generated GroupItem.

An object that derives from StyleSelector. The default is **null**.

Gets or sets the style that is applied to the header for each item.

The style that is applied to the header for each item. The default is **null**.

Gets or sets the template that is used to display the group header.

A DataTemplate object that is used to display the group header. The default is **null**.

Gets or sets a reference to a custom DataTemplateSelector logic class. The DataTemplateSelector returns different DataTemplate values to use for the header area of group item content.

An object that derives from DataTemplateSelector. The default is **null**.

Gets or sets a value that indicates whether items corresponding to empty groups should be displayed.

**True** to not display empty groups; otherwise, **false**. The default is **false**.

Gets or sets a template that creates the panel used to lay out the items.

An ItemsPanelTemplate object that creates the panel used to layout the items.

Occurs when a property value changes.

Enables custom group style selection logic as a function of the parent group and its level.

Initializes a new instance of the GroupStyleSelector class.

Returns a specific GroupStyle for a given group and level.

The group to return a GroupStyle for. The level of nesting for the specified group. TheGroupStyle to use when this GroupStyleSelector is invoked in an application.

When implemented by a derived class, returns a specific GroupStyle for a given group and level.

The group to return a GroupStyle for. The level of nesting for the specified group. The GroupStyle to use for the specified group and level.

Provides event data for the HandwritingView.Closed event.

Provides event data for the HandwritingView.Opened event.

Defines constants that specify where the handwriting view panel is anchored to the control.

The system determines the best place to anchor the handwriting view panel.

The handwriting view panel is anchored to the bottom left corner of the control.

The handwriting view panel is anchored to the bottom right corner of the control.

The handwriting view panel is anchored to the top left corner of the control.

The handwriting view panel is anchored to the top right corner of the control.

Represents a Windows Ink input surface for text input controls.

Initializes a new instance of the HandwritingView class.

Gets or sets a value that specifies whether auto-completion candidates are shown as the use writes.

**true** if auto-completion candidates are shown as the use writes; otherwise, **false**. The default is **true**.

Identifies the AreCandidatesEnabled dependency property.

The identifier for the AreCandidatesEnabled dependency property.

Gets a value that indicates whether the handwriting view panel is open.

**true** if the handwriting view panel is open; otherwise, **false**.

Identifies the IsOpen dependency property.

The identifier for the IsOpen dependency property.

Gets or sets a value that specifies the anchor point used to place the handwriting view over the control.

An enunmeration value that specifies the anchor point used to place the handwriting view. The default is **Auto**.

Identifies the PlacementAlignment dependency property.

The identifier for the PlacementAlignment dependency property.

Gets or sets the visual element or control that the handwriting view should be positioned in relation to when opened.

The visual element or control that the handwriting view should be positioned in relation to when opened. The default is **null**.

Identifies the PlacementTarget dependency property.

The identifier for the PlacementTarget dependency property.

Occurs when the handwriting view panel is closed.

Occurs when the handwriting view panel is opened.

Attempts to close the handwriting view panel.

**true** if the handwriting view panel closed; otherwise, **false**.

Attempts to open the handwriting view panel.

**true** if the handwriting view panel opened; otherwise, **false**.

Represents a control that displays groups of content in a panning view.

Initializes a new instance of the Hub class.

Gets or sets the index of the hub section to show first when the Hub is initialized.

The index of the hub section to show first when the Hub is initialized.

Identifies the DefaultSectionIndex dependency property.

The identifier for the DefaultSectionIndex dependency property.

Gets or sets the content for the hub header.

The content of the hub header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the hub header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the Hub instance is the active view in its owning SemanticZoom.

**true** if the Hub is the active view; otherwise, **false**.

Identifies the IsActiveView dependency property.

The identifier for the IsActiveView dependency property.

Gets or sets a value that indicates whether the Hub instance is the zoomed-in view in its owning SemanticZoom.

**true** if the Hub is the zoomed-in view; otherwise, **false**.

Identifies the IsZoomedInView dependency property.

The identifier for the IsZoomedInView dependency property.

Gets or sets the orientation of a Hub.

One of the Orientation values. The default is **Horizontal**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets a collection of the headers of the hub sections.

The headers of the hub sections. The default is an empty collection.

Gets all the hub sections in the Hub.

All the hub sections in the Hub. The default is an empty collection.

Gets the hub sections currently on the screen.

The hub sections currently on the screen.

Gets or sets the SemanticZoom instance that hosts the Hub.

The SemanticZoom instance that hosts this Hub, or **null** if the Hub is not hosted in a SemanticZoom control.

Identifies the SemanticZoomOwner dependency property.

The identifier for the SemanticZoomOwner dependency property.

Occurs when a section header is clicked and the section's IsHeaderInteractive property is **true**.

Occurs when the SectionsInView collection changes.

Changes related aspects of presentation when the overall view for a SemanticZoom changes.

Completes item-wise operations that are related to a view change when the Hub instance is the source view and the new view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Completes item-wise operations that are related to a view change when the Hub instance is the destination view and the source view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Initializes the changes to related aspects of presentation (such as scrolling UI or state) when the overall view for a SemanticZoom is about to change.

Forces content in the view to scroll until the item that's specified by SemanticZoomLocation is visible. Also focuses the item if it finds the item.

The item in the view to scroll to.

Scrolls the hub to bring the specified hub section into view.

The hub section to bring into view.

Initializes item-wise operations that are related to a view change when the Hub instance is the source view and the pending destination view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Initializes item-wise operations that are related to a view change when the source view is a different view and the pending destination view is the Hub instance.

The view item as represented in the source view. The view item as represented in the destination view.

Represents a single group of content in a Hub.

Initializes a new instance of the HubSection class.

Gets or sets the data template that is used to display the content of the HubSection.

The data template that is used to display the content of the HubSection.

Identifies the ContentTemplate dependency property.

The identifier for the ContentTemplate dependency property.

Gets or sets the content for the hub section header.

The content of the section header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the hub section header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the section header raises a SectionHeaderClick event on its containing Hub.

**true** if the section header raises a SectionHeaderClick event; otherwise, **false**. The default is **false**.

Identifies the IsHeaderInteractive dependency property.

The identifier for the IsHeaderInteractive dependency property.

Represents an ordered collection of HubSection objects.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The item value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item, if it is found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the item value specified.

The index at which to set the value. The value to set.

Provides data for the Hub.SectionHeaderClick event.

Initializes a new instance of the HubSectionHeaderClickEventArgs class.

Gets the HubSection for the header that was clicked.

The HubSection for the header that was clicked.

Represents the method that will handle a Hub.SectionHeaderClick event.

The object where the handler is attached. Event data for the event.

Represents a button control that functions as a hyperlink.

Initializes a new instance of the HyperlinkButton class.

Gets or sets the Uniform Resource Identifier (URI) to navigate to when the HyperlinkButton is clicked.

The Uniform Resource Identifier (URI) to navigate to when the HyperlinkButton is clicked.

Identifies the NavigateUri dependency property.

The identifier for the NavigateUri dependency property.

Defines the compact view for command bar elements.

Gets or sets a value that indicates whether the element is shown with no label and reduced padding.

**true** if the element is shown in its compact state; otherwise, **false**. The default is **false**.

Defines members to manage the command bar overflow menu.

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

The order in which this item is moved to the overflow menu relative to other items.

Gets a value that indicates whether this item is in the overflow menu.

**true** if this item is in the overflow menu; otherwise, **false**.

Represents the base class for an icon UI element.

Gets or sets a brush that describes the foreground color.

The brush that paints the foreground of the control. The default is **null**, (a null brush) which is evaluated as Transparent for rendering. However, this value is typically set by a default system resource at runtime, which is tied to the active theme and other settings.

Identifies the Foreground dependency property.

The identifier for the Foreground dependency property.

Represents the base class for an icon source.

Gets or sets a brush that describes the foreground color.

The brush that paints the foreground of the control. The default is **null**, (a null brush) which is evaluated as Transparent for rendering. However, this value is typically set by a default system resource at runtime, which is tied to the active theme and other settings.

Identifies the Foreground dependency property.

The identifier for the Foreground dependency property.

Represents an icon that uses an IconSource as its content.

Initializes a new instance of the IconSourceElement class.

Gets or sets the IconSource used as the icon content.

The IconSource used as the icon content. The default is **null**.

Identifies the IconSource dependency property.

The identifier for the IconSource dependency property.

Provides methods to let an item be inserted between other items in a drag-and-drop operation.

Returns the index values of the items that the specified point is between.

The point for which to get insertion indexes. The index of the item before the specified point. The index of the item after the specified point.

Provides methods that let an ItemsControl map data items to UI containers.

Returns the container for the item at the specified index within the ItemCollection.

The index of the item to retrieve. The container for the item at the specified index within the item collection, if the item has a container; otherwise, **null**.

Returns the container corresponding to the specified item.

The item to retrieve the container for. A container that corresponds to the specified item, if the item has a container and exists in the collection; otherwise, **null**.

Returns the index to the item that has the specified, generated container.

The generated container to retrieve the item index for. The index to the item that corresponds to the specified generated container.

Returns the item that corresponds to the specified, generated container.

The DependencyObject that corresponds to the item to be returned. The contained item, or the container if it does not contain an item.

Represents a control that displays an image. The image source is specified by referring to an image file, using several supported formats. The image source can also be set with a stream. See Remarks for the list of supported image source formats.

Initializes a new instance of the Image class.

Gets or sets a value for a nine-grid metaphor that controls how the image can be resized. The nine-grid metaphor enables you to stretch edges and corners of an image differently than its center. See Remarks for more info and an illustration.

A Thickness value that sets the **Left**, **Top**, **Right**, **Bottom** measurements for the nine-grid resizing metaphor.

Identifies the NineGrid dependency property.

The identifier for the NineGrid dependency property.

Gets the information that is transmitted if the Image is used for a Play To scenario.

A reference object that carries the Play To source information.

Identifies the PlayToSource dependency property.

The identifier for the PlayToSource dependency property.

Gets or sets the source for the image.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the Source  dependency property.

The identifier for the Source  dependency property.

Gets or sets a value that describes how an Image should be stretched to fill the destination rectangle.

A value of the Stretch enumeration that specifies how the source image is rendered, if the Height and/or Width of the Image are not explicitly specified. The default value is **Uniform**.

Identifies the Stretch  dependency property.

The identifier for the Stretch  dependency property.

Occurs when there is an error associated with image retrieval or format.

Occurs when the image source is downloaded and decoded with no failure. You can use this event to determine the natural size of the image source.

Returns a mask that represents the alpha channel of an image as a CompositionBrush.

A mask that represents the alpha channel of an image.

Returns the image as a CastingSource.

The image as a CastingSource.

Defines the navigation action for navigation hosts and navigation initiators.

Causes the navigation host to load content that is specified by a type reference.

A type reference for the content to load. **true** if the navigation host can navigate according to its settings; otherwise, **false**.

Defines constants that specify list view incremental loading behavior (IncrementalLoadingTrigger property).

Uses an "edge" offset for incremental loading visual behavior, and enables the list view to notify the scroll host of incremental load per interaction with other settings (IncrementalLoadingThreshold, DataFetchSize ).

Incremental loading does not occur.

Defines an area that receives and displays all pen input as either an ink stroke or an erase stroke (input from an eraser tip, or the pen tip when modified with an erase button).

Initializes a new instance of the InkCanvas class.

Gets the underlying InkPresenter object associated with the InkCanvas.

The underlying InkPresenter object.

Represents a Universal Windows app control containing a customizable and extensible collection of buttons that activate ink-related features in an associated InkCanvas.

Initializes a new instance of the InkToolbar class.

Gets or sets the currently selected feature in the "tools" group of the InkToolbar (see remarks).

The currently selected feature. By default, this is the first button on the InkToolbar.

Identifies the ActiveTool dependency property.

The identifier for the ActiveTool dependency property.

Gets or sets the location of ink stroke configuration flyout relative to the InkToolbar.

The location of the flyout relative to the ink toolbar.

Identifies the ButtonFlyoutPlacement dependency property.

Gets the collection of custom buttons displayed on the InkToolbar.

A collection of InkToolbar custom buttons.

Identifies the Children dependency property.

The identifier for the Children dependency property.

Gets or sets the collection of built-in buttons added to the InkToolbar at initialization.

The collection of built-in buttons to add to the InkToolbar.

Identifies the InitialControls dependency property.

The identifier for the InitialControls dependency property.

Gets the InkStroke properties specified through the InkToolbar.

The InkStroke properties.

Identifies the InkDrawingAttributes dependency property.

The identifier for the InkDrawingAttributes dependency property.

Gets or sets the state of the InkToolbarRulerButton (and associated tool) to on or off.

**true** if the ruler button is selected and the ruler is active; otherwise, **false**.

Identifies the IsRulerButtonChecked dependency property.

The identifier for the IsRulerButtonChecked dependency property.

Gets or sets the state of the InkToolbarStencilButton (and associated tool) to on or off.

**true** if the stencil button is selected and the stencil is active; otherwise, **false**.

Identifies the IsStencilButtonChecked dependency property.

The identifier for the IsStencilButtonChecked dependency property.

Gets or sets the orientation of the InkToolbar.

The different orientations that ink toolbar can have.

Identifies the InkToolbar.Orientation dependency property.

The identifier for the InkToolbar.Orientation dependency property.

Gets or sets the InkCanvas control associated with the InkToolbar.

The InkCanvas control associated with the InkToolbar.

Identifies the TargetInkCanvas dependency property.

The identifier for the TargetInkCanvas dependency property.

Gets or sets the InkPresenter object associated with the InkToolbar.

The InkPresenter object associated with the InkToolbar.

Identifies the TargetInkPresenter dependency property.

The identifier for the TargetInkPresenter dependency property.

Occurs when the currently selected feature in the RadioButton group of the InkToolbar is changed.

Occurs when "Erase All Ink" is selected from the flyout for the InkToolbarEraserButton on the InkToolbar.

Occurs when any InkDrawingAttributes are changed.

Occurs when the toggled state of the InkToolbarRulerButton changes.

Occurs when the toggled state of the InkToolbaStencilButton changes.

Retrieves a reference to an InkToolbarMenuButton object from the menu button group of the InkToolbar.

Indicates the type of InkToolbarMenuButton to retrieve. The InkToolbarMenuButton specified.

Retrieves a reference to an InkToolbarToggleButton object from the toggle button group of the InkToolbar.

Indicates the type of InkToolbarToggleButton to retrieve. The InkToolbarToggleButton specified.

Retrieves a reference to one of the following objects from the radio button group of the InkToolbar.

Indicates the type of InkToolbarToolButton to retrieve. The InkToolbarToolButton specified, or **null** if the button has not been added to the InkToolbar.

Represents an InkToolbar button that activates the built-in ballpoint pen.

Initializes a new instance of the InkToolbarBallpointPenButton class.

Specifies the location of the ink stroke configuration flyout relative to the InkToolbar.

The system determines which edge of the ink toolbar to align the flyout.

Flyout is aligned to the bottom edge of the ink toolbar.

Flyout is aligned to the left edge of the ink toolbar.

Flyout is aligned to the right edge of the ink toolbar.

Flyout is aligned to the top edge of the ink toolbar.

Represents an InkToolbar pen for which the ink color palette and pen tip properties, such as shape, rotation, and size, are defined by the host app.

Initializes a new instance of the InkToolbarCustomPen class.

Retrieves the InkToolbarCustomPen attributes used for an InkToolbarPenConfigurationControl.

The brush used to draw the stroke. The default is 0 (Black ). The width of the stroke. The default is 0. The attributes applied to the InkStroke when it is drawn.

When overridden in a derived class, retrieves an InkDrawingAttributes object used to specify the ConfigurationContent for an InkToolbarCustomPen.

The brush used to draw the stroke. The default is 0 (Black ). The width of the stroke. The default is 0. The attributes applied to the InkStroke when it is drawn.

Represents an InkToolbar button that activates a pen for which the ink color palette and pen tip properties, such as shape, rotation, and size, are defined by the host app.

Initializes a new instance of the InkToolbarCustomPenButton class.

Gets or sets the content of an optional ink stroke configuration flyout associated with the InkToolbarCustomPenButton.

The contents of the flyout. The default is **null**.

Identifies the ConfigurationContent dependency property.

The identifier for the ConfigurationContent dependency property.

Gets or sets the InkToolbarCustomPen associated with the InkToolbarCustomPenButton.

The InkToolbarCustomPen that is enabled or disabled by the InkToolbarCustomPenButton.

Identifies the CustomPen dependency property.

The identifier for the CustomPen dependency property.

Represents an InkToolbar button that sets the state of an app-defined feature to on or off. When turned on, the feature works in conjunction with the active tool.

Initializes a new instance of the InkToolbarCustomToggleButton class.

Represents an InkToolbar button that invokes a non-pen tool, defined by the host app.

Initializes a new instance of the InkToolbarCustomToolButton class.

Gets or sets the content of an optional ink stroke configuration flyout associated with the InkToolbarCustomToolButton.

The contents of the flyout. The default is **null**.

Identifies the ConfigurationContent dependency property.

The identifier for the ConfigurationContent dependency property.

Represents an InkToolbar button that activates the built-in eraser tool.

Initializes a new instance of the InkToolbarEraserButton class.

Gets or sets whether the "Erase all ink" button is visible.

**true** if visible. Otherwise, **false**.

Identifies the IsClearAllVisible dependency property.

The identifier for the IsClearAllVisible dependency property.

Represents an InkToolbar button on a flyout. This item can be a basic button, a radio button, a radio toggle button, or a check box.

Initializes a new instance of the InkToolbarFlyoutItem class.

Gets or sets whether the flyout item is checked.

**true** if checked. Otherwise, **false**.

Identifies the IsChecked dependency property.

The identifier for the IsChecked dependency property.

Gets or sets the type of button to use on the flyout.

The type of button.

Identifies the Kind dependency property.

The identifier for the Kind dependency property.

Occurs when the flyout item is checked.

Occurs when the flyout item is unchecked.

Specifies the types of buttons that can be used on an InkToolbar flyout.

A check box.

A basic radio button.

A radio button that can be toggled on or off.

A basic button.

Represents an InkToolbar toggle button control that activates the built-in highlighter pen.

Initializes a new instance of the InkToolbarHighlighterButton class.

Defines constants that specify the built-in buttons (InitialControls ) added to an InkToolbar at initialization.

All built-in buttons are added.

All built-in, non-pen buttons are added:

No built-in buttons are added.

All built-in pen buttons are added:

Provides data for the IsStencilButtonCheckedChanged event.

Initializes a new instance of the InkToolbarIsStencilButtonCheckedChangedEventArgs class.

Gets the button for the selected stencil.

The stencil button.

Gets the type of stencil.

The type of stencil.

Represents an InkToolbar button that invokes a menu of tools, defined by the host app.

Gets or sets whether an extension glyph is shown on the menu button.

**true** if the glyph is shown. Otherwise, **false**.

Identifies the IsExtensionGlyphShown dependency property.

The identifier for the IsExtensionGlyphShown dependency property.

Gets the type of menu button.

The type of menu button.

Specifies the types of menu buttons that can be added to an InkToolbar.

Stencil menu button.

Provides a base class for all built-in and custom pen buttons on an InkToolbar.

Gets or sets the maximum possible Size of an ink stroke.

The maximum possible width of the ink stroke. The default is 0.

Identifies the MaxStrokeWidth dependency property.

The identifier for the MaxStrokeWidth dependency property.

Gets or sets the minimum possible Size of an ink stroke.

The maximum possible width of the ink stroke. The default is 0.

Identifies the MinStrokeWidth dependency property.

The identifier for the MinStrokeWidth dependency property.

Gets or sets the collection of brushes available on the ink stroke configuration flyout associated with the InkToolbarPenButton. An "extension glyph" is displayed on the button to indicate the existence of the flyout.

A collection of Brush objects that describe various properties of the ink stroke. The default is 0 (empty).

Identifies the Palette dependency property.

The identifier for the Palette dependency property.

Gets the brush used to draw the ink stroke.

The brush used to draw the ink stroke. The default value is 0 (Black ).

Gets or sets the selected brush in the Palette.

The index of the brush in the Palette. The default is 0.

Identifies the SelectedBrushIndex dependency property.

The identifier for the SelectedBrushIndex dependency property.

Identifies the SelectedBrush dependency property.

The identifier for the SelectedBrush dependency property.

Gets or sets the value that specifies the Size of the pen tip used to draw the ink stroke.

The width used to specify the Size of the pen tip. The default is 0.

Identifies the SelectedStrokeWidth dependency property.

The identifier for the SelectedStrokeWidth dependency property.

Represents an InkToolbar toggle button control that activates the built-in pencil.

Initializes a new instance of the InkToolbarPencilButton class.

Represents an object used to configure an optional flyout associated with an InkToolbarCustomPenButton. An "extension glyph" is displayed on the button to indicate the existence of the flyout.

Initializes a new instance of the InkToolbarPenConfigurationControl class.

Gets the InkToolbarPenButton from which to derive the ConfigurationContent for the optional flyout.

The base pen from which ConfigurationContent is derived.

Identifies the PenButton dependency property.

The identifier for the PenButton dependency property.

Represents an InkToolbar button that sets the state of the built-in ruler tool to on or off.

InkToolbarRulerButton is deprecated starting from Windows 10 Creators Update. Please use InkToolbarStencilButton going forward. For more info, see MSDN.

Initializes a new instance of the InkToolbarRulerButton class.

InkToolbarRulerButton is deprecated starting from Windows 10 Creators Update. Please use InkToolbarStencilButton going forward. For more info, see MSDN.

Gets the stencil associated with the InkToolbarRulerButton.

The stencil associated with the InkToolbarRulerButton.

Identifies the Ruler dependency property.

The identifier for the Ruler dependency property.

Represents an InkToolbar button that sets the state of stencil tool to on or off.

Initializes a new instance of the InkToolbarStencilButton class.

Gets or sets whether the built-in protractor stencil button is visible.

**true** if visible. Otherwise, **false**.

Identifies the IsProtractorItemVisible dependency property.

The identifier for the IsProtractorItemVisible dependency property.

Gets or sets whether the built-in ruler stencil button is visible.

**true** if visible. Otherwise, **false**.

Identifies the IsRulerItemVisible dependency property.

The identifier for the IsRulerItemVisible dependency property.

Gets a reference to the protractor tool of the InkPresenter object.

The protractor tool.

Identifies the Protractor dependency property.

The identifier for the Protractor dependency property.

Gets a reference to the ruler tool of the InkPresenter object.

The ruler tool.

Identifies the Ruler dependency property.

The identifier for the Ruler dependency property.

Gets or sets the selected stencil button.

The selected stencil button.

Identifies the SelectedStencil dependency property.

The identifier for the SelectedStencil dependency property.

Specifies the types of InkToolbar stencils.

A protractor for drawing arcs and curves

A straight rule for drawing straight lines.

Defines constants that specify the button types exposed in the toggle button group of an InkToolbar.

A toggle button for a custom tool.

A toggle button for a stencil tool.

Represents an object that provides infrastructure for both built-in and custom toggle buttons on an InkToolbar.

Gets the type of built-in or custom tool associated with the InkToolbarToggleButton.

The type of tool.

Defines constants that specify the type of built-in or custom tool associated with the InkToolbarToolButton.

A pen tool that renders a solid, opaque stroke, with the stroke size dependent on the pen pressure detected (default size is 2x2 pixels).

A custom pen tool.

A custom non-pen tool.

A pen tool that deletes any ink strokes that intersect with the erase stroke.

A pen tool that renders a semi-transparent highlighter overlay stroke.

A pen tool that renders a soft-edged, semi-transparent stroke that can be layered for shading effects. The stroke opacity is dependent on the pen pressure detected.

Provides a base class for all built-in and custom buttons on an InkToolbar.

Gets or sets whether a glyph is shown on the InkToolbarToolButton to indicate the presence of an ink stroke configuration flyout.

**true** if the glyph is shown; otherwise, **false**.

Identifies the IsExtensionGlyphShown dependency property.

The identifier for the IsExtensionGlyphShown dependency property.

Gets the type of built-in or custom tool associated with the InkToolbarToolButton.

The type of tool.

Specifies a contract for a scrolling control that supports scroll anchoring.

The currently chosen anchor element to use for scroll anchoring.

The most recently chosen UIElement for scroll anchoring after a layout pass, or **null**.

Registers a UIElement as a potential scroll anchor candidate.

A UIElement within the subtree of the IScrollAnchorProvider.

Unregisters a UIElement as a potential scroll anchor candidate.

A UIElement within the subtree of the IScrollAnchorProvider.

Communicates the info needed for a view to serve as one of the two possible views (ZoomedOutView or ZoomedInView ) of a SemanticZoom.

Gets or sets a value that indicates whether the implementing view is the active view.

**true** if the implementing view is the active view; otherwise, **false**.

Gets or sets a value that indicates whether the implementing view is the semantically more complete zoomed-in view.

**true** if the implementing view is the zoomed-in view; otherwise, **false**.

Gets or sets the SemanticZoom owner that hosts the implementing view.

The SemanticZoom that hosts this view.

Changes related aspects of presentation (such as scrolling UI or state) when the overall view for a SemanticZoom changes.

Completes item-wise operations related to a view change when the implementing view is the source view and the new view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Completes item-wise operations related to a view change when the implementing view is the destination view and the source view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Initializes the changes to related aspects of presentation (such as scrolling UI or state) when the overall view for a SemanticZoom is about to change.

Forces content in the view to scroll until the item specified by SemanticZoomLocation is visible. Also focuses that item if found.

The item in the view to scroll to.

Initializes item-wise operations related to a view change when the implementing view is the source view and the pending destination view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Initializes item-wise operations related to a view change when the source view is a different view and the pending destination view is the implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Provides event data for the **IsTextTrimmedChanged** event.

Provides event data for the ItemClick event.

Initializes a new instance of the ItemClickEventArgs class.

Gets a reference to the clicked item.

The clicked item.

Represents the method that will handle an ItemClick event.

The object where the handler is attached. Event data for the event.

Holds the list of items that represent the content of an ItemsControl.

Gets the size (count) of the collection.

The count of items in the collection.

Occurs when the items list of the collection has changed, or the collection is reset.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The item value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item, if it is found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the item value specified.

The index at which to set the value. The value to set.

Provides mappings between the items of an ItemsControl and their container elements.

Occurs when the contents of the items collection changes.

Returns the container for the item at the specified index within the ItemCollection.

ContainerFromIndex may be altered or unavailable for releases after Windows 8.1. Instead, use ItemsControl.ContainerFromIndex. The index of the item to retrieve. The container for the item at the specified index within the item collection, if the item has a container; otherwise, null.

Returns the container corresponding to the specified item.

ContainerFromItem may be altered or unavailable for releases after Windows 8.1. Instead, use ItemsControl.ContainerFromItem. The item to retrieve the container for. A container that corresponds to the specified item, if the item has a container and exists in the collection; otherwise, **null**.

Returns the container element used to display the next item, and indicates whether the container element has been newly generated (realized).

**true** if the returned DependencyObject is newly generated (realized); otherwise, **false**. A DependencyObject that is the container element that is used to display the next item.

Gets the generated position of the item at the specified index.

The index of the item to retrieve the position of. The position of the item as generated by the ItemContainerGenerator.

Returns the ItemContainerGenerator that is appropriate for use by the specified panel.

The panel for which to return an appropriate ItemContainerGenerator. An ItemContainerGenerator appropriate for use by the specified panel.

Returns the index to the item that has the specified, generated container.

IndexFromContainer may be altered or unavailable for releases after Windows 8.1. Instead, use ItemsControl.IndexFromContainer. The generated container to retrieve the item index for. The index to the item that corresponds to the specified generated container.

Returns the index that maps to the specified GeneratorPosition.

The GeneratorPosition for the desired index. The index that maps to the specified GeneratorPosition.

Returns the item that corresponds to the specified, generated container.

ItemFromContainer may be altered or unavailable for releases after Windows 8.1. Instead, use ItemsControl.ItemFromContainer. The DependencyObject that corresponds to the item to be returned. The contained item, or the container if it does not contain an item.

Prepares the specified element as the container for the corresponding item.

The container to prepare. Typically, *container* is the result of the previous call to GenerateNext.

Disassociates item containers from their data items and saves the containers so they can be reused later for other data items.

The zero-based index of the first element to reuse. *position* must refer to a previously generated (realized) item. The number of elements to reuse, starting at *position*.

Removes one or more generated (realized) items.

The index of the element to remove. *position* must refer to a previously generated (realized) item, which means its offset must be zero. The number of elements to remove, starting at *position*.

Removes all generated (realized) items.

Prepares the generator to generate items, starting at the specified GeneratorPosition and moving in the specified GeneratorDirection. This method also controls whether or not to start at a generated (realized) item.

A GeneratorPosition that specifies the position of the item to start generating items at. Specifies the position of the item to start generating items at. Specifies whether to start at a generated (realized) item.

Disposes the ItemContainerGenerator.

Represents a control that can be used to present a collection of items.

Initializes a new instance of the ItemsControl class.

Gets or sets the name or path of the property that is displayed for each data item.

The name or path of the property that is displayed for each the data item in the control. The default is an empty string ("").

Identifies the DisplayMemberPath dependency property.

The identifier for the DisplayMemberPath dependency property.

Gets a collection of GroupStyle objects that define the appearance of each level of groups.

A collection of GroupStyle objects that define the appearance of each level of groups.

Gets or sets a reference to a custom GroupStyleSelector logic class. The GroupStyleSelector returns different GroupStyle values to use for content based on the characteristics of that content.

A reference to a custom GroupStyleSelector logic class.

Identifies the GroupStyleSelector dependency property.

The identifier for the GroupStyleSelector dependency property.

Gets a value that indicates whether the control is using grouping.

**true** if a control is using grouping; otherwise, **false**.

Identifies the IsGrouping dependency property.

The identifier for the IsGrouping dependency property.

Gets the ItemContainerGenerator associated with this ItemsControl.

The ItemContainerGenerator associated with this ItemsControl.

Gets or sets the style that is used when rendering the item containers.

The style applied to the item containers. The default is null.

Identifies the ItemContainerStyle dependency property.

The identifier for the ItemContainerStyle dependency property.

Gets or sets a reference to a custom StyleSelector logic class. The StyleSelector returns different Style values to use for the item container based on characteristics of the object being displayed.

A custom StyleSelector logic class.

Identifies the ItemContainerStyleSelector dependency property.

The identifier for the ItemContainerStyleSelector dependency property.

Gets or sets the collection of Transition style elements that apply to the item containers of an ItemsControl.

The collection of Transition style elements that apply to the item containers of an ItemsControl.

Identifies the ItemContainerTransitions dependency property.

The identifier for the ItemContainerTransitions dependency property.

Gets the collection used to generate the content of the control.

The collection that is used to generate the content of the control, if it exists; otherwise, null. The default is an empty collection.

Gets or sets the template that defines the panel that controls the layout of items.

An ItemsPanelTemplate that defines the panel to use for the layout of the items. The default value for the ItemsControl is an ItemsPanelTemplate that specifies a StackPanel.

Identifies the ItemsPanel dependency property.

The identifier for the ItemsPanel dependency property.

Gets the Panel specified by ItemsPanel.

The Panel specified by ItemsPanel. The default is **null**.

Gets or sets an object source used to generate the content of the ItemsControl.

The object that is used to generate the content of the ItemsControl. The default is `null`.

Identifies the ItemsSource dependency property.

The identifier for the ItemsSource dependency property.

Gets or sets the DataTemplate used to display each item.

The template that specifies the visualization of the data objects. The default is null.

Identifies the ItemTemplate dependency property.

The identifier for the ItemTemplate dependency property.

Gets or sets a reference to a custom DataTemplateSelector logic class. The DataTemplateSelector referenced by this property returns a template to apply to items.

A reference to a custom DataTemplateSelector logic class.

Identifies the ItemTemplateSelector dependency property.

The identifier for the ItemTemplateSelector dependency property.

Undoes the effects of the PrepareContainerForItemOverride method.

The container element. The item.

Returns the container for the item at the specified index within the ItemCollection.

The index of the item to retrieve. The container for the item at the specified index within the item collection, if the item has a container; otherwise, **null**.

Returns the container corresponding to the specified item.

The item to retrieve the container for. A container that corresponds to the specified item, if the item has a container and exists in the collection; otherwise, **null**.

Creates or identifies the element that is used to display the given item.

The element that is used to display the given item.

Returns the ItemsControl that the specified element hosts items for.

The host element. The ItemsControl that the specified element hosts items for, or null.

Returns the group header container that corresponds to the specified container element.

The container element to return the group header container for. The group header container associated with the specified item container.

Returns the index to the item that has the specified, generated container.

The generated container to retrieve the item index for. The index to the item that corresponds to the specified generated container.

Determines whether the specified item is (or is eligible to be) its own container.

The item to check. **true** if the item is (or is eligible to be) its own container; otherwise, **false**.

Returns the item that corresponds to the specified, generated container.

The DependencyObject that corresponds to the item to be returned. The contained item, or the container if it does not contain an item.

Returns the ItemsControl that owns the specified container element.

The container element to return the ItemsControl for. The ItemsControl that owns the specified container element; otherwise, null.

Invoked when the value of the GroupStyleSelector property changes.

The previous value of the GroupStyleSelector property. The current value of the GroupStyleSelector property.

Invoked when the value of the ItemContainerStyle property changes.

The previous value of the ItemContainerStyle property. The current value of the ItemContainerStyle property.

Invoked when the value of the ItemContainerStyleSelector property changes.

The previous value of the ItemContainerStyleSelector property. The current value of the ItemContainerStyleSelector property.

Invoked when the value of the Items property changes.

Event data. Not specifically typed in the current implementation.

Invoked when the value of the ItemTemplate property changes.

The previous value of the ItemTemplate property. The current value of the ItemTemplate property.

Invoked when the value of the ItemTemplateSelector property changes.

The previous value of the ItemTemplateSelector property. The current value of the ItemTemplateSelector property.

Prepares the specified element to display the specified item.

The element that's used to display the specified item. The item to display.

Specifies the panel that the ItemsPresenter creates for the layout of the items of an ItemsControl.

Initializes a new instance of the ItemsPanelTemplate class.

Provides data for the ItemsPicked event.

Initializes a new instance of the ItemsPickedEventArgs class.

Gets the collection of items that were selected by the user.

The collection of items that were selected by the user.

Gets the collection of items that were unselected.

The collection of items that were unselected.

Specifies where items are placed in a control, usually an ItemsControl.

Initializes a new instance of the ItemsPresenter class.

Gets a value that indicates whether the horizontal snap points for the ItemsPresenter are equidistant from each other.

**True** if the horizontal snap points for the ItemsPresenter are equidistant from each other; otherwise, **false**.

Gets a value that indicates whether the vertical snap points for the ItemsPresenter are equidistant from each other.

**True** if the vertical snap points for the ItemsPresenter are equidistant from each other; otherwise, **false**.

Gets or sets the content for the items footer.

The content of the items footer. The default is **null**.

Identifies the Footer dependency property.

The identifier for the Footer dependency property.

Gets or sets the DataTemplate used to display the content of the items header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the FooterTemplate dependency property.

The identifier for the FooterTemplate dependency property.

Gets or sets the collection of Transition style elements that apply to the footer of an ItemsPresenter.

The collection of Transition style elements that apply to the footer of an ItemsPresenter.

Identifies the FooterTransitions dependency property.

The identifier for the FooterTransitions dependency property.

Gets or sets the content for the items header.

The content of the items header. The default value is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the items header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets the collection of Transition style elements that apply to the header of an ItemsPresenter.

The collection of Transition style elements that apply to the header of an ItemsPresenter.

Identifies the HeaderTransitions dependency property.

The identifier for the HeaderTransitions dependency property.

Gets or sets the distance between the ItemsPresenter and its child objects.

The dimensions of the space between the presenter and its children as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Occurs when the horizontal snap points change.

Occurs when the vertical snap points change.

Returns a read-only collection of numbers that represent the snap points for the specified orientation.

The orientation of the requested snap points. The alignment used by the caller when applying the requested snap points. A read-only collection of numbers that represent the snap points for the specified orientation, or an empty collection when no snap points are present.

Returns an original offset and interval for equidistant snap points for the specified orientation.

The orientation of the requested snap points. The alignment used by the caller when applying the requested snap points. The offset of the first snap point. The interval between equidistant snap points for the specified orientation or 0 when no snap points are present.

Arranges child elements of an ItemsControl into a single line that can be oriented horizontally or vertically. Supports pixel-based UI virtualization and grouped layouts.

Initializes a new instance of the ItemsStackPanel class.

Gets or sets a value that specifies whether a group header moves with the group when the group is panned vertically.

**true** if the group header moves with the group when the group is panned vertically; otherwise, **false**. The default is **true**.

Identifies the AreStickyGroupHeadersEnabled dependency property.

The identifier for the AreStickyGroupHeadersEnabled dependency property.

Gets or sets the size of the buffers for items outside the viewport, in multiples of the viewport size.

The size of the buffers for items outside the viewport, in multiples of the viewport size. The default is 4.0.

Identifies the CacheLength dependency property.

The identifier for the CacheLength dependency property.

Gets the index in the data collection of the first item in the cache.

The index in the data collection of the first item in the cache. The default is -1.

Gets the index in the data collection of the first item on the screen. Partially visible items are considered to be on screen.

The index in the data collection of the first item on the screen. The default is -1.

Gets or sets a value that specifies where group headers are positioned in relation to the group.

An enumeration value that specifies where group headers are positioned in relation to the group. The default is **Top**.

Identifies the GroupHeaderPlacement dependency property.

The identifier for the GroupHeaderPlacement dependency property.

Gets or sets the amount of space around a group.

The amount of space around a group as a Thickness value. Thickness is a structure that stores dimension values using pixel measures. The default is a uniform Thickness of 0.

Identifies the GroupPadding dependency property.

The identifier for the GroupPadding dependency property.

Gets or sets a value that specifies scrolling behavior when the ItemsSource is updated.

A value of the enumeration. The default is **KeepItemsInView**.

Gets the index in the data collection of the last item in the cache.

The index in the data collection of the last item in the cache. The default is -1.

Gets the index in the data collection of the last item on the screen. Partially visible items are considered to be on screen.

The index in the data collection of the last item on the screen. The default is -1.

Gets or sets the dimension by which child elements are stacked.

One of the enumeration values that specifies the orientation of child elements. The default is **Vertical**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets a value that indicates whether items are panning forward or backward, or aren't panning.

An enumeration value that indicates whether the items are panning **Forward** or **Backward**, or **None** if the items are not panning.

Defines constants that specify the scrolling behavior of items while updating.

Adjusts the scroll offset to keep the first visible item in the viewport when items are added to the ItemsSource.

Adjusts the scroll offset to keep the last visible item in the viewport when items are added to the ItemsSource.

Maintains the scroll offset relative to the beginning of the list, forcing items in the viewport to move down when items are added to the ItemsSource.

Positions child elements sequentially from left to right or top to bottom in an ItemsControl that shows multiple items. When elements extend beyond the container edge, elements are positioned in the next row or column. Supports pixel-based UI virtualization and grouped layouts.

Initializes a new instance of the ItemsWrapGrid class.

Gets or sets a value that specifies whether a group header moves with the group when the group is panned vertically.

**true** if the group header moves with the group when the group is panned vertically; otherwise, **false**. The default is **true**.

Identifies the AreStickyGroupHeadersEnabled dependency property.

The identifier for the AreStickyGroupHeadersEnabled dependency property.

Gets or sets the size of the buffers for items outside the viewport, in multiples of the viewport size.

The size of the buffers for items outside the viewport, in multiples of the viewport size. The default is 4.0.

Identifies the CacheLength dependency property.

The identifier for the CacheLength dependency property.

Gets the index in the data collection of the first item in the cache.

The index in the data collection of the first item in the cache. The default is -1.

Gets the index in the data collection of the first item on the screen. Partially visible items are considered to be on screen.

The index in the data collection of the first item on the screen. The default is -1.

Gets or sets a value that specifies where group headers are positioned in relation to the group.

An enumeration value that specifies where group headers are positioned in relation to the group. The default is **Top**.

Identifies the GroupHeaderPlacement dependency property.

The identifier for the GroupHeaderPlacement dependency property.

Gets or sets the amount of space around a group.

The amount of space around a group as a Thickness value. Thickness is a structure that stores dimension values using pixel measures. The default is a uniform Thickness of 0.

Identifies the GroupPadding dependency property.

The identifier for the GroupPadding dependency property.

Gets or sets the height of the layout area for each item that is contained in an ItemsWrapGrid.

The height of the layout area for each item that is contained in an ItemsWrapGrid. The default is **Double.NaN**, which results in the "Auto" layout behavior.

Identifies the ItemHeight dependency property.

The identifier for the ItemHeight dependency property.

Gets or sets the width of the layout area for each item that is contained in an ItemsWrapGrid.

The width of the layout area for each item that is contained in an ItemsWrapGrid. The default is Double.NaN, which results in the "Auto" layout behavior.

Identifies the ItemWidth dependency property.

The identifier for the ItemWidth dependency property.

Gets the index in the data collection of the last item in the cache.

The index in the data collection of the last item in the cache. The default is -1.

Gets the index in the data collection of the last item on the screen. Partially visible items are considered to be on screen.

The index in the data collection of the last item on the screen. The default is -1.

Gets or sets a value that influences the wrap point, also accounting for Orientation.

The maximum rows or columns that this ItemsWrapGrid should present before it introduces wrapping to the layout. The default is -1, which is a special value that indicates no maximum.

Identifies the MaximumRowsOrColumns dependency property.

The identifier for the MaximumRowsOrColumns dependency property.

Gets or sets the dimension by which child elements are stacked.

One of the enumeration values that specifies the orientation of child elements. The default is **Vertical**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets a value that indicates whether items are panning forward or backward, or aren't panning.

An enumeration value that indicates whether the items are panning **Forward** or **Backward**, or **None** if the items are not panning.

Defines constants that specify whether the area outside of a *light-dismiss* UI is darkened.

The device-family the app is running on determines whether the area outside of a *light-dismiss* UI is darkened.

The area outside of a *light-dismiss* UI is not darkened for all device families.

The area outside of a *light-dismiss* UI is darkened for all device families.

Presents a list of items the user can select from.

Initializes a new instance of the ListBox class.

Gets the list of currently selected items for the ListBox control.

The list of currently selected items for the ListBox control.

Gets or sets the selection behavior for the ListBox control.

One of the SelectionMode values.

Identifies the SelectionMode dependency property.

The identifier for the SelectionMode dependency property.

Gets or sets a value that indicates whether item selection changes when keyboard focus changes.

**true** if item selection changes when keyboard focus changes; otherwise, **false**. The default is **true**.

Identifies the SingleSelectionFollowsFocus dependency property.

The identifier for the SingleSelectionFollowsFocus dependency property.

Causes the object to scroll into view.

The object to scroll to.

Selects all the items in the ListBox control.

Represents the container for an item in a ListBox control.

Initializes a new instance of the ListBoxItem class.

Represents a control that allows a user to pick one or more items from a list. See Remarks.

Initializes a new instance of the ListPickerFlyout class.

Gets or sets the name or path of the property that is displayed for each data item

The name or path of the property that is displayed for each the data item in the control. The default is an empty string ("").

Identifies the DisplayMemberPath dependency property.

The identifier for the DisplayMemberPath dependency property.

Gets or sets an object source used to generate the content of the control.

The object that is used to generate the content of the control. The default is null.

Identifies the ItemsSource dependency property.

The identifier for the ItemsSource dependency property.

Gets or sets the DataTemplate used to display each item.

The template that specifies the visualization of the data objects. The default is null.

Identifies the ItemTemplate dependency property.

The identifier for the ItemTemplate dependency property.

Gets or sets the index of the selected item.

The index of the selected item. The default is -1.

Identifies the SelectedIndex dependency property.

The identifier for the SelectedIndex dependency property.

Gets or sets the selected item.

The selected item. The default is null.

Identifies the SelectedItem dependency property.

Identifies the SelectedItem dependency property.

Gets the list of currently selected items.

The list of currently selected items.

Gets or sets the value of the selected item, obtained by using the SelectedValuePath

The value of the selected item, obtained by using the SelectedValuePath, or null if no item is selected. The default value is null.

Gets or sets the property path that is used to get the SelectedValue property of the SelectedItem property.

The property path that is used to get the SelectedValue property of the SelectedItem property. The default is String.Empty.

Identifies the SelectedValuePath dependency property.

The identifier for the SelectedValuePath dependency property.

Identifies the SelectedValue dependency property.

The identifier for the SelectedValue dependency property.

Gets or sets the selection mode of the picker.

The selection mode of the picker.

Identifies the SelectionMode dependency property.

The identifier of the SelectionMode dependency property.

Occurs when the user has selected items.

Begins an asynchronous operation to show the flyout placed in relation to the specified element.

The element to use as the flyout's placement target. An asynchronous operation.

Represents a control that allows a user to pick one or more items from a list. (Not recommended for Universal Windows Platform (UWP) app. See Flyout.)

Defines constants that specify the selection mode of a ListPickerFlyout.

The user can select multiple items.

A user can select only one item.

Represents a control that displays data items in a vertical stack.

Initializes a new instance of the ListView class.

Provides the infrastructure for the ListView and GridView classes.

Provides base-class initialization behavior for classes that are derived from the ListViewBase class.

Gets or sets a value that indicates whether items in the view can be dragged as data payload.

**True** if items in the view can be dragged as data payload; otherwise, **false**. The default is **false**.

Identifies the CanDragItems dependency property.

The identifier for the CanDragItems dependency property.

Gets or sets a value that indicates whether items in the view can be reordered through user interaction.

**True** if items in the view can be reordered through user interaction; otherwise, **false**. The default is **false**.

Identifies the CanReorderItems dependency property.

The identifier for the CanReorderItems dependency property.

Gets or sets the amount of data to fetch for virtualizing/prefetch operations.

The amount of data to fetch per interval, in pages.

Identifies the DataFetchSize dependency property.

The identifier for the DataFetchSize dependency property.

Gets or sets the content for the list footer.

The content of the list footer. The default is **null**.

Identifies the Footer dependency property.

The identifier for the Footer dependency property.

Gets or sets the DataTemplate used to display the content of the view footer.

The template that specifies the visualization of the footer object. The default is **null**.

Identifies the FooterTemplate dependency property.

The identifier for the FooterTemplate dependency property.

Gets or sets the collection of Transition style elements that apply to the view footer.

The collection of Transition style elements that apply to the list footer.

Identifies the FooterTransitions dependency property.

The identifier for the FooterTransitions dependency property.

Gets or sets the content for the list header.

The content of the list header. The default value is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the view header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets the collection of Transition style elements that apply to the view header.

The collection of Transition style elements that apply to the list header.

Identifies the HeaderTransitions dependency property.

The identifier for the HeaderTransitions dependency property.

Gets or sets the threshold range that governs when the ListViewBase class will begin to prefetch more items.

The loading threshold, in terms of pages.

Identifies the IncrementalLoadingThreshold dependency property.

The identifier for the IncrementalLoadingThreshold dependency property.

Gets or sets a value that indicates the conditions for prefetch operations by the ListViewBase class.

An enumeration value that indicates the conditions that trigger prefetch operations. The default is **Edge**.

Identifies the IncrementalLoadingTrigger dependency property.

The identifier for the IncrementalLoadingTrigger dependency property.

Gets or sets a value that indicates whether the ListViewBase instance is the active view in its owning SemanticZoom.

**true** if the ListViewBase is the active view; otherwise, **false**.

Identifies the IsActiveView dependency property.

The identifier for the IsActiveView dependency property.

Gets or sets a value that indicates whether items in the view fire an ItemClick event in response to interaction.

**true** if interaction fires an ItemClick event; otherwise, **false**. The default is **false**.

Identifies the IsItemClickEnabled dependency property.

The identifier for the IsItemClickEnabled dependency property.

Gets or sets a value that indicates whether a check box is shown to enable multi-selection.

**true** if a check box is shown to enable multi-selection; otherwise, **false**.

Get the identifier for the IsMultiSelectCheckBoxEnabled dependency property.

The identifier for the IsMultiSelectCheckBoxEnabled dependency property.

Gets or sets a value that indicates whether the view supports discrete input processing for a *swipe* interaction.

**true** if discrete input processing for *swipe* interactions is enabled; otherwise, **false**. The default is **true**.

Identifies the IsSwipeEnabled dependency property.

The identifier for the IsSwipeEnabled dependency property.

Gets or sets a value that indicates whether the ListViewBase instance is the zoomed-in view in its owning SemanticZoom.

**true** if the ListViewBase is the zoomed-in view; otherwise, **false**.

Identifies the IsZoomedInView dependency property.

The identifier for the IsZoomedInView dependency property.

Gets or sets the reorder behavior for a ListViewBase instance. When **Enabled**, unsorted and ungrouped lists can be reordered by user manipulation.

One of the ListViewReorderMode enumeration values. The default is **Disabled**.

Identifies the ReorderMode dependency property.

The identifier for the ReorderMode dependency property.

Gets the currently selected items.

A collection of the currently selected items. The default is an empty collection.

Gets a collection of ItemIndexRange objects that describe the currently selected items in the list.

The collection of ItemIndexRange objects that describe the currently selected items in the list. The default is an empty collection.

Gets or sets the selection behavior for a ListViewBase instance.

One of the ListViewSelectionMode enumeration values. The default is **Single** selection.

Identifies the SelectionMode dependency property.

The identifier for the SelectionMode dependency property.

Gets or sets the SemanticZoom instance that hosts the ListViewBase.

The SemanticZoom instance that hosts this view, or **null** if the view is not hosted in a SemanticZoom control.

Identifies the SemanticZoomOwner dependency property.

The identifier for the SemanticZoomOwner dependency property.

Gets or sets a value that indicates whether the view shows placeholder UI for items during scrolling.

**true** if the view shows placeholder UI for items during scrolling; otherwise, **false**. The default is **true**.

Identifies the ShowsScrollingPlaceholders dependency property.

The identifier for the ShowsScrollingPlaceholders dependency property.

Gets or sets a value that indicates whether item selection changes when keyboard focus changes.

**true** if item selection changes when keyboard focus changes; otherwise, **false**. The default is **true**.

Identifies the SingleSelectionFollowsFocus dependency property.

The identifier for the SingleSelectionFollowsFocus dependency property.

Occurs when an item container is to be chosen for a data group.

Occurs when an item container is to be chosen for a data item.

Occurs when the data item associated with a UI container changes.

Occurs when a drag operation that involves one of the items in the view is ended. In order to receive this event, set the **CanDragItems** property to **True**.

Occurs when a drag operation that involves one of the items in the view is initiated.

Occurs when an item in the list view receives an interaction, and the IsItemClickEnabled property is **true**.

Changes related aspects of presentation when the overall view for a SemanticZoom changes.

Completes item-wise operations that are related to a view change when the ListViewBase instance is the source view and the new view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Completes item-wise operations that are related to a view change when the ListViewBase instance is the destination view and the source view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Deselects a block of items described by the ItemIndexRange.

Information about the range of items, including the index of the first and last items in the range, and the number of items.

Initializes the changes to related aspects of presentation (such as scrolling UI or state) when the overall view for a SemanticZoom is about to change.

Returns a value that indicates whether the list view is both the drag source and drop target in a drag-and-drop operation.

**true** if the list view is both the drag source and drop target; otherwise, **false**.

Initiates the asynchronous request to load more data items, in accordance with the active incremental loading settings.

When the operation completes, returns a LoadMoreItemsResult payload.

Forces content in the view to scroll until the item that's specified by SemanticZoomLocation is visible. Also focuses the item if it finds the item.

The item in the view to scroll to.

Returns a connected animation that's associated with the specified key, data item, and source element.

The key for the animation. The data item that is animated out of view. The name of the element in the ItemTemplate that provides the animated visual. The animation with the specified key.

Scrolls the list to bring the specified data item into view.

The data item to bring into view.

Scrolls the list to bring the specified data item into view with the specified alignment.

The data item to bring into view. An enumeration value that specifies whether the item uses **Default** or **Leading** alignment.

Selects all the items in a view.

Selects a block of items described by the ItemIndexRange.

Information about the range of items, including the index of the first and last items in the range, and the number of items.

Sets the maximum target time between two render passes when a ListViewBase is updating its UI with data items during initial load or scrolling.

The maximum target time between two render passes.

Initializes item-wise operations that are related to a view change when the ListViewBase instance is the source view and the pending destination view is a potentially different implementing view.

The view item as represented in the source view. The view item as represented in the destination view.

Initializes item-wise operations that are related to a view change when the source view is a different view and the pending destination view is the ListViewBase instance.

The view item as represented in the source view. The view item as represented in the destination view.

Attempts to start the animation.

The animation to start. The data item that is animated into view. The name of the element in the ItemTemplate that provides the animated visual. **true** if the animation started; **false** if the animation has already been started, if it is no longer active, or if the destination element is the same as the source element.

Provides the infrastructure for the ListViewHeaderItem and GridViewHeaderItem classes.

Represents items in the header for grouped data inside a ListView.

Initializes a new instance of the ListViewHeaderItem class.

Represents the container for an item in a ListView control.

Initializes a new instance of the ListViewItem class.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when you're defining templates for a ListViewItem class.

An object that provides calculated values for templates.

Represents the method that will handle callback for the GetRelativeScrollPosition method.

The key of the item. The ListView item.

Represents the asynchronous method that will handle callback for the SetRelativeScrollPositionAsync method.

An asynchronous operation that, upon successful completion, returns the ListView item represented by the specified key. The key of the ListView item.

Represents a helper class to save and retrieve the relative scroll position of the ListView.

Retrieves the relative scroll position of the ListView.

The ListView object. The method that will handle the retrieval of the item key. The relative scroll position of the ListView.

Begins an asynchronous action to set the relative scroll position of the ListView.

The ListView. The relative scroll position of the ListView. The method that will handle the retrieval of the ListView item given the key. An asynchronous action.

Defines constants that specify the reorder mode of a ListView or GridView.

A user can't reorder the list.

A user can reorder the list.

Defines constants that specify the selection mode of a ListView or GridView.

The user can select multiple items by entering a special mode, for example when depressing a modifier key.

The user can select multiple items without entering a special mode.

A user can't select items.

A user can select a single item.

Represents an object that renders audio and video to the display. See Remarks.

Instantiates a new instance of the MediaElement class.

Gets an enumeration value that determines the current value of stereo 3-D video frame-packing mode, accounting for other factors such as whether the media engine is ready for use.

A value of the enumeration. May be **None** if media engine is not ready for use.

Identifies the ActualStereo3DVideoPackingMode dependency property.

The identifier for the ActualStereo3DVideoPackingMode dependency property.

Gets or sets a value that determines whether the standard transport controls are enabled.

**true** if the standard transport controls are enabled; otherwise, **false**. The default is **false**.

Identifies the AreTransportControlsEnabled dependency property.

The identifier for the AreTransportControlsEnabled dependency property.

Gets the height portion of the native aspect ratio of the media.

The height portion of the native aspect ratio of the media. This value holds meaning only when you compare it with the value for the AspectRatioWidth property; the two properties together describe the aspect ratio.

Identifies the AspectRatioHeight  dependency property.

The identifier for the AspectRatioHeight dependency property.

Gets the width portion of the native aspect ratio of the media.

The width portion of the native aspect ratio of the media. This value holds meaning only when you compare it with the value for the AspectRatioHeight property; the two properties together describe the aspect ratio.

Identifies the AspectRatioWidth  dependency property.

The identifier for the AspectRatioWidth dependency property.

Gets or sets a value that describes the purpose of the audio information in an audio stream.

A value of the enumeration.

Identifies the AudioCategory dependency property.

The identifier for the AudioCategory dependency property.

Gets or sets a value that describes the primary usage of the device that is being used to play back audio.

A value of the enumeration.

Identifies the AudioDeviceType dependency property.

The identifier for the AudioDeviceType dependency property.

Gets the number of audio streams that exist in the current media file.

The number of audio streams that exist in the source media file. The default value is 0.

Identifies the AudioStreamCount dependency property.

The identifier for the AudioStreamCount dependency property.

Gets or sets the index of the audio stream that plays along with the video component. The collection of audio streams is composed at run time and represents all audio streams that are available in the media file.

The index in the media file of the audio component that plays along with the video component. The index can be unspecified, in which case the value is null. The default value is null.

Identifies the AudioStreamIndex dependency property.

The identifier for the AudioStreamIndex dependency property.

Gets or sets a value that indicates whether media will begin playback automatically when the Source property is set.

**true** if playback is automatic; otherwise, **false**. The default is **true**.

Identifies the AutoPlay dependency property.

The identifier for the AutoPlay dependency property.

Gets or sets a ratio of volume across stereo speakers.

The ratio of volume across speakers in the range between -1 and 1. The default value is 0.

Identifies the Balance  dependency property.

The identifier for the Balance dependency property.

Gets a value that indicates the current buffering progress.

The amount of buffering that is completed for media content. The value ranges from 0 to 1. Multiply by 100 to obtain a percentage.

Identifies the BufferingProgress dependency property.

The identifier for the BufferingProgress dependency property.

Gets a value that indicates whether media can be paused if the Pause method is called.

**true** if the media can be paused; otherwise, **false**.

Identifies the CanPause dependency property.

The identifier for the CanPause dependency property.

Gets a value that indicates whether media can be repositioned by setting the value of the Position property.

**true** if the media can be repositioned; otherwise, **false**.

Identifies the CanSeek dependency property.

The identifier for the CanSeek dependency property.

Gets the status of this MediaElement.

The current state of this MediaElement. The state can be one of the following (as defined in the MediaElementState enumeration): **Buffering**, **Closed**, **Opening**, **Paused**, **Playing**, or **Stopped**. The default value is **Closed**.

Identifies the CurrentState dependency property.

The identifier for the CurrentState dependency property.

Gets or sets the default playback rate for the media engine. The playback rate applies when the user isn't using fast forward or reverse.

The default playback rate. The default is 1.0, which indicates normal playback speed.

Identifies the DefaultPlaybackRate  dependency property.

The identifier for the DefaultPlaybackRate dependency property.

Gets a value that indicates the amount of download completed for content located on a remote server.

A value that indicates the amount of download completed for content that is located on a remote server. The value ranges from 0 to 1. Multiply by 100 to obtain a percentage.

Gets the offset of download progress, which is relevant in seek-ahead scenarios.

The offset of download progress.

Identifies the DownloadProgressOffset dependency property.

The identifier for the DownloadProgressOffset dependency property.

Identifies the DownloadProgress dependency property.

The identifier for the DownloadProgress dependency property.

Gets a value that reports whether the current source media is an audio-only media file.

**true** if the current source media is audio-only, otherwise, **false**.

Identifies the IsAudioOnly dependency property.

The identifier for the IsAudioOnly dependency property.

Gets a value that specifies if the MediaElement is rendering in full window mode. Setting this property enables or disables full window rendering.

**true** if the MediaElement is in full window mode; otherwise, **false**. The default is **false**.

Identifies the IsFullWindow dependency property.

The identifier for the IsFullWindow dependency property.

Gets or sets a value that describes whether the media source currently loaded in the media engine should automatically set the position to the media start after reaching its end.

**true** to loop the media and play continuously. **false** to not loop the media automatically. The default is **false**.

Identifies the IsLooping dependency property.

The identifier for the IsLooping dependency property.

Gets or sets a value indicating whether the audio is muted.

**true** if audio is muted; otherwise, **false**. The default is **false**.

Identifies the IsMuted  dependency property.

The identifier for the IsMuted dependency property.

Gets a value that reports whether the current source media is a stereo 3-D video media file.

**true** if the current source media is stereo 3-D video, otherwise, **false**.

Identifies the IsStereo3DVideo dependency property.

The identifier for the IsStereo3DVideo dependency property.

Gets the collection of timeline markers associated with the currently loaded media file.

The collection of timeline markers (represented as TimelineMarker objects) associated with the currently loaded media file. The default is an empty collection.

Gets the duration of the media file currently opened.

The natural duration of the media. The default value is a Duration structure that evaluates as Automatic, which is the value held if you query this property before MediaOpened.

Identifies the NaturalDuration dependency property.

The identifier for the NaturalDuration dependency property.

Gets the height of the video associated with the media.

The height of the video that is associated with the media, in pixels. Audio files return 0. The default is 0.

Identifies the NaturalVideoHeight dependency property.

The identifier for the NaturalVideoHeight dependency property.

Gets the width of the video associated with the media.

The width of the video associated with the media. The default is 0.

Identifies the NaturalVideoWidth dependency property.

The identifier for the NaturalVideoWidth dependency property.

Gets or sets the playback rate ratio for the media engine.

The playback rate ratio for the media. A value of 1.0 is the normal playback speed. Value can be negative to play backwards.

Identifies the PlaybackRate  dependency property.

The identifier for the PlaybackRate dependency property.

Gets or sets the path to the preferred media source which enables the Play To target device to stream the media content, which can be DRM protected, from a different location, such as a cloud media server.

The path to the preferred media source.

Identifies the PlayToPreferredSourceUri dependency property.

The identifier for the PlayToPreferredSourceUri dependency property.

Gets the information that is transmitted if the MediaElement is used for a "PlayTo" scenario.

A reference object that carries the "PlayTo" source information.

Identifies the PlayToSource dependency property.

The identifier for the PlayToSource dependency property.

Gets or sets the current position of progress through the media's playback time.

The amount of time since the beginning of the media. The default is a **TimeSpan** with value "0:0:0".

Identifies the Position dependency property.

The identifier the Position dependency property.

Gets or sets the image source that is used for a placeholder image during MediaElement loading transition states.

An image source for a transition ImageBrush that is applied to the MediaElement content area.

Identifies the PosterSource dependency property.

The identifier for the PosterSource dependency property.

Gets or sets the dedicated object for media content protection that is associated with this MediaElement.

The dedicated object for media content protection.

Identifies the ProtectionManager dependency property.

The identifier for the ProtectionManager dependency property.

Gets or sets a value that configures the MediaElement for real-time communications scenarios.

**true** to configure for real-time communications. **false** to not configure the MediaElement for real-time communications.

Identifies the RealTimePlayback dependency property.

The identifier for the RealTimePlayback dependency property.

Gets or sets a media source on the MediaElement.

The source of the element, as an object describing a Uniform Resource Identifier (URI). The default is **null**.

Identifies the Source  dependency property.

The identifier for the Source dependency property.

Gets or sets an enumeration value that determines the stereo 3-D video frame-packing mode for the current media source.

A value of the enumeration. See Remarks.

Identifies the Stereo3DVideoPackingMode dependency property.

The identifier for the Stereo3DVideoPackingMode dependency property.

Gets or sets an enumeration value that determines the stereo 3-D video render mode for the current media source.

A value of the enumeration.

Identifies the Stereo3DVideoRenderMode dependency property.

The identifier for the Stereo3DVideoRenderMode dependency property.

Gets or sets a value that describes how an MediaElement should be stretched to fill the destination rectangle.

A value of the Stretch enumeration that specifies how the source visual media is rendered. The default value is **Uniform**.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Gets or sets the transport controls for the media.

The transport controls for the media.

Gets or sets the media's volume.

The media's volume represented on a linear scale between 0 and 1. The default is 0.5.

Identifies the Volume  dependency property.

The identifier for the Volume dependency property.

Occurs when the BufferingProgress property changes.

Occurs when the value of the CurrentState property changes.

Occurs when the DownloadProgress property has changed.

Occurs when a timeline marker is encountered during media playback.

Occurs when the MediaElement finishes playing audio or video.

Occurs when there is an error associated with the media Source.

Occurs when the media stream has been validated and opened, and the file headers have been read.

Occurs when one or more streams fails to decode in content containing multiple streams.

Occurs when PlaybackRate or DefaultPlaybackRate value changes.

Occurs when the seek point of a requested seek operation is ready for playback.

Occurs when the value of the Volume property changes.

Applies an audio effect to playback. Takes effect for the next source that is set on this MediaElement.

The identifier for the desired effect. **true** if the effect shouldn't block playback when the effect can't be used at run time. **false** if the effect should block playback when the effect can't be used at run time. A property set that transmits property values to specific effects as selected by *effectID*.

Applies a video effect to playback. Takes effect for the next source that is set on this MediaElement.

The identifier for the desired effect. **true** if the effect shouldn't block playback when the effect can't be used at run time. **false** if the effect should block playback when the effect can't be used at run time. A property set that transmits property values to specific effects as selected by *effectID*.

Returns an enumeration value that describes the likelihood that the current MediaElement and its client configuration can play that media source.

A string that describes the desired type as a MIME string. A value of the enumeration that describes the likelihood that the current media engine can play the source.

Returns the media element as a CastingSource.

The media element as a CastingSource.

Returns the RFC 1766 language for the specified audio stream.

The index of the stream to get the language for. The RFC 1766 language for the specified audio stream, expressed as a string (for example, "en-us").

Pauses media at the current position.

Plays media from the current position.

Removes all effects for the next source set for this MediaElement.

Sets the Source of the MediaElement to the specified MediaStreamSource.

The media source.

Sets the source of the MediaElement to the specified media playback source.

The media playback source.

Sets the Source property using the specified stream and MIME type.

The stream that contains the media to load. The MIME type of the media resource, expressed as the string form typically seen in HTTP headers and requests. The empty string "" can be passed in as the *mimeType* value if the MIME type is unknown.

Stops and resets media to be played from the beginning.

Represents an object that uses a MediaPlayer to render audio and video to the display.

Initializes a new instance of the MediaPlayerElement class.

Gets or sets a value that determines whether the standard transport controls are enabled.

**true** if the standard transport controls are enabled; otherwise, **false**. The default is **false**.

Identifies the AreTransportControlsEnabled dependency property.

The identifier for the AreTransportControlsEnabled dependency property.

Gets or sets a value that indicates whether media will begin playback automatically when the Source property is set.

**true** if playback is automatic; otherwise, **false**. The default is **true**.

Identifies the AutoPlay dependency property.

The identifier for the AutoPlay dependency property.

Gets or sets a value that specifies if the MediaPlayerElement is rendering in full window mode.

**true** if the MediaPlayerElement is in full window mode; otherwise, **false**. The default is **false**.

Identifies the IsFullWindow dependency property.

The identifier for the IsFullWindow dependency property.

Gets the MediaPlayer instance used to render media.

The MediaPlayer instance used to render media.

Identifies the MediaPlayer dependency property.

The identifier for the MediaPlayer dependency property.

Gets or sets the image source that is used for a placeholder image during MediaPlayerElement loading transition states.

An image source for a transition ImageBrush that is applied to the MediaPlayerElement content area.

Identifies the PosterSource dependency property.

The identifier for the PosterSource dependency property.

Gets or sets a media source on the MediaPlayerElement.

The source of the media. The default is **null**.

Identifies the Source dependency property.

The identifier for the Source dependency property.

Gets or sets a value that describes how an MediaPlayerElement should be stretched to fill the destination rectangle.

A value of the Stretch enumeration that specifies how the source visual media is rendered. The default value is **Uniform**.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Gets or sets the transport controls for the media.

The transport controls for the media.

Sets the MediaPlayer instance used to render media.

The new MediaPlayer instance used to render media.

Represents an object that displays a MediaPlayer.

Initializes a new instance of the MediaPlayerPresenter class.

Gets or sets a value that specifies if the MediaPlayerPresenter is rendering in full window mode.

**true** if the MediaPlayerPresenter is in full window mode; otherwise, **false**. The default is **false**.

Identifies the IsFullWindow dependency property.

The identifier for the IsFullWindow dependency property.

Gets or sets the MediaPlayer instance used to render media.

The MediaPlayer instance used to render media.

Identifies the MediaPlayer dependency property.

The identifier for the MediaPlayer dependency property.

Gets or sets a value that describes how an MediaPlayerPresenter should be stretched to fill the destination rectangle.

A value of the Stretch enumeration that specifies how the source visual media is rendered. The default value is **Uniform**.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Represents the playback controls for a media player element.

Initializes a new instance of the MediaTransportControls class.

Gets or sets a value that specifies how the fast-forward/fast-rewind buttons behave.

A value of the enumeration that specifies how the fast-forward/fast-rewind buttons behave.

Identifies the FastPlayFallbackBehaviour dependency property.

The identifier for the FastPlayFallbackBehaviour dependency property.

Gets or sets a value that indicates whether transport controls are shown on one row instead of two.

**true** if the transport controls are shown in one row; **false** if the transport controls are shown in two rows. The default is **false**.

Gets or sets a value that indicates whether the compact overlay button is shown.

**true** to show the compact overlay button. **false** to hide the compact overlay button. The default is **false**.

Identifies the IsCompactOverlayButtonVisible dependency property.

The identifier for the IsCompactOverlayButtonVisible dependency property.

Gets or sets a value that indicates whether a user can enter compact overlay mode.

**true** to allow the user to enter compact overlay mode; otherwise, **false**.

Identifies the IsCompactOverlayEnabled dependency property.

The identifier for the IsCompactOverlayEnabled dependency property.

Identifies the IsCompact  dependency property.

The identifier for the IsCompact   dependency property.

Gets or sets a value that indicates whether the fast forward button is shown.

**true** to show the fast forward button. **false** to hide the fast forward button. The default is **false**.

Identifies the IsFastForwardButtonVisible dependency property.

The identifier for the IsFastForwardButtonVisible dependency property.

Gets or sets a value that indicates whether a user can fast forward the media.

**true** to allow the user to fast forward; otherwise, **false**. The default is **false**.

Identifies the IsFastForwardEnabled dependency property.

The identifier for the IsFastForwardEnabled dependency property.

Gets or sets a value that indicates whether the rewind button is shown.

**true** to show the rewind button. **false** to hide the rewind button. The default is **false**.

Identifies the IsFastRewindButtonVisible dependency property.

The identifier for the IsFastRewindButtonVisible dependency property.

Gets or sets a value that indicates whether a user can rewind the media.

**true** to allow the user to rewind; otherwise, **false**. The default is **false**.

Identifies the IsFastRewindEnabled dependency property.

The identifier for the IsFastRewindEnabled dependency property.

Gets or sets a value that indicates whether the full screen button is shown.

**true** to show the full screen button. **false** to hide the full screen button. The default is **true**.

Identifies the IsFullWindowButtonVisible dependency property.

The identifier for the IsFullWindowButtonVisible dependency property.

Gets or sets a value that indicates whether a user can play the media in full-screen mode.

**true** to allow the user to play the media in full-screen mode; otherwise, **false**. The default is **true**.

Identifies the IsFullWindowEnabled dependency property.

The identifier for the IsFullWindowEnabled dependency property.

Gets or sets a value that indicates whether the next track button is shown.

**true** to show the next track button. **false** to hide the next track button. The default is **false**.

Identifies the IsNextTrackButtonVisible dependency property.

The identifier for the IsNextTrackButtonVisible dependency property.

Gets or sets a value that indicates whether the playback rate button is shown.

**true** to show the playback rate button. **false** to hide the playback rate button. The default is **false**.

Identifies the IsPlaybackRateButtonVisible dependency property.

The identifier for the IsPlaybackRateButtonVisible dependency property.

Gets or sets a value that indicates whether a user can adjust the playback rate of the media.

**true** to allow the user to adjust the playback rate; otherwise, **false**. The default is **false**.

Identifies the IsPlaybackRateEnabled dependency property.

The identifier for the IsPlaybackRateEnabled dependency property.

Gets or sets a value that indicates whether the previous track button is shown.

**true** to show the previous track button. **false** to hide the previous track button. The default is **false**.

Identifies the IsPreviousTrackButtonVisible dependency property.

The identifier for the IsPreviousTrackButtonVisible dependency property.

Gets or sets a value that indicates whether the repeat button is shown.

**true** to show the repeat button. **false** to hide the repeat button. The default is **false**.

Identifies the IsRepeatButtonVisible dependency property.

The identifier for the IsRepeatButtonVisible dependency property.

Gets or sets a value that indicates whether a user repeat the playback of the media.

**true** to allow the user to repeat the media; otherwise, **false**. The default is **false**.

Identifies the IsRepeatEnabled dependency property.

The identifier for the IsRepeatEnabled dependency property.

Gets or sets a value that indicates whether the seek bar is shown.

**true** to show the seek bar. **false** to hide the seek bar. The default is **true**.

Identifies the IsSeekBarVisible dependency property.

The identifier for the IsSeekBarVisible dependency property.

Gets or sets a value that indicates whether a user can use the seek bar to find a location in the media.

**true** to allow the user to use the seek bar to find a location; otherwise, **false**. The default is **true**.

Identifies the IsSeekEnabled dependency property.

The identifier for the IsSeekEnabled dependency property.

Gets or sets a value that indicates whether the skip backward button is shown.

**true** to show the skip backward button. **false** to hide the skip backward button. The default is **false**.

Identifies the IsSkipBackwardButtonVisible dependency property.

The identifier for the IsSkipBackwardButtonVisible dependency property.

Gets or sets a value that indicates whether a user can skip backward in the media.

**true** to allow the user to skip backward; otherwise, **false**. The default is **false**.

Identifies the IsSkipBackwardEnabled dependency property.

The identifier for the IsSkipBackwardEnabled dependency property.

Gets or sets a value that indicates whether the skip forward button is shown.

**true** to show the skip forward button. **false** to hide the skip forward button. The default is **false**.

Identifies the IsSkipForwardButtonVisible dependency property.

The identifier for the IsSkipForwardButtonVisible dependency property.

Gets or sets a value that indicates whether a user can skip forward in the media.

**true** to allow the user to skip forward; otherwise, **false**. The default is **false**.

Identifies the IsSkipForwardEnabled dependency property.

The identifier for the IsSkipForwardEnabled dependency property.

Gets or sets a value that indicates whether the stop button is shown.

**true** to show the stop button. **false** to hide the stop button. The default is **false**.

Identifies the IsStopButtonVisible dependency property.

The identifier for the IsStopButtonVisible dependency property.

Gets or sets a value that indicates whether a user can stop the media playback.

**true** to allow the user to stop playback; otherwise, **false**. The default is **false**.

Identifies the IsStopEnabled dependency property.

The identifier for the IsStopEnabled dependency property.

Gets or sets a value that indicates whether the volume button is shown.

**true** to show the volume button. **false** to hide the volume button. The default is **true**.

Identifies the IsVolumeButtonVisible dependency property.

The identifier for the IsVolumeButtonVisible dependency property.

Gets or sets a value that indicates whether a user can adjust the volume of the media.

**true** to allow the user to adjust the volume; otherwise, **false**. The default is **true**.

Identifies the IsVolumeEnabled dependency property.

The identifier for the IsVolumeEnabled dependency property.

Gets or sets a value that indicates whether the zoom button is shown.

**true** to show the zoom button. **false** to hide the zoom button. The default is **true**.

Identifies the IsZoomButtonVisible dependency property.

The identifier for the IsZoomButtonVisible dependency property.

Gets or sets a value that indicates whether a user can zoom the media.

**true** to allow the user to zoom; otherwise, **false**. The default is **true**.

Identifies the IsZoomEnabled dependency property.

The identifier for the IsZoomEnabled dependency property.

Gets or sets a value that indicates whether the controls are shown and hidden automatically.

**true** if the controls are shown and hidden automatically; otherwise, **false**. The default is **true**.

Identifies the ShowAndHideAutomatically dependency property.

The identifier for the ShowAndHideAutomatically dependency property.

Occurs whenever the app needs to display a thumbnail adjacent to the seek bar when the user performs a seek operation.

Hides the transport controls if they're shown.

Shows the tranport controls if they're hidden.

Provides properties and methods to customize media transport controls.

Identifies the MediaTransportControlsHelper.DropoutOrder XAML attached property.

The identifier for the MediaTransportControlsHelper.DropoutOrder XAML attached property.

Gets the value of the MediaTransportControlsHelper.DropoutOrder XAML attached property for the target element.

The object from which the property value is read. The value to set. (The dropout priority of the control relative to other transport controls.)

Sets the value of the MediaTransportControlsHelper.DropoutOrder XAML attached property for a target element.

The object to which the property value is written. The value to set. (The dropout priority of the control relative to other transport controls.)

Represents a specialized container that presents a set of menus in a horizontal row, typically at the top of an app window.

Initializes a new instance of the MenuBar class.

Gets the collection of top-level menu items.

The collection of top-level menu items.

Identifies the Items dependency property.

The identifier for the Items dependency property.

Represents a top-level menu in a MenuBar control.

Initializes a new instance of the MenuBarItem class.

Gets the collection of commands in a MenuBar menu.

The collection of commands in a MenuBar menu.

Identifies the Items dependency property.

The identifier for the Items dependency property.

Gets or sets the text label for a MenuBar menu.

The text label for this menu. The default is an empty string.

Identifies the Title dependency property.

The identifier for the Title dependency property.

Represents the flyout of a MenuBar item.

Initializes a new instance of the MenuBarItemFlyout class.

Represents a flyout that displays a menu of commands.

Initializes a new instance of the MenuFlyout class.

Gets the collection used to generate the content of the menu.

The collection that is used to generate the content of the menu, if it exists; otherwise, **null**. The default is an empty collection.

Gets or sets the style that is used when rendering the MenuFlyout.

The style that is used when rendering the MenuFlyout.

Identifies the MenuFlyoutPresenterStyle dependency property.

The identifier for the MenuFlyoutPresenterStyle dependency property.

Shows the flyout placed at the specified offset in relation to the specified target element.

The element to use as the flyout's placement target. The point at which to offset the flyout from the specified target element.

Represents a command in a MenuFlyout control.

Initializes a new instance of the MenuFlyoutItem class.

Gets or sets the command to invoke when the item is pressed.

The command to invoke when the item is pressed. The default is **null**.

Gets or sets the parameter to pass to the Command property.

The parameter to pass to the Command property. The default is **null**.

Identifies the CommandParameter dependency property.

The identifier for the CommandParameter dependency property.

Identifies the Command dependency property.

The identifier for the Command dependency property.

Gets or sets the graphic content of the menu flyout item.

The graphic content of the menu flyout item.

Identifies the **Icon** dependency property.

The identifier for the **Icon** dependency property.

Gets or sets a string that overrides the default key combination string associated with a keyboard accelerator.

The string to replace the default key combination string. The default is null.

Identifies the MenuFlyoutItem.KeyboardAcceleratorTextOverride dependency property.

The identifier for the MenuFlyoutItem.KeyboardAcceleratorTextOverride dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for a MenuFlyoutItem control.

An object that provides calculated values for templates.

Gets or sets the text content of a MenuFlyoutItem.

A string that specifies the text content of this MenuFlyoutItem. The default is an empty string.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Occurs when a menu item is clicked.

Represents the base class for items in a MenuFlyout control.

Displays the content of a MenuFlyout control.

Initializes a new instance of the MenuFlyoutPresenter class.

Gets or sets a value that indicates whether the default shadow effect is shown.

**true** if the default shadow effect is shown; otherwise, **false**. The default is **true**.

Identifies the IsDefaultShadowEnabled dependency property.

The identifier for the IsDefaultShadowEnabled dependency property.

Gets an object that provides calculated values that can be referenced as [TemplateBinding](https://docs.microsoft.com/previous-versions/windows/apps/hh758288(v=win.10)) sources when defining templates for a MenuFlyoutPresenter control.

An object that provides calculated values for templates.

Represents a horizontal line that separates items in an MenuFlyout.

Initializes a new instance of the MenuFlyoutSeparator class.

Represents a menu item that displays a sub-menu in a MenuFlyout control.

Initializes a new instance of the MenuFlyoutSubItem class.

Gets or sets the graphic content of the menu flyout subitem.

The graphic content of the menu flyout subitem.

Identifies the **Icon** dependency property.

The identifier for the **Icon** dependency property

Gets the collection used to generate the content of the sub-menu.

The collection that is used to generate the content of the sub-menu, if it exists; otherwise, **null**. The default is an empty collection.

Gets or sets the text content of a MenuFlyoutSubItem.

A string that specifies the text content of this MenuFlyoutSubItem. The default is an empty string.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Represents a container that enables navigation of app content. It has a header, a view for the main content, and a menu pane for navigation commands.

Initializes a new instance of the NavigationView class.

Gets or sets a value that indicates whether the header is always visible.

**true** if the header is always visible; otherwise, **false**. The default is **true**.

Identifies the AlwaysShowHeader dependency property.

The identifier for the AlwaysShowHeader dependency property.

Gets or sets an AutoSuggestBox to be displayed in the NavigationView.

An AutoSuggestBox box to be displayed in the NavigationView.

Identifies the AutoSuggestBox dependency property.

The identifier for the AutoSuggestBox dependency property.

Gets or sets the minimum window width at which the NavigationView enters Compact display mode.

The minimum window width at which the NavigationView enters Compact display mode. The default is 641 pixels.

Identifies the CompactModeThresholdWidth dependency property.

The identifier for the CompactModeThresholdWidth dependency property.

Gets or sets the width of the NavigationView pane in its compact display mode.

The width of the pane in its compact display mode. The default is 48 device-independent pixel (DIP).

Identifies the CompactPaneLength dependency property.

The identifier for the CompactPaneLength dependency property.

Gets or sets a UI element that is shown at the top of the control, below the pane if PaneDisplayMode is Top.

The element that is shown at the top of the control.

Identifies the ContentOverlay dependency property.

The identifier for the ContentOverlay dependency property.

Gets a value that specifies how the pane and content areas of a NavigationView are being shown.

A value of the enumeration that specifies how the pane and content areas of a NavigationView are being shown.

Identifies the DisplayMode dependency property.

The identifier for the DisplayMode dependency property.

Gets or sets the minimum window width at which the NavigationView enters **Expanded** display mode.

The minimum window width at which the NavigationView enters **Expanded** display mode. The default is 1008 pixels.

Identifies the ExpandedModeThresholdWidth dependency property.

The identifier for the ExpandedModeThresholdWidth dependency property.

Gets or sets the header content.

The header content for the NavigationView.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the control's header.

The DataTemplate used to display the control's header.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the back button is enabled or disabled.

A value of the enumeration that specifies the visibility of the NavigationView back button. The default is "Auto".

Identifies the IsBackButtonVisible dependency property.

The identifier for the IsBackButtonVisible dependency property.

Gets or sets a value that indicates whether the back button is enabled or disabled.

**true** if the back button is enabled; otherwise, **false**. The default is **false**.

Identifies the IsBackEnabled dependency property.

The identifier for the IsBackEnabled dependency property.

Gets or sets a value that specifies whether the NavigationView pane is expanded to its full width.

**true** if the pane is expanded to its full width; otherwise, **false**.

Identifies the IsPaneOpen dependency property.

The identifier for the IsPaneOpen dependency property.

Gets or sets a value that indicates whether the menu toggle button is shown.

**true** if the menu button is shown; otherwise, **false**. The default is **true**.

Identifies the IsPaneToggleButtonVisible dependency property.

The identifier for the IsPaneToggleButtonVisible dependency property.

Gets or sets a value that determines whether the pane is shown.

**true** is the pane is shown; otherwise, **false**. The default is **true**.

Identifies the IsPaneVisible dependency property.

The identifier for the IsPaneVisible dependency property.

Gets or sets a value that indicates whether the settings button is shown.

**true** if the settings button is shown; otherwise, **false**. The default is **true**.

Identifies the IsSettingsVisible dependency property.

The identifier for the IsSettingsVisible dependency property.

Gets or sets the style that is used when rendering the menu item containers.

The style applied to the item containers. The default is **null**.

Identifies the MenuItemContainerStyle dependency property.

The identifier for the MenuItemContainerStyle dependency property.

Gets or sets a reference to a custom StyleSelector logic class. The StyleSelector returns different Style values to use for the item container based on characteristics of the object being displayed.

A custom StyleSelector logic class.

Identifies the MenuItemContainerStyleSelector dependency property.

The identifier for the MenuItemContainerStyleSelector dependency property.

Gets the collection of menu items displayed in the NavigationMenu.

The collection of menu items displayed in the NavigationMenu. The default is an empty collection.

Identifies the MenuItems dependency property.

The identifier for the MenuItems dependency property.

Gets or sets an object source used to generate the content of the NavigationView menu.

The object that is used to generate the content of the NavigationView menu. The default is **null**.

Identifies the MenuItemsSource dependency property.

The identifier for the MenuItemsSource dependency property.

Gets or sets the DataTemplate used to display each menu item.

The template that specifies the visualization of the menu data objects. The default is **null**.

Identifies the MenuItemTemplate dependency property.

The identifier for the MenuItemTemplate dependency property.

Gets or sets a reference to a custom DataTemplateSelector logic class. The DataTemplateSelector referenced by this property returns a template to apply to items.

A reference to a custom DataTemplateSelector logic class.

Identifies the MenuItemTemplateSelector dependency property.

The identifier for the MenuItemTemplateSelector dependency property.

Gets or sets the width of the NavigationView pane when it's fully expanded.

The width of the NavigationView pane when it's fully expanded. The default is 320 device-independent pixel (DIP).

Identifies the OpenPaneLength dependency property.

The identifier for the OpenPaneLength dependency property.

Gets or sets a value that indicates what text label is shown for the overflow menu.

A value of the enumeration that indicates what text label is shown for the overflow menu. The default is **MoreLabel**, which shows the text "More".

Identifies the OverflowLabelMode dependency property.

The identifier for the OverflowLabelMode dependency property.

Gets or sets a UI element that is shown in the NavigationView pane.

The element that is shown in the NavigationView pane.

Identifies the PaneCustomContent dependency property.

The identifier for the PaneCustomContent dependency property.

Gets or sets a value that indicates how and where the NavigationView pane is shown.

A value of the enumeration that indicates how and where the NavigationView pane is shown. The default is **Auto**.

Identifies the PaneDisplayMode dependency property.

The identifier for the PaneDisplayMode dependency property.

Gets or sets the content for the pane footer.

The content of the pane footer. The default is **null**.

Identifies the PaneFooter dependency property.

The identifier for the PaneFooter dependency property.

Gets or sets the content for the pane header.

The content of the pane header. The default is **null**.

Identifies the PaneHeader dependency property.

The identifier for the PaneHeader dependency property.

Gets or sets the label adjacent to the menu icon when the NavigationView pane is open.

The label adjacent to the menu icon when the pane is open. The default is an empty string.

Identifies the PaneTitle dependency property.

The identifier for the PaneTitle dependency property.

Gets or sets the Style that defines the look of the menu toggle button.

The Style that defines the look of the menu toggle button. The default is **null**.

Identifies the PaneToggleButtonStyle dependency property.

The identifier for the PaneToggleButtonStyle dependency property.

Gets or sets the selected item.

The selected item. The default is null.

Identifies the SelectedItem dependency property.

The identifier for the SelectedItem dependency property.

Gets or sets a value that indicates whether item selection changes when keyboard focus changes.

A value of the enumeration that indicates whether selection changes when keyboard focus changes. The default is **Disabled**.

Identifies the SelectionFollowsFocus dependency property.

The identifier for the SelectionFollowsFocus dependency property.

Gets the navigation item that represents the entry point to app settings.

The item that represents the entry point to app settings.

Identifies the SettingsItem dependency property.

The identifier for the SettingsItem dependency property.

Gets or sets a value that indicates when gamepad bumpers can be used to navigate the top-level navigation items in a NavigationView.

A value of the enumeration that indicates when gamepad bumpers can be used to navigate the top-level navigation items in a NavigationView. The default is **Never**.

Identifies the ShoulderNavigationEnabled dependency property.

The identifier for the ShoulderNavigationEnabled dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a NavigationView control.

An object that provides calculated values for templates.

Identifies the TemplateSettings dependency property.

The identifier for the TemplateSettings dependency property.

Occurs when the back button receives an interaction such as a click or tap.

Occurs when the DisplayMode property changes.

Occurs when an item in the menu receives an interaction such as a click or tap.

Occurs when the NavigationView pane is closed.

Occurs when the NavigationView pane is closing.

Occurs when the NavigationView pane is opened.

Occurs when the NavigationView pane is opening.

Occurs when the currently selected item changes.

Returns the container corresponding to the specified menu item.

The menu item to retrieve the container for. A container that corresponds to the specified menu item, if the item has a container and exists in the collection; otherwise, **null**.

Returns the item that corresponds to the specified, generated container.

The DependencyObject that corresponds to the item to be returned. The contained item, or the container if it does not contain an item.

Defines constants that specify whether the back button is visible in NavigationView.

The system chooses whether or not to display the back button, depending on the device/form factor. On phones, tablets, desktops, and hubs, the back button is visible. On Xbox/TV, the back button is collapsed.

Do not display the back button in NavigationView, and do not reserve space for it in layout.

Display the back button in NavigationView.

Provides event data for the NavigationView.BackRequested event.

Defines constants that specify how the pane is shown in a NavigationView.

The pane always shows as a narrow sliver which can be opened to full width.

The pane stays open alongside the content.

Only the menu button remains fixed. The pane shows and hides as needed.

Provides data for the NavigationView.DisplayModeChanged event.

Gets the new display mode.

The new display mode.

Represents the container for an item in a NavigationView control.

Initializes a new instance of the NavigationViewItem class.

Gets the CompactPaneLength of the NavigationView that hosts this item.

The CompactPaneLength of the NavigationView that hosts this item.

Identifies the CompactPaneLength dependency property.

The identifier for the CompactPaneLength dependency property.

Gets or sets the icon to show next to the menu item text.

The icon to show next to the menu item text. The default in **null**.

Identifies the Icon dependency property.

The identifier for the Icon dependency property.

Gets or sets a value that indicates whether invoking a navigation menu item also selects it.

**true** if invoking a navigation menu item also selects it; otherwise, **false**. The default is **true**.

Identifies the SelectsOnInvoked dependency property.

The identifier for the SelectsOnInvoked dependency property.

Base class for NavigationView menu items.

Represents a header for a group of menu items in a NavigationMenu.

Initializes a new instance of the NavigationViewItemHeader class.

Provides event data for the NavigationView.ItemInvoked event.

Initializes a new instance of the NavigationViewItemInvokedEventArgs class.

Gets a reference to the invoked item.

The invoked item.

Gets the container for the invoked item.

The container for the invoked item.

Gets a value that indicates whether the **InvokedItem** is the menu item for Settings.

**true** if the **InvokedItem** is the menu item for Settings; otherwise, **false**.

Gets the navigation transition recommended for the direction of the navigation.

The navigation transition recommended for the direction of the navigation.

Represents a line that separates menu items in a NavigationMenu.

Initializes a new instance of the NavigationViewItemSeparator class.

Represents a control that displays menu items in a NavigationView control.

Initializes a new instance of the NavigationViewList class.

Defines constants that specify the label for the overflow button in a NavigationView.

The text label "More" is shown next to the chevron.

No text label is shown, only a chevron.

Provides data for the NavigationView.PaneClosing event.

Gets or sets a value that indicates whether the event should be canceled.

**true** to cancel the event; otherwise, **false**. The default is **false**.

Defines constants that specify how and where the NavigationView pane is shown.

The pane is shown on the left side of the control, and changes between minimal, compact, and full states depending on the width of the window.

The pane is shown on the left side of the control in its fully open state.

The pane is shown on the left side of the control. Only the pane icons are shown by default.

The pane is shown on the left side of the control. Only the pane menu button is shown by default.

The pane is shown at the top of the control.

Provides data for the NavigationView.SelectionChanged event.

Gets a value that indicates whether the **SelectedItem** is the menu item for Settings.

**true** if the **SelectedItem** is the menu item for Settings; otherwise, **false**.

Gets the navigation transition recommended for the direction of the navigation.

The navigation transition recommended for the direction of the navigation.

Gets the newly selected menu item.

The newly selected menu item.

Gets the container for the selected item.

The container for the selected item.

Defines constants that specify whether item selection changes when keyboard focus changes in a NavigationView.

Selection does not change when keyboard focus changes.

Selection changes when keyboard focus changes.

Defines constants that specify when gamepad bumpers can be used to navigate the top-level navigation items in a NavigationView.

Gamepad bumpers always navigate the top-level navigation items.

Gamepad bumpers never navigate the top-level navigation items.

Gamepad bumpers navigate the top-level navigation items when the SelectionFollowsFocus property is **Enabled**.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a NavigationView. Not intended for general use.

Initializes a new instance of the NavigationViewTemplateSettings class.

Gets the visibility of the back button.

The visibility of the back button.

Identifies the BackButtonVisibility dependency property.

The identifier for the BackButtonVisibility dependency property.

Gets the visibility of the left pane.

The visibility of the left pane.

Identifies the LeftPaneVisibility dependency property.

The identifier for the LeftPaneVisibility dependency property.

Gets the visibility of the overflow button.

The visibility of the overflow button.

Identifies the OverflowButtonVisibility dependency property.

The identifier for the OverflowButtonVisibility dependency property.

Gets the visibility of the pane toggle button.

The visibility of the pane toggle button.

Identifies the PaneToggleButtonVisibility dependency property.

The identifier for the PaneToggleButtonVisibility dependency property.

Gets the SelectionFollowsFocus value.

The SelectionFollowsFocus value.

Identifies the SingleSelectionFollowsFocus dependency property.

The identifier for the SingleSelectionFollowsFocus dependency property.

Gets the padding value of the top pane.

The padding value of the top pane.

Identifies the TopPadding dependency property.

The identifier for the TopPadding dependency property.

Gets the visibility of the top pane.

The visibility of the top pane.

Identifies the TopPaneVisibility dependency property.

The identifier for the TopPaneVisibility dependency property.

Provides data for the ScriptNotify event.

Gets the Uniform Resource Identifier (URI) of the page containing the script that raised the ScriptNotify event.

The Uniform Resource Identifier (URI) of the page that raised the event.

Gets the method name as passed to the application.

The JavaScript method name.

Represents the method that will handle the ScriptNotify event.

The object where the handler is attached. Event data for the event.

Defines constants that specify the different orientations that a control or layout can have.

The control or layout should be horizontally oriented.

The control or layout should be vertically oriented.

Represents content that a Frame control can navigate to.

Initializes a new instance of the Page class.

Gets a reference to an AppBar displayed at the bottom of the page, if any.

A reference to an AppBar displayed at the bottom of the page, or **null**.

Identifies the BottomAppBar dependency property.

The identifier for the BottomAppBar dependency property.

Gets the controlling Frame for the Page content.

The controlling Frame for the Page content.

Identifies the Frame dependency property.

The identifier for the Frame dependency property.

Gets or sets the navigation mode that indicates whether this Page is cached, and the period of time that the cache entry should persist.

A value of the enumeration. The default is **Disabled**.

Gets a reference to an AppBar displayed at the top of the page, if any.

A reference to an AppBar displayed at the top of the page, or **null**.

Identifies the TopAppBar dependency property.

The identifier for the TopAppBar dependency property.

Invoked immediately after the Page is unloaded and is no longer the current source of a parent Frame.

Event data that can be examined by overriding code. The event data is representative of the navigation that has unloaded the current Page.

Invoked when the Page is loaded and becomes the current source of a parent Frame.

Event data that can be examined by overriding code. The event data is representative of the pending navigation that will load the current Page. Usually the most relevant property to examine is Parameter.

Invoked immediately before the Page is unloaded and is no longer the current source of a parent Frame.

Event data that can be examined by overriding code. The event data is representative of the navigation that will unload the current Page unless canceled. The navigation can potentially be canceled by setting Cancel.

Provides a base class for all Panel elements. Use Panel elements to position and arrange child objects in a UI page.

Provides base class initialization behavior for Panel derived classes.

Gets or sets a Brush that fills the panel content area.

The brush that fills the panel content area. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the Background  dependency property.

The identifier for the Background  dependency property.

Gets or sets an instance of BrushTransition to automatically animate changes to the Background property.

An instance of BrushTransition to automatically animate changes to the Background; otherwise, **null**. The default is **null**.

Gets the collection of child elements of the panel.

The collection of child objects. The default is an empty collection.

Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass.

The strongly typed collection of Transition style elements.

Identifies the ChildrenTransitions dependency property.

The identifier for the ChildrenTransitions dependency property.

Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl.

**true** if this instance of Panel is an items host; otherwise, **false**. The default is **false**.

Identifies the IsItemsHost dependency property.

The identifier for the IsItemsHost dependency property.

Defines constants that specify the direction that a panel is scrolling.

The panel is scrolling backward.

The panel is scrolling forward.

The panel is not scrolling.

Defines constants that specify how the source offset values of a ParallaxView are interpreted.

The source start/end offset value is interpreted as an absolute value.

The source start/end offset value is added to the auto-computed source offset.

Represents a container that ties the scroll position of a foreground element, such as a list, to a background element, such as an image. As you scroll through the foreground element, it animates the background element to create a parallax effect.

Initializes a new instance of the ParallaxView class.

Gets or sets the background content of the ParallaxView.

The background content of the ParallaxView, typically an image. The default is **null**.

Identifies the Child dependency property.

The identifier for the Child dependency property.

Represents the horizontal range of motion of the child element.

The horizontal range of motion. The default is 0.

Identifies the HorizontalShift dependency property.

The identifier for the HorizontalShift dependency property.

Represents the horizontal scroll offset at which the parallax motion ends.

The horizontal scroll offset at which parallax motion ends. The default is 0.

Identifies the HorizontalSourceEndOffset dependency property.

The identifier for the HorizontalSourceEndOffset dependency property.

Gets or sets a value that determines how the horizontal source offset values of a ParallaxView are interpreted.

A value of the enumeration that determines how the horizontal source offset values of a ParallaxView are interpreted.

Identifies the HorizontalSourceOffsetKind dependency property.

The identifier for the HorizontalSourceOffsetKind dependency property.

Represents the horizontal scroll offset at which parallax motion starts.

The horizontal scroll offset at which parallax motion starts. The default is 0.

Identifies the HorizontalSourceStartOffset dependency property.

The identifier for the HorizontalSourceStartOffset dependency property.

Gets or sets a value that indicates whether the horizontal parallax ratio is clampled to a specified percentage of the source scroll velocity.

**true** if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, **false**. The default is **true**.

Identifies the IsHorizontalShiftClamped dependency property.

The identifier for the IsHorizontalShiftClamped dependency property.

Gets or sets a value that indicates whether the vertical parallax ratio is clampled to a specified percentage of the source scroll velocity.

**true** if the parallax ratio is clampled to a specified percentage of the source scroll velocity; otherwise, **false**. The default is **true**.

Identifies the IsVerticalShiftClamped dependency property.

The identifier for the IsVerticalShiftClamped dependency property.

Clamps the horizontal parallax ratio to the specified percentage of the source scroll velocity.

The maximum percentage of the source scroll velocity. The default is 1.0.

Identifies the MaxHorizontalShiftRatio dependency property.

The identifier for the MaxHorizontalShiftRatio dependency property.

Clamps the vertical parallax ratio to the specified percentage of the source scroll velocity.

The maximum percentage of the source scroll velocity. The default is 1.0.

Identifies the MaxVerticalShiftRatio dependency property.

The identifier for the MaxVerticalShiftRatio dependency property.

The element that either is or contains the ScrollViewer that controls the parallax operation.

Identifies the Source dependency property.

The identifier for the Source dependency property.

Represents the vertical range of motion of the child element.

The vertical range of motion. The default is 0.

Identifies the VerticalShift dependency property.

The identifier for the VerticalShift dependency property.

Represents the vertical scroll offset at which the parallax motion ends.

The vertical scroll offset at which parallax motion ends. The default is 0.

Identifies the VerticalSourceEndOffset dependency property.

The identifier for the VerticalSourceEndOffset dependency property.

Gets or sets a value that determines how the vertical source offset values of a ParallaxView are interpreted.

A value of the enumeration that determines how the vertical source offset values of a ParallaxView are interpreted.

Identifies the VerticalSourceOffsetKind dependency property.

The identifier for the VerticalSourceOffsetKind dependency property.

Represents the vertical scroll offset at which parallax motion starts.

The vertical scroll offset at which parallax motion starts. The default is 0.

Identifies the VerticalSourceStartOffset dependency property.

The identifier for the VerticalSourceStartOffset dependency property.

Forces the automatically computed horizontal offsets to be recomputed.

Forces the automatically computed vertical offsets to be recomputed.

Represents a control for entering passwords.

Initializes a new instance of the PasswordBox class

Gets a value that indicates whether clipboard content can be pasted into the control.

**true** if clipboard content can be pasted into the control; otherwise, **false**.

Identifies the CanPasteClipboardContent dependency property.

The identifier for the CanPasteClipboardContent dependency property.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets the context for input used by this PasswordBox.

The input scope, which provides a hint at the type of text input expected by the control. The default is **null**.

Identifies the InputScope dependency property.

The identifier for the InputScope dependency property.

Gets or sets a value that specifies whether the visual UI of the PasswordBox includes a button element that toggles showing or hiding the typed characters. In Windows 10 and later, use PasswordRevealMode instead.

**True** to show a password reveal button; **false** to not show a password reveal button. The default is **false**.

Identifies the IsPasswordRevealButtonEnabled dependency property.

The identifier for the IsPasswordRevealButtonEnabled dependency property.

Gets or sets the maximum length for passwords to be handled by this PasswordBox.

An integer that specifies the maximum number of characters for passwords to be handled by this PasswordBox. A value of zero (0) means no limit. The default is 0 (no length limit).

Identifies the MaxLength dependency property.

The identifier for the MaxLength dependency property.

Gets or sets the password currently held by the PasswordBox.

A string that represents the password currently held by the PasswordBox. The default is an empty string.

Gets or sets the masking character for the PasswordBox.

A masking character to echo when the user enters text into the PasswordBox. The default value is a bullet character (●).

Identifies the PasswordChar dependency property.

The identifier for the PasswordChar dependency property.

Identifies the Password dependency property.

The identifier for the Password dependency property.

Gets or sets a value that specifies whether the password is always, never, or optionally obscured.

A value of the enumeration that specifies whether the password is always, never, or optionally obscured. The default is **Peek**.

Identifies the PasswordRevealMode dependency property.

The identifier for the PasswordRevealMode dependency property.

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is entered. The default is an empty string ("").

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets or sets a value that indicates whether the on-screen keyboard is shown when the control receives focus programmatically.

**true** if the on-screen keyboard is not shown when the control receives focus programmatically; otherwise, **false**. The default is **false**.

Identifies the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

The identifier for the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

Gets or sets the flyout that is shown when text is selected, or **null** if no flyout is shown.

The flyout that is shown when text is selected, or **null** if no flyout is shown. The default is an instance of TextCommandBarFlyout.

Identifies the SelectionFlyout dependency property.

The identifier for the SelectionFlyout dependency property.

Gets or sets the brush used to highlight the selected text.

The brush used to highlight the selected text. The default is a null brush from a pure code perspective, but the default control template for PasswordBox applies a theme resource brush for this in a runtime instance of a PasswordBox control.

Identifies the SelectionHighlightColor dependency property.

The identifier for the SelectionHighlightColor dependency property.

Gets or sets a value that indicates how the reading order is determined for the PasswordBox.

A value that indicates how the reading order is determined for the PasswordBox. The default is **DetectFromContent**.

Identifies the TextReadingOrder dependency property.

The identifier for the TextReadingOrder dependency property.

Occurs when the system processes an interaction that displays a context menu.

Occurs when the value of the Password property changes.

Occurs synchronously when the text in the password box starts to change, but before it is rendered.

Occurs when text is pasted into the control.

Copies content from the Windows clipboard into the text control.

Selects all the characters in the PasswordBox.

Provides event data for the PasswordBox.PasswordChanging event.

Gets a value that indicates whether the event occured due to a change in the text content.

**true** if a change to the text content caused the event; otherwise, **false**.

Defines constants that specify the password reveal behavior of a PasswordBox.

The password reveal button is not visible. The password is always obscured.

The password reveal button is visible. The password is not obscured while the button is pressed.

The password reveal button is not visible. The password is not obscured.

Represents an icon that uses a vector path as its content.

Initializes a new instance of the PathIcon class.

Gets or sets a Geometry that specifies the shape to be drawn. In XAML. this can also be set using a string that describes Move and draw commands syntax.

A description of the shape to be drawn.

Identifies the Data dependency property.

The identifier for the Data dependency property.

Represents an icon source that uses a vector path as its content.

Initializes a new instance of the PathIconSource class.

Gets or sets a Geometry that specifies the shape to be drawn. In XAML. this can also be set using a string that describes Move and draw commands syntax.

A description of the shape to be drawn.

Identifies the Data dependency property.

The identifier for the Data dependency property.

Represents a control that displays the avatar image for a person, if one is available; if not, it displays the person's initials or a generic glyph.

Initializes a new instance of the PersonPicture class.

Gets or sets a Segoe MDL2 Assets font glyph to display on the badge.

The hexadecimal character code for the badge glyph.

Identifies the BadgeGlyph dependency property.

The identifier for the BadgeGlyph dependency property.

Gets or sets the source of an image to display on the badge.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the BadgeImageSource dependency property.

The identifier for the BadgeImageSource dependency property.

Gets or sets the contact number to display on the badge.

The contact number to display on the badge.

Identifies the BadgeNumber dependency property.

The identifier for the BadgeNumber dependency property.

Gets or sets the contact text to display on the badge.

The contact text to display on the badge.

Identifies the BadgeText dependency property.

The identifier for the BadgeText dependency property.

Gets or sets a Contact object that contains information about the person.

A Contact object that contains information about the person.

Identifies the Contact dependency property.

The identifier for the Contact dependency property.

Gets or sets the contact's display name.

The contact's display name.

Identifies the DisplayName dependency property.

The identifier for the DisplayName dependency property.

Gets or sets the contact's initials.

The contact's initials.

Identifies the Initials dependency property.

The identifier for the Initials dependency property.

Gets or sets a value that indicates whether the PersonPicture represents a group or an individual.

**true** if the PersonPicture represents a group; otherwise, **false**.

Identifies the IsGroup dependency property.

The identifier for the IsGroup dependency property.

Gets or sets a value that indicates whether a small image is displayed rather than a large image when both are available.

**true** to display a small image even when a large image is available; otherwise, **false**. The default is **false**.

Identifies the PreferSmallImage dependency property.

The identifier for the PreferSmallImage dependency property.

Gets or sets the source of the contact's profile picture.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the ProfilePicture dependency property.

The identifier for the ProfilePicture dependency property.

Provides data for the PickerConfirmed event.

Initializes a new instance of the PickerConfirmedEventArgs class.

Represents a custom picker control. (Not recommended for Universal Windows Platform (UWP) app. See Flyout.)

Initializes a new instance of the PickerFlyout class.

Gets or sets whether the confirmation buttons are visible.

True of the confirmation buttons are visible; Otherwise, false.

Identifies the ConfirmationButtonsVisible dependency property.

The identifier of the ConfirmationButtonsVisible dependency property.

Gets or sets the content that is contained within the picker.

The content of the user control.

Gets the identifier for the Content dependency property.

The identifier for the Content dependency property.

Occurs when the user has tapped a confirmation button to confirm the selection.

Begins an asynchronous operation to show the flyout placed in relation to the specified element.

The element to use as the flyout's placement target. An asynchronous operation.

Represents a custom picker. (Not recommended for Universal Windows Platform (UWP) app. See Flyout.)

Represents a control that provides quick navigation of views within an app.

Initializes a new instance of the Pivot type.

Gets or sets a value that specifies the style of focus visual used for pivot header items.

A value of the enumeration that specifies the style of focus visual used for pivot header items. The default is **SelectedItemHeader**.

Identifies the HeaderFocusVisualPlacement dependency property.

The identifier for the HeaderFocusVisualPlacement dependency property.

Gets or sets the template for the Header property of PivotItem children.

The template for the Header property of PivotItem children.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates whether the selected header moves to the first position.

**true** if the selected header moves to the first position; **false** if headers always keep the same position. The default is **true**.

Identifies the IsHeaderItemsCarouselEnabled dependency property.

The identifier for the IsHeaderItemsCarouselEnabled dependency property.

Gets or sets whether the Pivot is locked to show only the current PivotItem. While the Pivot is locked, all other PivotItems are removed, and the user cannot navigate to them. An example of locking is when the email list is put into a multi-select mode.

**true** if the Pivot is locked; **false** if it is unlocked. The default is **false**.

Identifies the IsLocked dependency property.

The identifier for the IsLocked dependency property.

Gets or sets the content for the header on the control's left side.

The content of the header on the control's left side. The default is **null**.

Identifies the LeftHeader dependency property.

The identifier for the LeftHeader dependency property.

Gets or sets the template for the header on the control's left side.

The template for the header on the control's left side.

Identifies the LeftHeaderTemplate dependency property.

The identifier for the LeftHeaderTemplate dependency property.

Gets or sets the content for the header on the control's right side.

The content of the header on the control's right side. The default is **null**.

Identifies the RightHeader dependency property.

The identifier for the RightHeader dependency property.

Gets or sets the template for the header on the control's right side.

The template for the header on the control's right side.

Identifies the RightHeaderTemplate dependency property.

The identifier for the RightHeaderTemplate dependency property.

Gets or sets the zero-based index of the currently selected item in the Pivot.

The zero-based index of the currently selected item.

Identifies the SelectedIndex dependency property.

The identifier for the SelectedIndex dependency property.

Gets or sets the currently selected item in the Pivot.

The currently selected PivotItem or, if the Pivot is bound to data, the data item set as the Content of the currently selected PivotItem.

Identifies the SelectedItem dependency property.

The identifier for the SelectedItem dependency property.

Identifies the SlideInAnimationGroup XAML attached property.

The identifier for the SlideInAnimationGroup XAML attached property.

Gets or sets the title to be optionally set above the headers.

Returns String.

Identifies the Title dependency property.

The identifier for the Title dependency property.

Gets or sets the title template used for displaying the title above the headers area.

The template that specifies the visualization of the title object.

Identifies the TitleTemplate dependency property.

The identifier for the TitleTemplate dependency property.

Event for indicating that an item has fully loaded.

Event for offering an opportunity to dynamically load or change the content of a pivot item before it is displayed.

Event for notifying that the pivot item has been completely unloaded from the visual pivot.

Event for offering an opportunity to dynamically load, change, or remove the content of a pivot item as it is removed.

Occurs when the currently selected item changes.

Retrieves the animation group that a FrameworkElement belongs to.

The FrameworkElement within the Pivot (such as a TextBlock ) that is to be animated. The slide-in animation group that this FrameworkElement belongs to.

Assigns a FrameworkElement to a slide-in animation group so that element is animated at the same time as the other members of that group.

The FrameworkElement within the Pivot (such as a TextBlock ) that is to be animated. The slide-in animation group that this FrameworkElement belongs to. This element will be animated with all other elements that share the same group number.

Defines constants that specify the style of focus visual used for pivot header items.

A single focus visual (rectangle) is drawn around all visible item headers.

The focus visual (underline) is drawn under the selected item header.

Represents the container for an item in a Pivot control.

Initializes a new instance of the PivotItem type.

Gets or sets the header for the PivotItem.

Returns Object.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Event arguments for dynamically interacting with the PivotItem before use, allowing for delay load scenarios.

Initializes a new instance of the PivotItemEventArgs type

Gets the pivot item instance.

Returns PivotItem.

Defines constants that specify the different slide-in animation groups that Pivot elements can belong to.

The element belongs to the default animation group. It slides in after the Pivot header.

The element belongs to the first animation group. It slides in after elements in the default group.

The element belongs to the third animation group. It slides in after elements in the second group.

The element belongs to the second animation group. It slides in after elements in the first group.

Represents a control that indicates the progress of an operation, where the typical visual appearance is a bar that animates a filled area as progress continues.

Initializes a new instance of the ProgressBar class.

Gets or sets a value that indicates whether the progress bar reports generic progress with a repeating pattern or reports progress based on the Value property.

**True** if the progress bar reports generic progress with a repeating pattern; **false** if the progress bar reports progress based on the Value property. The default is **false**.

Identifies the IsIndeterminate dependency property.

The identifier for the IsIndeterminate dependency property.

Gets or sets a value that indicates whether the progress bar should use visual states that communicate an **Error** state to the user.

**True** if the progress bar should use visual states that communicate an **Error** state to the user; otherwise, **false**. The default is **false**.

Identifies the ShowError dependency property.

The identifier for the ShowError dependency property.

Gets or sets a value that indicates whether the progress bar should use visual states that communicate a **Paused** state to the user.

**True** if the progress bar should use visual states that communicate a **Paused** state to the user; otherwise, **false**. The default is **false**.

Identifies the ShowPaused dependency property.

The identifier for the ShowPaused dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a ProgressBar control.

An object that provides calculated values for templates.

Represents a control that indicates that an operation is ongoing. The typical visual appearance is a ring-shaped "spinner" that cycles an animation as progress continues.

Initializes a new instance of the ProgressRing class.

Gets or sets a value that indicates whether the ProgressRing is showing progress.

**True** if the ProgressRing is showing progress; otherwise, **false**. The default is **false**.

Identifies the IsActive dependency property.

The identifier for the IsActive dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a ProgressRing control.

An object that provides calculated values for templates.

Represents a button that allows a user to select a single option from a group of options.

Initializes a new instance of the RadioButton class.

Gets or sets the name that specifies which RadioButton controls are mutually exclusive.

The name that specifies which RadioButton controls are mutually exclusive. The default is null.

Identifies the GroupName dependency property.

The identifier for GroupName dependency property.

Represents a control that lets a user enter a star rating.

Initializes a new instance of the RatingControl class.

Gets or sets the text label for the control.

The text label for the control. The default is an empty string.

Identifies the Caption dependency property.

The identifier for Caption dependency property.

Gets or sets the initial set rating value.

The initial set rating value. The default is 1.

Identifies the InitialSetValue dependency property.

The identifier for InitialSetValue dependency property.

Gets or sets the value that determines if the user can remove the rating.

**true** if the user can remove the rating; otherwise, **false**. The default is **true**.

Identifies the IsClearEnabled dependency property.

The identifier for IsClearEnabled dependency property.

Gets or sets the value that determines if the user can change the rating.

**true** if the rating is read-only; otherwise, **false**. The default is **false**.

Identifies the IsReadOnly dependency property.

The identifier for IsReadOnly dependency property.

Gets or sets info about the visual states of the items that represent a rating.

A RatingItemInfo-derived object that contains details about the visual states of the items that represent a rating.

Identifies the ItemInfo dependency property.

The identifier for ItemInfo dependency property.

Gets or sets the maximum allowed rating value.

The maximum allowed rating value. The default is 5.

Identifies the MaxRating dependency property.

The identifier for MaxRating dependency property.

Gets or sets the rating that is displayed in the control until the value is changed by a user action or some other operation.

The rating that is displayed in the control when no value is entered. The default is **null**.

Identifies the PlaceholderValue dependency property.

The identifier for PlaceholderValue dependency property.

Gets or sets the rating value.

The rating value. The default is **null**.

Identifies the Value dependency property.

The identifier for Value dependency property.

Occurs when the Value property has changed.

Represents information about the visual states of font elements that represent a rating.

Initializes a new instance of the RatingItemFontInfo class.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that is disabled.

The hexadecimal character code for the rating element glyph.

Identifies the DisabledGlyph dependency property.

The identifier for DisabledGlyph dependency property.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has been set by the user.

The hexadecimal character code for the rating element glyph.

Identifies the Glyph dependency property.

The identifier for Glyph dependency property.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that is showing a placeholder value.

The hexadecimal character code for the rating element glyph.

Identifies the PlaceholderGlyph dependency property.

The identifier for PlaceholderGlyph dependency property.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has the pointer over it.

The hexadecimal character code for the rating element glyph.

Identifies the PointerOverGlyph dependency property.

The identifier for PointerOverGlyph dependency property.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element showing a placeholder value with the pointer over it.

The hexadecimal character code for the rating element glyph.

Identifies the PointerOverPlaceholderGlyph dependency property.

The identifier for PointerOverPlaceholderGlyph dependency property.

Gets or sets a Segoe MDL2 Assets font glyph that represents a rating element that has not been set.

The hexadecimal character code for the rating element glyph.

Identifies the UnsetGlyph dependency property.

The identifier for UnsetGlyph dependency property.

Represents information about the visual states of image elements that represent a rating.

Initializes a new instance of the RatingItemImageInfo class.

Gets or sets an image that represents a rating element that is disabled.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the DisabledImage dependency property.

The identifier for DisabledImage dependency property.

Gets or sets an image that represents a rating element that has been set by the user.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the Image dependency property.

The identifier for Image dependency property.

Gets or sets an image that represents a rating element that is showing a placeholder value.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the PlaceholderImage dependency property.

The identifier for PlaceholderImage dependency property.

Gets or sets an image that represents a rating element that has the pointer over it.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the PointerOverImage dependency property.

The identifier for PointerOverImage dependency property.

Gets or sets an image that represents a rating element showing a placeholder value with the pointer over it.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the PointerOverPlaceholderImage dependency property.

The identifier for PointerOverPlaceholderImage dependency property.

Gets or sets an image that represents a rating element that has not been set.

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

Identifies the UnsetImage dependency property.

The identifier for UnsetImage dependency property.

Represents information about the visual states of the elements that represent a rating.

Initializes a new instance of the RatingItemInfo class.

Represents a container control that provides a RefreshVisualizer and pull-to-refresh functionality for scrollable content.

Initializes a new instance of the RefreshContainer control.

Gets or sets a value that specifies the direction to pull to initiate a refresh.

An enumeration value that specifies the direction to pull to initiate a refresh.

Identifies the PullDirection dependency property.

The identifier for the PullDirection dependency property.

Gets or sets the RefreshVisualizer for this container.

The RefreshVisualizer for this container.

Identifies the Visualizer dependency property.

The identifier for the Visualizer dependency property.

Occurs when an update of the content has been initiated.

Initiates an update of the content.

Provides event data.

Gets the interaction ratio value.

The interaction ratio value.

Defines constants that specify the direction to pull a RefreshContainer to initiate a refresh.

Pull from bottom to top to initiate a refresh.

Pull from left to right to initiate a refresh.

Pull from right to left to initiate a refresh.

Pull from top to bottom to initiate a refresh.

Provides event data for RefreshRequested events.

Gets a deferral object for managing the work done in the RefreshRequested event handler.

A deferral object.

Provides event data for the RefreshVisualizer.RefreshStateChanged event.

Gets a value that indicates the new state of the RefreshVisualizer.

An enumeration value that indicates the new state of the RefreshVisualizer.

Gets a value that indicates the previous state of the RefreshVisualizer.

An enumeration value that indicates the previous state of the RefreshVisualizer.

Represents a control that provides animated state indicators for content refresh.

Initializes a new instance of the RefreshVisualizer class.

Gets or sets the content of the visualizer.

The content of the visualizer.

Identifies the Content dependency property.

The identifier for the Content dependency property.

Identifies the InfoProvider dependency property.

The identifier for the InfoProvider dependency property.

Gets or sets a value that indicates the orientation of the visualizer.

A value of the enumeration that indicates the orientation of the visualizer. The default is **Top**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets a value that indicates the state of the visualizer.

A value of the enumeration that indicates the state of the visualizer.

Identifies the State dependency property.

The identifier for the State dependency property.

Occurs when an update of the content has been initiated.

Occurs when the state of the visualizer changes.

Initiates an update of the content.

Defines constants that specify the orientation of a RefreshVisualizer.

Defines constants that specify the state of a RefreshVisualizer

The visualizer is idle.

The user is interacting with the visualizer.

The visualizer was pulled in the refresh direction from a position where a refresh is not allowed. Typically, the ScrollViewer was not at position 0 at the start of the pull.

The visualizer is pending.

The visualizer is being refreshed.

Defines an area within which you can position and align child objects in relation to each other or the parent panel.

Initializes a new instance of the RelativePanel class.

Identifies the RelativePanel.Above XAML attached property.

The identifier for the RelativePanel.Above XAML attached property.

Identifies the RelativePanel.AlignBottomWithPanel XAML attached property.

The identifier for the RelativePanel.AlignBottomWithPanel XAML attached property.

Identifies the RelativePanel.AlignBottomWith XAML attached property.

The identifier for the RelativePanel.AlignBottomWith XAML attached property.

Identifies the RelativePanel.AlignHorizontalCenterWithPanel XAML attached property.

The identifier for the RelativePanel.AlignHorizontalCenterWithPanel XAML attached property.

Gets the value of the RelativePanel.AlignHorizontalCenterWith XAML attached property for the target element.

The identifier for the RelativePanel.AlignHorizontalCenterWith XAML attached property.

Identifies the RelativePanel.AlignLeftWithPanel XAML attached property.

The identifier for the RelativePanel.AlignLeftWithPanel XAML attached property.

Identifies the RelativePanel.AlignLeftWith XAML attached property.

The identifier for the RelativePanel.AlignLeftWith XAML attached property.

Identifies the RelativePanel.AlignRightWithPanel XAML attached property.

The identifier for the RelativePanel.AlignRightWithPanel XAML attached property.

Identifies the RelativePanel.AlignRightWith XAML attached property.

The identifier for the RelativePanel.AlignRightWith XAML attached property.

Identifies the RelativePanel.AlignTopWithPanel XAML attached property.

The identifier for the RelativePanel.AlignTopWithPanel XAML attached property.

Identifies the RelativePanel.AlignTopWith XAML attached property.

The identifier for the RelativePanel.AlignTopWith XAML attached property.

Identifies the RelativePanel.AlignVerticalCenterWithPanel XAML attached property.

The identifier for the RelativePanel.AlignVerticalCenterWithPanel XAML attached property.

Gets the value of the RelativePanel.AlignVerticalCenterWith XAML attached property for the target element.

The identifier for the RelativePanel.AlignVerticalCenterWith XAML attached property.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Identifies the RelativePanel.Below XAML attached property.

The identifier for the RelativePanel.Below XAML attached property.

Gets or sets a brush that describes the border fill of the panel.

The brush that is used to fill the panel's border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the border thickness of the panel.

The border thickness of the panel, as a Thickness value.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets or sets the radius for the corners of the panel's border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Identifies the RelativePanel.LeftOf XAML attached property.

The identifier for the RelativePanel.LeftOf XAML attached property.

Gets or sets the distance between the border and its child object.

The dimensions of the space between the border and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Identifies the RelativePanel.RightOf XAML attached property.

The identifier for the RelativePanel.RightOf XAML attached property.

Gets the value of the RelativePanel.Above XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.Above XAML attached property value of the specified object. (The element to position this element above.)

Gets the value of the RelativePanel.AlignBottomWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignBottomWith XAML attached property value of the specified object. (The element to align this element's bottom edge with.)

Gets the value of the RelativePanel.AlignBottomWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignBottomWithPanel XAML attached property value of the specified object. (**true** to align this element's bottom edge with the panel's bottom edge; otherwise, **false**.)

Gets the value of the RelativePanel.AlignHorizontalCenterWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignHorizontalCenterWith XAML attached property value of the specified object. (The element to align this element's horizontal center with.)

Gets the value of the RelativePanel.AlignHorizontalCenterWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignHorizontalCenterWithPanel XAML attached property value of the specified object. (**true** to horizontally center this element in the panel; otherwise, **false**.)

Gets the value of the RelativePanel.AlignLeftWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignLeftWith XAML attached property value of the specified object. (The element to align this element's left edge with.)

Gets the value of the RelativePanel.AlignLeftWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignLeftWithPanel XAML attached property value of the specified object. (**true** to align this element's left edge with the panel's left edge; otherwise, **false**.)

Gets the value of the RelativePanel.AlignRightWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignRightWith XAML attached property value of the specified object. (The element to align this element's right edge with.)

Gets the value of the RelativePanel.AlignRightWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignRightWithPanel XAML attached property value of the specified object. (**true** to align this element's right edge with the panel's right edge; otherwise, **false**.)

Gets the value of the RelativePanel.AlignTopWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignTopWith XAML attached property value of the specified object. (The element to align this element's top edge with.)

Gets the value of the RelativePanel.AlignTopWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignTopWithPanel XAML attached property value of the specified object. (**true** to align this element's top edge with the panel's top edge; otherwise, **false**.)

Gets the value of the RelativePanel.AlignVerticalCenterWith XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignVerticalCenterWith XAML attached property value of the specified object. (The element to align this element's vertical center with.)

Gets the value of the RelativePanel.AlignVerticalCenterWithPanel XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.AlignVerticalCenterWithPanel XAML attached property value of the specified object. (**true** to vertically center this element in the panel; otherwise, **false**.)

Gets the value of the RelativePanel.Below XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.Below XAML attached property value of the specified object. (The element to position this element below.)

Gets the value of the RelativePanel.LeftOf XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.LeftOf XAML attached property value of the specified object. (The element to position this element to the left of.)

Gets the value of the RelativePanel.RightOf XAML attached property for the target element.

The object from which the property value is read. The RelativePanel.RightOf XAML attached property value of the specified object. (The element to position this element to the right of.)

Sets the value of the RelativePanel.Above XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to position this element above.)

Sets the value of the RelativePanel.AlignBottomWith XAML attached property for the target element.

The object to which the property value is written. The value to set. (The element to align this element's bottom edge with.)

Sets the value of the RelativePanel.AlignBottomWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to align this element's bottom edge with the panel's bottom edge; otherwise, **false**.)

Sets the value of the RelativePanel.AlignHorizontalCenterWith XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to align this element's horizontal center with.)

Sets the value of the RelativePanel.AlignHorizontalCenterWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to horizontally center this element in the panel; otherwise, **false**.)

Sets the value of the RelativePanel.AlignLeftWith XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to align this element's left edge with.)

Sets the value of the RelativePanel.AlignLeftWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to align this element's left edge with the panel's left edge; otherwise, **false**.)

Sets the value of the RelativePanel.AlignRightWith XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to align this element's right edge with.)

Sets the value of the RelativePanel.AlignRightWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to align this element's right edge with the panel's right edge; otherwise, **false**.)

Sets the value of the RelativePanel.AlignTopWith XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to align this element's top edge with.)

Sets the value of the RelativePanel.AlignTopWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to align this element's top edge with the panel's top edge; otherwise, **false**.)

Sets the value of the RelativePanel.AlignVerticalCenterWith XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to align this element's horizontal center with.)

Sets the value of the RelativePanel.AlignVerticalCenterWithPanel XAML attached property for a target element.

The object to which the property value is written. The value to set. (**true** to vertically center this element in the panel; otherwise, **false**.)

Sets the value of the RelativePanel.Below XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to position this element below.)

Sets the value of the RelativePanel.LeftOf XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to position this element to the left of.)

Sets the value of the RelativePanel.RightOf XAML attached property for a target element.

The object to which the property value is written. The value to set. (The element to position this element to the right of.)

Defines constants that specify when an element requires a mouse-like pointer behavior from a game pad.

The pointer never acts as a mouse.

The pointer acts as a mouse when the user engages mouse-mode.

The pointer acts as a mouse when the page gets focus. Supported on Page elements only.

Represents a rich text editing control that supports formatted text, hyperlinks, and other rich content.

Initializes a new instance of the RichEditBox class.

Gets or sets a value that indicates whether the RichEditBox allows and displays the newline or return characters when the ENTER or RETURN keys are pressed.

**True** if the RichEditBox allows newline characters; otherwise, **false**. The default is **true**.

Identifies the AcceptsReturn dependency property.

The identifier for the AcceptsReturn dependency property.

Gets or sets a value that indicates how the control modifies the case of characters as they are typed.

A value of the enumeration that indicates how the control modifies the case of characters as they are typed. The default is **Normal**, which indicates that the charcters are not changed.

Identifies the CharacterCasing dependency property.

The identifier for the CharacterCasing dependency property.

Gets or sets a value that specifies whether text is copied with all formats, or as plain text only.

An enumeration value that specifies whether text is copied with all formats, or as plain text only. The default is **AllFormats**.

Identifies the ClipboardCopyFormat dependency property.

The identifier for the ClipboardCopyFormat dependency property.

Get or sets the brush used to color the link background.

The brush used to color the link background.

Identifies the ContentLinkBackgroundColor dependency property.

The identifier for the ContentLinkBackgroundColor dependency property.

Get or sets the brush used to color the link text.

The brush used to color the link text.

Identifies the ContentLinkForegroundColor dependency property.

The identifier for the ContentLinkForegroundColor dependency property.

Get or sets the collection of ContentLinkProvider s that define the types of ContentLink s used in this RichEditBox.

The collection of ContentLinkProvider s that define the types of ContentLink s used in this RichEditBox.

Identifies the ContentLinkProviders dependency property.

The identifier for the ContentLinkProviders dependency property.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets a value that indicates the preferred alignment of the Input Method Editor (IME).

A value of the enumeration that indicates the preferred alignment of the Input Method Editor (IME). The default is **Default**.

Identifies the DesiredCandidateWindowAlignment dependency property.

The identifier for the DesiredCandidateWindowAlignment dependency property.

Gets or sets a value that indicates which keyboard shortcuts for formatting are disabled.

A value that indicates which keyboard shortcuts for formatting are disabled. The default is **None**.

Identifies the DisabledFormattingAccelerators dependency property.

The identifier for the DisabledFormattingAccelerators dependency property.

Gets an object that enables access to the text object model for the text contained in a RichEditBox.

An object that enables access to the text object model.

Gets or sets the HandwritingView associated with this text control.

The HandwritingView associated with this text control.

Identifies the HandwritingView dependency property.

The identifier for the HandwritingView dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates how text is aligned in the RichEditBox.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the HorizontalTextAlignment dependency property.

The identifier for the HorizontalTextAlignment dependency property.

Gets or sets the context for input used by this RichEditBox.

The input scope, which provides a hint at the type of text input expected by the control.

Identifies the InputScope dependency property.

The identifier for the InputScope dependency property.

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

**true** if color glyphs show in color; otherwise, **false**. The default is **true**.

Identifies the IsColorFontEnabled dependency property.

The identifier for the IsColorFontEnabled dependency property.

Gets or sets a value that indicates whether a user can enter text in the handwriting view.

**true** to allow the user to enter text in the handwriting view; otherwise, **false**.

Identifies the IsHandwritingViewEnabled dependency property.

The identifier for the IsHandwritingViewEnabled dependency property.

Gets or sets a value that indicates whether the user can change the text in the RichEditBox.

**True** if the RichEditBox is read-only; otherwise, **false**. The default is **false**.

Identifies the IsReadOnly dependency property.

The identifier for the IsReadOnly dependency property.

Gets or sets a value that indicates whether the text input should interact with a spell check engine.

**True** if the text input should interact with a spell check engine; otherwise, **false**. The default is **true**.

Identifies the IsSpellCheckEnabled dependency property.

The identifier for the IsSpellCheckEnabled dependency property.

Gets or sets a value that indicates whether text prediction features ("autocomplete") are enabled for this RichEditBox.

**True** to enable text prediction features; otherwise, **false**. The default is **true**.

Identifies the IsTextPredictionEnabled dependency property.

The identifier for the IsTextPredictionEnabled dependency property.

Gets or sets the value that specifies the maximum number of characters allowed for user input.

The maximum number of characters allowed for user input. The default is 0 (no limit).

Identifies the **MaxLength** dependency property.

The identifier for the **MaxLength** dependency property.

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is entered. The default is an empty string ("").

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets or sets a value that indicates whether the on-screen keyboard is shown when the control receives focus programmatically.

**true** if the on-screen keyboard is not shown when the control receives focus programmatically; otherwise, **false**. The default is **false**.

Identifies the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

The identifier for the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

Gets the flyout that shows proofing commands.

The flyout that shows proofing commands.

Identifies the ProofingMenuFlyout dependency property.

The identifier for the ProofingMenuFlyout dependency property.

Gets or sets the flyout that is shown when text is selected using mouse, touch, or pen; or **null** if no flyout is shown.

The flyout that is shown when text is selected using mouse, touch, or pen; or **null** if no flyout is shown. The default is an instance of TextCommandBarFlyout.

Identifies the SelectionFlyout dependency property.

The identifier for the SelectionFlyout dependency property.

Gets or sets the brush used to highlight the selected text.

The brush used to highlight the selected text. The default is a null brush from a pure code perspective, but the default control template for RichEditBox applies a theme resource brush for this in a runtime instance of a RichEditBox control.

Identifies the SelectionHighlightColor dependency property.

The identifier for the SelectionHighlightColor dependency property.

Gets or sets the brush used to highlight the selected text when the RichEditBox does not have focus.

The brush used to highlight the selected text when RichEditBox loses focus. The default is a null brush from a pure code perspective, but the default control template for RichEditBox applies a Transparent brush for this in a runtime instance of a RichEditBox control. To disable the SelectionHighlightColorWhenNotFocused, set the brush to Transparent once again.

Identifies the **SelectionHighlightColorWhenNotFocused** dependency property.

The identifier for the **SelectionHighlightColorWhenNotFocused** dependency property.

Gets or sets a value that indicates how text is aligned in the RichEditBox.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the TextAlignment dependency property.

Identifier for the TextAlignment dependency property.

Gets an object that enables access to the text object model for the text contained in a RichEditBox.

An object that enables access to the text object model.

Gets or sets a value that indicates how the reading order is determined for the RichEditBox.

A value that indicates how the reading order is determined for the RichEditBox. The default is **DetectFromContent**.

Identifies the TextReadingOrder dependency property.

The identifier for the TextReadingOrder dependency property.

Gets or sets a value that indicates how text wrapping occurs if a line of text extends beyond the available width of the RichEditBox.

One of the TextWrapping enumeration values that specifies whether text is wrapped. The default is **Wrap**.

Identifies the TextWrapping dependency property.

The identifier for the TextWrapping dependency property.

Occurs when the Input Method Editor (IME) window open, updates, or closes.

Occurs when a content link is added, removed, or edited.

Occurs when the link is activated by user interaction.

Occurs when the system processes an interaction that displays a context menu.

Occurs before copied text is moved to the clipboard.

Occurs before cut text is moved to the clipboard.

Occurs when text is pasted into the control.

Occurs when the text selection has changed.

Occurs when the text selection starts to change.

Occurs when content changes in the RichEditBox.

Occurs synchronously when the text in the edit box starts to change, but before it is rendered.

Occurs when text being composed through an Input Method Editor (IME) changes.

Occurs when a user stops composing text through an Input Method Editor (IME).

Occurs when a user starts composing text through an Input Method Editor (IME).

Asynchronously gets a list of candidate words based on the provided phonetic characters in an Input Method Editor (IME).

A list of candidate words based on the provided phonetic characters in an Input Method Editor (IME).

Provides event data for the RichEditBox.SelectionChanging event.

Gets or sets a value that indicates whether the selection operation should be canceled.

**true** to cancel the selection operation; otherwise, **false**. The default is **false**.

Gets the length of the text selection.

The length of the text selection.

Gets the starting index of the text selection.

The starting index of the text selection.

Provides event data for the RichEditBox.TextChanging event.

Gets a value that indicates whether the event occured due to a change in the text content.

**true** if a change to the text content caused the event; otherwise, **false**.

Defines constants that specify the format of text copied from a RichEditBox.

Text is copied as both plain text and rich text.

Text is copied only as plain text.

Represents a rich text display container that supports formatted text, hyperlinks, inline images, and other rich content. RichTextBlock supports a built-in overflow model.

Initializes a new instance of the RichTextBlock class.

Gets a value that represents the offset in pixels from the top of the content to the baseline of the first paragraph. The baseline of the paragraph is the baseline of the first line in it.

The computed baseline for the first paragraph, or 0 if the RichTextBlock is empty.

Gets the contents of the RichTextBlock.

A BlockCollection that contains the contents of the RichTextBlock.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Identifies the CharacterSpacing dependency property.

The identifier for the CharacterSpacing dependency property.

Gets a TextPointer that indicates the end of content in the RichTextBlock.

A TextPointer that indicates the end of content in the RichTextBlock.

Gets a TextPointer that indicates the start of content in the RichTextBlock.

A TextPointer that indicates the start of content in the RichTextBlock.

Gets or sets the preferred top-level font family for the text content in this element.

A FontFamily object that specifies the preferred font family, or a primary preferred font family with one or more fallback font families. For information about defaults, see the FontFamily class topic.

Identifies the FontFamily  dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the font size for the text content in this element.

A non-negative value that specifies the font size, measured in pixels. The default is 11.

Identifies the FontSize  dependency property.

The identifier for the FontSize dependency property.

Gets or sets the font stretch for the text content in this element.

The requested font stretch, as a FontStretch constant. The default is Normal.

Identifies the FontStretch  dependency property.

The identifier for the FontStretch dependency property.

Gets or sets the font style for the content in this element.

The requested font style, which is a FontStyle enumeration named constant. The default is Normal.

Identifies the FontStyle  dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the top-level font weight for the RichTextBlock.

The requested font weight, which is a FontWeight that is obtained from one of the FontWeights property values. The default is Normal.

Identifies the FontWeight  dependency property.

The identifier for the FontWeight dependency property.

Gets or sets the Brush to apply to the text contents of the RichTextBlock.

The brush used to apply to the text contents. The default is a null brush from a pure code perspective, but the default text styles set this to Black (for **Light** theme) or White (for **Dark** theme) for a TextBlock element in UI.

Identifies the Foreground  dependency property.

The identifier for the Foreground dependency property.

Gets a value that indicates whether the RichTextBlock has content that extends beyond its bounds, that can provide content to an OverflowContentTarget element.

**True** if the RichTextBlock has content that extends beyond its bounds; otherwise, **false**.

Identifies the HasOverflowContent dependency property.

The identifier for the HasOverflowContent dependency property.

Gets or sets a value that indicates how text is aligned in the RichTextBlock.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the HorizontalTextAlignment dependency property.

The identifier for the HorizontalTextAlignment dependency property.

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

**true** if color glyphs show in color; otherwise, **false**. The default is **true**.

Identifies the IsColorFontEnabled dependency property.

The identifier for the IsColorFontEnabled dependency property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets a value that determines whether text content of the RichTextBlock can be selected for clipboard or drag purposes, or for UI styling changes that indicate selected text.

**true** if text content of the RichTextBlock can be selected for clipboard or drag purposes. **false** if text cannot be selected. The default is **true**.

Identifies the IsTextSelectionEnabled dependency property.

The identifier for the IsTextSelectionEnabled dependency property.

Gets a value that indicates whether the control has trimmed text that overflows the content area.

**true** if text is trimmed; otherwise, **false**.

Identifies the IsTextTrimmed dependency property.

The identifier for the IsTextTrimmed dependency property.

Gets or sets the height of each line of content.

The height of each line in pixels. A value of 0 indicates that the line height is determined automatically from the current font characteristics. The default is 0.

Identifies the LineHeight  dependency property.

The identifier for the LineHeight dependency property.

Gets or sets a value that indicates how a line box is determined for each line of text in the RichTextBlock.

A value that indicates how a line box is determined for each line of text in the RichTextBlock. The default is **MaxHeight**.

Identifies the LineStackingStrategy  dependency property.

The identifier for the LineStackingStrategy dependency property.

Gets or sets the maximum lines of text shown in the RichTextBlock.

The maximum lines of text shown in the RichTextBlock. The default is 0, which is a special value that represents "Auto" behavior. The value cannot be negative.

Identifies the MaxLines dependency property.

The identifier for the MaxLines dependency property.

Get or sets a value that indicates how the font is modified to align with fonts of different sizes.

A value of the enumeration that indicates how the font is modified to align at different sizes. The default is **None**.

Identifies the OpticalMarginAlignment dependency property.

The identifier for the OpticalMarginAlignment dependency property.

Gets or sets a reference to a RichTextBlockOverflow that is the linked target for any text overflow from this RichTextBlock.

The target for overflow.

Identifies the OverflowContentTarget dependency property.

The identifier for the OverflowContentTarget dependency property.

Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a RichTextBlock.

A Thickness structure that specifies the amount of padding to apply.

Identifies the Padding  dependency property.

The identifier for the Padding dependency property.

Gets a text range of selected text.

A text range of the selected text.

Identifies the SelectedText dependency property.

The identifier for the SelectedText dependency property.

Gets the end position of the text selected in the RichTextBlock.

An object that represents the selection end, or null if no selection exists.

Gets or sets the flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown.

The flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown. The default is an instance of TextCommandBarFlyout.

Identifies the SelectionFlyout dependency property.

The identifier for the SelectionFlyout dependency property.

Gets or sets the brush used to highlight the selected text.

The brush used to highlight the selected text. The default is a null brush from a pure code perspective, but the default text styles for RichTextBlock content apply a theme resource brush for this in a runtime instance of a RichTextBlock control.

Identifies the SelectionHighlightColor dependency property.

The identifier for the SelectionHighlightColor dependency property.

Gets the starting position of the text selected in the RichTextBlock.

An object that represents the selection start, or **null** if no selection exists.

Gets or sets a value that indicates how the text is aligned in the RichTextBlock.

One of the TextAlignment enumeration values that indicates how text is aligned. The default is **Left**.

Identifies the TextAlignment dependency property.

Identifier for the TextAlignment dependency property.

Gets or sets a value that indicates what decorations are applied to the text.

A value of the enumeration. The default is **None**.

Identifies the **TextDecorations** dependency property.

The identifier for the **TextDecorations** dependency property.

Gets the collection of text highlights.

The collection of text highlights.

Gets or sets the indentation of the first line of text in each paragraph in the RichTextBlock.

The offset amount of the first line of text in a paragraph.

Identifies the TextIndent dependency property.

The identifier of the TextIndent dependency property.

Gets or sets a value that indicates how the line box height is determined for each line of text in the RichTextBlock.

A value that indicates how the line box height is determined for each line of text in the RichTextBlock. The default is **Full**.

Identifies the TextLineBounds dependency property.

The identifier for the TextLineBounds dependency property.

Gets or sets a value that indicates how the reading order is determined for the RichTextBlock.

A value that indicates how the reading order is determined for the RichTextBlock. The default is **DetectFromContent**.

Identifies the TextReadingOrder dependency property.

The identifier for the TextReadingOrder dependency property.

Gets or sets a value that indicates how text is trimmed when it overflows the content area.

One of the TextTrimming enumeration values that specifies the text trimming behavior to use. The default is **None**.

Identifies the TextTrimming dependency property.

The identifier of the TextTrimming dependency property.

Gets or sets a value that indicates whether text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock.

One of the TextWrapping enumeration values that specifies whether text is wrapped. The default is **Wrap**.

Identifies the TextWrapping dependency property.

The identifier for the TextWrapping dependency property.

Occurs when the system processes an interaction that displays a context menu.

Occurs when the IsTextTrimmed property value has changed.

Occurs when the text selection has changed.

Copies the selected content to the Windows clipboard.

Focuses the RichTextBlock, as if it were a conventionally focusable control.

Specifies the desired target for focus state, as a value of the enumeration. **true** if focus was set to the RichTextBlock, or focus was already there. **false** if the RichTextBlock is not focusable.

Returns a TextPointer text reference from a RichTextBlock by hit-testing a specific Point within the text display area.

The point to test. The determined text reference.

Selects a range of text in the RichTextBlock.

An object that represents the start of the range to select. An object that represents the end of the range to select.

Selects the entire contents in the RichTextBlock.

Represents a rich text display overflow container. This element cannot have direct content. The only purpose of RichTextBlockOverflow is to display text content that does not fit in the bounds of a RichTextBlock or another RichTextBlockOverflow element.

Initializes a new instance of the RichTextBlockOverflow class.

Gets a value that represents the offset in pixels from the top of the content to the baseline of the first paragraph. The baseline of the paragraph is the baseline of the first line in it.

The computed baseline for the first paragraph, or 0 if the RichTextBlockOverflow is empty.

Gets a TextPointer that indicates the end of content in the RichTextBlockOverflow.

A TextPointer that indicates the end of content in the RichTextBlockOverflow.

Gets the RichTextBlock content source of this RichTextBlockOverflow.

The content source for this RichTextBlockOverflow.

Gets a TextPointer that indicates the start of content in the RichTextBlockOverflow.

A TextPointer that indicates the start of content in the RichTextBlockOverflow.

Gets a value that indicates whether the RichTextBlockOverflow has content that extends beyond its bounds, that can provide content to an OverflowContentTarget element.

**True** if the RichTextBlockOverflow has content that extends beyond its bounds; otherwise, **false**.

Identifies the HasOverflowContent dependency property.

The identifier for the HasOverflowContent dependency property.

Gets a value that indicates whether the control has trimmed text that overflows the content area.

**true** if text is trimmed; otherwise, **false**.

Identifies the IsTextTrimmed dependency property.

The identifier for the IsTextTrimmed dependency property.

Gets or sets the maximum lines of text shown in the RichTextBlockOverflow.

The maximum lines of text shown in the RichTextBlockOverflow. The default is 0, which is a special value that represents "Auto" behavior. The value cannot be negative.

Identifies the MaxLines dependency property.

The identifier for the MaxLines dependency property.

Gets or sets a reference to another RichTextBlockOverflow that is the linked target for any text overflow from this RichTextBlockOverflow.

The target for overflow.

Identifies the OverflowContentTarget dependency property.

The identifier for the OverflowContentTarget dependency property.

Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a RichTextBlockOverflow.

A Thickness structure that specifies the amount of padding to apply.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Occurs when the IsTextTrimmed property value has changed.

Focuses the RichTextBlockOverflow, as if it were a conventionally focusable control.

Specifies the desired target for focus state, as a value of the enumeration. **true** if focus was set to the RichTextBlockOverflow, or focus was already there. **false** if the RichTextBlockOverflow is not focusable.

Returns a TextPointer text reference from a RichTextBlockOverflow by hit-testing a specific Point within the text display area.

The point to test. The determined text reference.

Defines row-specific properties that apply to Grid elements.

Initializes a new instance of the RowDefinition class.

Gets a value that represents the calculated height of the RowDefinition.

A value that represents the calculated height in pixels. The default value is 0.

Gets the calculated height of a RowDefinition element, or sets the GridLength value of a row that is defined by the RowDefinition.

The GridLength that represents the height of the row. The default value is a GridLength representing a "1\*" sizing.

Identifies the Height dependency property.

The identifier for the Height dependency property.

Gets or sets a value that represents the maximum height of a RowDefinition.

A Double that represents the maximum height.

Identifies the MaxHeight dependency property.

The identifier for the MaxHeight dependency property.

Gets or sets a value that represents the minimum allowed height of a RowDefinition.

A Double that represents the minimum allowed height. The default value is 0.

Identifies the MinHeight dependency property.

The identifier for the MinHeight dependency property.

Provides access to an ordered, strongly typed collection of RowDefinition objects.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the RowDefinition located at the specified index.

The integer index for the value to retrieve. The RowDefinition value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the RowDefinition value specified.

The index at which to set the value. The value to set.

Defines constants that specify the visibility of a scrollbar within a ScrollViewer control.

A ScrollBar appears only when the viewport cannot display all of the content.

A ScrollBar does not appear even when the viewport cannot display all of the content. Scrolling is disabled.

A ScrollBar does not appear even when the viewport cannot display all of the content. Scrolling is still enabled, and can occur through touch, keyboard, or mouse wheel interaction.

A ScrollBar always appears.

Displays the content of a ScrollViewer control.

Initializes a new instance of the ScrollContentPresenter class.

Gets or sets a value that indicates whether scrolled content can render outside the bounds of the ScrollViewer.

**true** if scrolled content can render outside the bounds of the ScrollViewer; otherwise, **false**. The default is **false**.

Identifies the CanContentRenderOutsideBounds dependency property.

The identifier for the CanContentRenderOutsideBounds dependency property.

Gets or sets a value that indicates whether scrolling on the horizontal axis is possible.

**true** if scrolling is possible; otherwise, **false**.

Gets or sets a value that indicates whether scrolling on the vertical axis is possible.

**true** if scrolling is possible; otherwise, **false**.

Gets the vertical size of all the scrollable content.

The vertical size of the all scrollable content.

Gets the horizontal size of all the scrollable content.

The horizontal size of all the scrollable content.

Gets the distance the content has been scrolled horizontally.

The distance the content has been scrolled horizontally.

Gets or sets the ScrollViewer element that controls scrolling behavior.

The ScrollViewer element that controls scrolling behavior.

Gets or sets a value that indicates whether, when used in the ControlTemplate for a ScrollViewer, the presenter restricts the size of its Content to the owning ScrollViewer size.

**true** if the presenter restricts its Content size to the owning ScrollViewer size; otherwise, **false**. The default is **false**.

Identifies the SizesContentToTemplatedParent dependency property.

The identifier for the SizesContentToTemplatedParent dependency property.

Gets the distance the content has been scrolled vertically.

The distance the content has been scrolled vertically.

Gets the vertical size of the viewable content.

The vertical size of the viewable content.

Gets the horizontal size of the viewable content.

The horizontal size of the viewable content.

Scrolls the ScrollContentPresenter content downward by one line.

Scrolls the ScrollContentPresenter content to the left by a predetermined amount.

Scrolls the ScrollContentPresenter content to the right by a predetermined amount.

Scrolls the ScrollContentPresenter content upward by one line.

Forces content to scroll until the coordinate space of a visual object is visible.

A UIElement that becomes visible. The bounding rectangle that identifies the coordinate space to make visible. A Rect that represents the visible region after scrolling happens.

Scrolls down within content after a user clicks the wheel button on a mouse.

Scrolls left within content after a user clicks the wheel button on a mouse.

Scrolls right within content after a user clicks the wheel button on a mouse.

Scrolls up within content after a user clicks the wheel button on a mouse.

Scrolls down within the content by one page.

Scrolls left within the content by one page.

Scrolls right within the content by one page.

Scrolls up within the content by one page.

Sets the distance the content has been scrolled horizontally.

The distance the content has been scrolled horizontally.

Sets the distance the content has been scrolled vertically.

The distance the content has been scrolled vertically.

Defines constants that describe how an item that is programmatically scrolled into view aligns with the visible area.

The item aligns with the nearest edge.

The item aligns with the leading edge.

Defines constants that specify scrolling behavior for ScrollViewer and other parts involved in scrolling scenarios.

Scrolling is enabled but behavior uses a "rails" manipulation mode.

Scrolling is disabled.

Scrolling is enabled.

Represents a scrollable area that can contain other visible elements.

Initializes a new instance of the ScrollViewer class.

Gets or sets a value that determines whether the ScrollViewer uses a bring-into-view scroll behavior when an item in the view gets focus.

**true** to use a behavior that brings focused items into view. **false** to use a behavior that focused items do not automatically scroll into view. The default is **true**.

Identifies the BringIntoViewOnFocusChange dependency property.

The identifier for the BringIntoViewOnFocusChange dependency property.

Gets or sets a value that indicates whether scrolled content can render outside the bounds of the ScrollViewer.

**true** if scrolled content can render outside the bounds of the ScrollViewer; otherwise, **false**. The default is **false**.

Identifies the CanContentRenderOutsideBounds dependency property.

The identifier for the CanContentRenderOutsideBounds dependency property.

Gets a value that indicates whether the horizontal ScrollBar is visible.

A Visibility that indicates whether the horizontal scroll bar is visible. The default value is **Hidden**.

Identifies the ComputedHorizontalScrollBarVisibility dependency property.

The identifier for the ComputedHorizontalScrollBarVisibility  dependency property.

Gets a value that indicates whether the vertical ScrollBar is visible.

A Visibility that indicates whether the vertical scroll bar is visible. The default value is **Visible**.

Identifies the ComputedVerticalScrollBarVisibility  dependency property.

The identifier for the ComputedVerticalScrollBarVisibility  dependency property.

The currently chosen anchor element to use for scroll anchoring.

The most recently chosen UIElement for scroll anchoring after a layout pass, or **null**.

Gets the vertical size of all the scrollable content in the ScrollViewer.

The vertical size of all the scrollable content in the ScrollViewer.

Identifier for the ExtentHeight dependency property.

The identifier for the ExtentHeight dependency property.

Gets the horizontal size of all the scrollable content in the ScrollViewer.

The horizontal size of all the scrollable content in the ScrollViewer.

Identifier for the ExtentWidth dependency property.

The identifier for the ExtentWidth dependency property.

Determines the horizontal position of the ScrollViewer's *anchor point* with respect to the viewport. By default, the ScrollViewer selects an element as its CurrentAnchor by identifying the element in its viewport nearest to the anchor point.

A normalized value (0.0 to 1.0). The default is 0.0.

Identifies the HorizontalAnchorRatio dependency property.

The identifier for the HorizontalAnchorRatio dependency property.

Gets the distance the content has been scrolled horizontally.

The distance the content has been scrolled horizontally.

Identifies the HorizontalOffset  dependency property.

The identifier for the HorizontalOffset  dependency property.

Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed.

A ScrollBarVisibility value that indicates whether a horizontal ScrollBar should be displayed. The default value is **Disabled**.

Identifies the HorizontalScrollBarVisibility  dependency property.

The identifier for the HorizontalScrollBarVisibility  dependency property.

Gets or sets a value that determines how manipulation input influences scrolling behavior on the horizontal axis.

A value of the enumeration. The typical default (as set through the default template, not class initialization) is **Enabled**.

Identifies the HorizontalScrollMode dependency property.

The identifier for the HorizontalScrollMode dependency property.

Gets or sets a value that indicates how the existing snap points are horizontally aligned versus the initial viewport.

A value of the enumeration.

Identifies the HorizontalSnapPointsAlignment dependency property.

The identifier for the HorizontalSnapPointsAlignment dependency property.

Gets or sets a value that declares how manipulation behavior reacts to the snap points along the horizontal axis.

A value of the enumeration. The default is **None** but might be set through a control template.

Identifies the HorizontalSnapPointsType dependency property.

The identifier for the HorizontalSnapPointsType dependency property.

Gets or sets a value that determines the deferred scrolling behavior for a ScrollViewer.

**true** if deferred scrolling should occur; otherwise, **false**.

Identifies the IsDeferredScrollingEnabled dependency property.

The identifier for the IsDeferredScrollingEnabled dependency property.

Gets or sets a value that indicates whether the scroll rail is enabled for the horizontal axis.

**True** to enable the horizontal scroll rail; otherwise, **false**. The default is **true**.

Identifies the IsHorizontalRailEnabled dependency property.

The identifier for the IsHorizontalRailEnabled dependency property.

Gets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the horizontal axis.

**true** to enable horizontal scroll chaining from child to parent; otherwise, **false**.

Identifies the IsHorizontalScrollChainingEnabled dependency property.

The identifier for the IsHorizontalScrollChainingEnabled dependency property.

Gets or sets a value that indicates whether scroll actions should include inertia in their behavior and value.

**true** if scroll actions should include inertia in their behavior and value; otherwise, **false**.

Identifies the IsScrollInertiaEnabled dependency property.

The identifier for the IsScrollInertiaEnabled dependency property.

Gets or sets a value that indicates whether the scroll rail is enabled for the vertical axis.

**True** to enable the vertical scroll rail; otherwise, **false**. The default is **true**.

Identifies the IsVerticalRailEnabled dependency property.

The identifier for the IsVerticalRailEnabled dependency property.

Gets or sets a value that indicates whether scroll chaining is enabled from this child to its parent, for the vertical axis.

**true** to enable vertical scroll chaining from child to parent; otherwise, **false**.

Identifies the IsVerticalScrollChainingEnabled dependency property.

The identifier for the IsVerticalScrollChainingEnabled dependency property.

Gets or sets a value that indicates whether zoom chaining is enabled from this child to its parent.

**true** to enable zoom chaining from child to parent; otherwise, **false**.

Identifies the IsZoomChainingEnabled dependency property.

The identifier for the IsZoomChainingEnabled dependency property.

Gets or sets a value that indicates whether zoom actions should include inertia in their behavior and value.

**true** if zoom actions should include inertia in their behavior and value; otherwise, **false**.

Identifies the IsZoomInertiaEnabled dependency property.

The identifier for the IsZoomInertiaEnabled dependency property.

Gets or sets the content of the left header.

The content of the left header.

Identifies the LeftHeader dependency property.

The identifier for the LeftHeader dependency property.

Gets or sets a value that indicates the maximum permitted run-time value of ZoomFactor.

The maximum permitted run-time value of ZoomFactor. The default is 10.

Identifies the MaxZoomFactor dependency property.

The identifier for the MaxZoomFactor dependency property.

Gets or sets a value that indicates the minimum permitted run-time value of ZoomFactor.

The minimum permitted run-time value of ZoomFactor. The default is 0.1.

Identifies the MinZoomFactor dependency property.

The identifier for the MinZoomFactor dependency property.

Gets or sets a value that indicates whether the ScrollViewer should try to adjust its content to keep it visible when a docked CoreInputView occludes part of it.

**true** if the ScrollViewer should try to adjust its content; otherwise, **false**. The default is **false**.

Identifies the ReduceViewportForCoreInputViewOcclusions dependency property.

The identifier for the ReduceViewportForCoreInputViewOcclusions dependency property.

Gets a value that represents the vertical size of the area that can be scrolled; the difference between the height of the extent and the height of the viewport.

The vertical size of the area that can be scrolled. This property has no default value.

Identifies the ScrollableHeight  dependency property.

The identifier for the ScrollableHeight  dependency property.

Gets a value that represents the horizontal size of the area that can be scrolled; the difference between the width of the extent and the width of the viewport.

The horizontal size of the area that can be scrolled. This property has no default value.

Identifies the ScrollableWidth  dependency property.

The identifier for the ScrollableWidth  dependency property.

Gets or sets the content of the top header.

The content of the top header.

Identifies the TopHeader dependency property.

The identifier for the TopHeader dependency property.

Gets or sets the content of the top, left header.

The content of the top, left header.

Identifies the TopLeftHeader dependency property.

The identifier for the TopLeftHeader dependency property.

Determines the vertical position of the ScrollViewer's *anchor point* with respect to the viewport. By default, the ScrollViewer selects an element as its CurrentAnchor by identifying the element in its viewport nearest to the anchor point.

A normalized value (0.0 to 1.0). The default is 0.0.

Identifies the VerticalAnchorRatio dependency property.

The identifier for the VerticalAnchorRatio dependency property.

Gets the distance the content has been scrolled vertically.

The distance the content has been scrolled vertically.

Identifies the VerticalOffset  dependency property.

The identifier for the VerticalOffset  dependency property.

Gets or sets a value that indicates whether a vertical ScrollBar should be displayed.

A ScrollBarVisibility value that indicates whether a vertical ScrollBar should be displayed. The default value is **Visible**.

Identifies the VerticalScrollBarVisibility  dependency property.

The identifier for the VerticalScrollBarVisibility  dependency property.

Gets or sets a value that determines how manipulation input influences scrolling behavior on the vertical axis.

A value of the enumeration. The typical default (as set through the default template, not class initialization) is **Enabled**.

Identifies the VerticalScrollMode dependency property.

The identifier for the VerticalScrollMode dependency property.

Gets or sets a value that indicates how the existing snap points are vertically aligned versus the initial viewport.

A value of the enumeration.

Identifies the VerticalSnapPointsAlignment dependency property.

The identifier for the VerticalSnapPointsAlignment dependency property.

Gets or sets a value that declares how manipulation behavior reacts to the snap points along the vertical axis.

A value of the enumeration. The default is **None** but might be set through a control template.

Identifies the VerticalSnapPointsType dependency property.

The identifier for the VerticalSnapPointsType dependency property.

Gets the vertical size of the viewable content.

The vertical size of the viewable content.

Identifies the ViewportHeight  dependency property.

The identifier for the ViewportHeight dependency property.

Gets the horizontal size of the viewable content.

The horizontal size of the viewable content.

Identifies the ViewportWidth dependency property.

The identifier for the ViewportWidth dependency property.

Gets a value that indicates the current zoom factor engaged for content scaling.

The current zoom factor engaged for content scaling. The default is 1.0, where 1.0 indicates no additional scaling.

Identifies the ZoomFactor dependency property.

The identifier for the ZoomFactor dependency property.

Gets or sets a value that indicates whether zoom behavior in the ScrollViewer content is enabled.

A value of the enumeration.

Identifies the ZoomMode dependency property.

The identifier for the ZoomMode dependency property.

Gets the observable collection of zoom snap point factors that are held by the ScrollViewer.

A collection of Single values that represent zoom factors as snap points.

Identifies the ZoomSnapPoints dependency property.

The identifier for the ZoomSnapPoints dependency property.

Gets or sets a value that indicates how zoom snap points are processed for interaction input.

A value of the enumeration.

Identifies the ZoomSnapPointsType dependency property.

The identifier for the ZoomSnapPointsType dependency property.

Occurs when an anchor is requested at the beginning of the Arrange pass. Handle this event to override the ScrollViewer's default logic to select an anchor element as part of *scroll anchoring*.

Occurs when any direct manipulation of the ScrollViewer finishes.

Occurs when any direct manipulation of the ScrollViewer begins.

Occurs when manipulations such as scrolling and zooming have caused the view to change.

Occurs when manipulations such as scrolling and zooming cause the view to change.

Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor.

A value between 0 and ScrollableWidth that specifies the distance the content should be scrolled horizontally. A value between 0 and ScrollableHeight that specifies the distance the content should be scrolled vertically. A value between MinZoomFactor and MaxZoomFactor that specifies the required target ZoomFactor. **true** if the view is changed; otherwise, **false**.

Causes the ScrollViewer to load a new view into the viewport using the specified offsets and zoom factor, and optionally disables scrolling animation.

A value between 0 and ScrollableWidth that specifies the distance the content should be scrolled horizontally. A value between 0 and ScrollableHeight that specifies the distance the content should be scrolled vertically. A value between MinZoomFactor and MaxZoomFactor that specifies the required target ZoomFactor. **true** to disable zoom/pan animations while changing the view; otherwise, **false**. The default is **false**. **true** if the view is changed; otherwise, **false**.

Gets the value of the BringIntoViewOnFocusChange dependency property / `ScrollViewer.BringIntoViewOnFocusChange` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the CanContentRenderOutsideBounds dependency property / `ScrollViewer.CanContentRenderOutsideBounds` XAML attached property on a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the HorizontalScrollBarVisibility dependency property / `ScrollViewer.HorizontalScrollBarVisibility` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the HorizontalScrollMode dependency property / `ScrollViewer.HorizontalScrollMode` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsDeferredScrollingEnabled dependency property / `ScrollViewer.IsDeferredScrollingInertiaEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsHorizontalRailEnabled dependency property / `ScrollViewer.IsHorizontalRailEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsHorizontalScrollChainingEnabled dependency property / `ScrollViewer.IsHorizontalScrollChainingEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsScrollInertiaEnabled dependency property / `ScrollViewer.IsScrollInertiaEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsVerticalRailEnabled dependency property / `ScrollViewer.IsVerticalRailEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsVerticalScrollChainingEnabled dependency property / `ScrollViewer.IsVerticalScrollChainingEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsZoomChainingEnabled dependency property / `ScrollViewer.IsZoomChainingEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the IsZoomInertiaEnabled dependency property / `ScrollViewer.IsZoomInertiaEnabled` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the VerticalScrollBarVisibility dependency property / `ScrollViewer.VerticalScrollBarVisibility` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the VerticalScrollMode dependency property / `ScrollViewer.VerticalScrollMode` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Gets the value of the ZoomMode dependency property / `ScrollViewer.ZoomMode` XAML attached property from a specified element.

The element from which the property value is read. The value of the property, as obtained from the property store.

Called when the value of properties that describe the size and location of the scroll area change.

Registers a UIElement as a potential scroll anchor.

A UIElement within the subtree of the ScrollViewer.

Scrolls the content that is within the ScrollViewer to the specified horizontal offset position.

ScrollToHorizontalOffset may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView. The position that the content scrolls to.

Scrolls the content that is within the ScrollViewer to the specified vertical offset position.

ScrollToVerticalOffset may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView. The position that the content scrolls to.

Sets the value of the BringIntoViewOnFocusChange dependency property / `ScrollViewer.BringIntoViewOnFocusChange` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the CanContentRenderOutsideBounds dependency property / `ScrollViewer.CanContentRenderOutsideBounds` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the HorizontalScrollBarVisibility dependency property / `ScrollViewer.HorizontalScrollBarVisibility` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the HorizontalScrollMode dependency property / `ScrollViewer.HorizontalScrollMode` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsDeferredScrollingEnabled dependency property / `ScrollViewer.IsDeferredScrollingEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsHorizontalRailEnabled dependency property / `ScrollViewer.IsHorizontalRailEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsHorizontalScrollChainingEnabled dependency property / `ScrollViewer.IsHorizontalScrollChainingEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsScrollInertiaEnabled dependency property / `ScrollViewer.IsScrollInertiaEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsVerticalRailEnabled dependency property / `ScrollViewer.IsVerticalRailEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsVerticalScrollChainingEnabled dependency property / `ScrollViewer.IsVerticalScrollChainingEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsZoomChainingEnabled dependency property / `ScrollViewer.IsZoomChainingEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the IsZoomInertiaEnabled dependency property / `ScrollViewer.IsZoomInertiaEnabled` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the VerticalScrollBarVisibility dependency property / `ScrollViewer.VerticalScrollBarVisibility` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the VerticalScrollMode dependency property / `ScrollViewer.VerticalScrollMode` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Sets the value of the ZoomMode dependency property / `ScrollViewer.ZoomMode` XAML attached property on a specified element.

The element on which to set the property value. The value to set.

Unregisters a UIElement as a potential scroll anchor.

A UIElement within the subtree of the ScrollViewer.

Sets the effective value of ZoomFactor.

ZoomToFactor may be altered or unavailable for releases after Windows 8.1. Instead, use ChangeView. The zoom factor to set. The factors are based on a norm of 1.0, which represents no zoom applied. The values you can set are also influenced by current values for MinZoomFactor and MaxZoomFactor.

Provides a view for a ScrollViewer when its view is changing.

Gets the distance the content has been scrolled horizontally.

The distance the content has been scrolled horizontally.

Gets the distance the content has been scrolled vertically.

The distance the content has been scrolled vertically.

Gets a value that indicates the current zoom factor engaged for content scaling.

The current zoom factor engaged for content scaling. The default is 1.0, where 1.0 indicates no additional scaling.

Provides event data for the ViewChanged event and similar control-specific events.

Initializes a new instance of the ScrollViewerViewChangedEventArgs class.

Gets a value that indicates whether the underlying manipulation that raised the event is complete.

**True** if the manipulation is at an intermediate stage and not yet final; **false** if the manipulation is final.

Provides event data for the ViewChanging event and similar control-specific events.

Gets the view that the ScrollViewer will show when the view comes to rest after a pan/zoom manipulation.

The view that the ScrollViewer will show when the view comes to rest after a pan/zoom manipulation.

Gets a value that indicates whether the pan/zoom manipulation has an inertial component.

**true** if the pan/zoom manipulation has an inertial component; otherwise, **false**.

Gets the view that the ScrollViewer will show next.

The view that the ScrollViewer will show next.

Represents a control that can be used to enter search query text. (Not recommended for Universal Windows Platform (UWP) apps. See AutoSuggestBox.)

Initializes a new instance of the SearchBox class.

Gets or sets a value that determines whether the suggested search query is activated when the user presses Enter.

**true** if the suggested search query is activated when the user presses Enter; otherwise, **false**. The default is **false**.

Identifies the ChooseSuggestionOnEnter dependency property.

The identifier for the ChooseSuggestionOnEnter dependency property.

Gets or sets a value that determines whether a user can search by typing anywhere in the app.

**true** if the user can search by typing anywhere in the app; otherwise, **false**. The default is **false**.

Identifies the FocusOnKeyboardInput dependency property.

The identifier for the FocusOnKeyboardInput dependency property.

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is entered. The default is an empty string (""). The maximum placeholder text length is 128 characters.

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets or sets the text contents of the search box.

A string containing the text contents of the search box. The default is an empty string (""). The maximum query text length is 2048 characters.

Identifies the QueryText dependency property.

The identifier for the QueryText dependency property.

Gets or sets a string that identifies the context of the search and is used to store the user's search history with the app.

A string that identifies the context of the search. The default is an empty string ("").

Identifies the SearchHistoryContext dependency property.

The identifier for the SearchHistoryContext dependency property.

Gets or sets a value that determines whether search suggestions are made from the search history.

**true** if search suggestions are made from the search history; otherwise, **false**. The default is **true**.

Identifies the SearchHistoryEnabled dependency property.

The identifier for the SearchHistoryEnabled dependency property.

Occurs when the FocusOnKeyboardInput property is **true** and the app receives textual keyboard input.

Occurs when the query text changes.

Occurs when the user submits a search query.

Occurs when the user picks a suggested search result.

Occurs when the user's query text changes and the app needs to provide new suggestions to display in the search pane.

Specifies whether suggestions based on local files are automatically displayed in the search box suggestions, and defines the criteria that Windows uses to locate and filter these suggestions.

The new settings for local content suggestions.

Provides event data for the SearchBox.QueryChanged event.

Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

The IETF BCP 47 standard language tag.

Gets information about query text that the user enters through an Input Method Editor (IME).

Linguistic information about query text that the user enters through an Input Method Editor (IME).

Gets the query text of the current search.

The query text of the current search.

Provides event data for the SearchBox.QuerySubmitted event.

Gets any modifier keys that are pressed when the user presses enter to submit a query.

Any modifier keys that are pressed when the user presses enter to submit a query.

Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

The IETF BCP 47 standard language tag.

Gets information about query text that the user enters through an Input Method Editor (IME).

Linguistic information about query text that the user enters through an Input Method Editor (IME).

Gets the query text of the current search.

The query text of the current search.

Provides event data for the SearchBox.ResultSuggestionChosen event.

Initializes a new instance of the SearchBoxResultSuggestionChosenEventArgs class.

Gets any modifier keys that are pressed when the user presses enter to pick a search result.

Any modifier keys that are pressed when the user presses enter to pick a search result.

The app-defined tag for the suggested result that the user selected.

The app-defined tag for the selected search result.

Provides event data for the SearchBox.SuggestionsRequested event.

Gets the Internet Engineering Task Force (IETF) language tag (BCP 47 standard) that identifies the language currently associated with the user's text input device.

The IETF BCP 47 standard language tag.

Gets information about query text that the user enters through an Input Method Editor (IME).

Linguistic information about query text that the user enters through an Input Method Editor (IME).

Gets the query text of the current search.

The query text of the current search.

Gets the object that stores the suggestions and information about this request.

The object that stores the suggestions and information about this request.

Provides data for the Hub.SectionsInViewChanged event.

Gets a collection that contains the hub sections that moved into view.

A collection that contains the hub sections that moved into view.

Gets a collection that contains the hub sections that moved out of view.

A collection that contains the hub sections that moved into view.

Represents the method that will handle a SectionsInViewChanged event.

The object where the handler is attached. Event data for the event.

Provides data for the SelectionChanged event.

Initializes a new instance of the SelectionChangedEventArgs class.

Sets the initial AddedItems value. May be null. Sets the initial RemovedItems value. May be null.

Gets a list that contains the items that were selected.

The loosely typed collection of items that were selected in this event.

Gets a list that contains the items that were unselected.

The loosely typed list of items that were unselected in this event.

Represents the method that will handle the SelectionChanged event.

The object where the event handler is attached. The event data.

Defines constants that specify the selection behavior for a ListBox.

The user can select multiple items by entering a special mode, for example when depressing a modifier key.

The user can select multiple items without entering a special mode.

The user can select only one item at a time.

Represents a scrollable control that incorporates two views that have a semantic relationship. For example, the ZoomedOutView might be an index of titles, and the ZoomedInView might include details and summaries for each of the title entries. Views can be changed using zoom or other interactions.

Initializes a new instance of the SemanticZoom class.

Gets or sets a value that declares whether the SemanticZoom can change display views.

**true** if views can be changed; otherwise, **false**. The default is **true**.

Identifies the CanChangeViews dependency property.

The identifier for the CanChangeViews dependency property.

Gets or sets a value that determines whether the ZoomedInView is the active view.

**true** if the ZoomedInView is the active view. **false** if the ZoomedOutView is the active view.

Identifies the IsZoomedInViewActive dependency property.

The identifier for the IsZoomedInViewActive dependency property.

Gets or sets a value that indicates whether the ZoomedInView shows a button that activates the ZoomedOutView.

**True** if the ZoomedInView shows a button that activates the ZoomedOutView; otherwise, **false**. The default is **true**.

Identifies the IsZoomOutButtonEnabled dependency property.

The identifier of the IsZoomOutButtonEnabled dependency property.

Gets or sets the semantically more complete zoomed-in view of the SemanticZoom.

An object that implements ISemanticZoomInfo. Typically this is a practical ListViewBase implementation such as GridView.

Identifies the ZoomedInView dependency property.

The identifier for the ZoomedInView dependency property.

Gets or sets the zoomed-out view of the SemanticZoom.

An object that implements ISemanticZoomInfo. Typically this is a practical ListViewBase implementation such as GridView.

Identifies the ZoomedOutView dependency property.

The identifier for the ZoomedOutView dependency property.

Occurs when a view change is complete and the view is displayed.

Occurs when a view change is requested.

Changes from the current active view to the other possible view. For example, if IsZoomedInViewActive is true, calling this method changes to zoomed-out view.

Communicates information for items and view state in a SemanticZoom, such that hosts for scrolling and virtualization (such as ListViewBase ) can get correct item and bounds information.

Initializes a new instance of the SemanticZoomLocation class.

Gets or sets the sizing bounds of the item as it exists in the current view of a SemanticZoom.

The sizing bounds of the item.

Gets or sets the display item as it exists in the current view of a SemanticZoom.

The specific item in the SemanticZoom.

Provides event data for the ViewChangeStarted and ViewChangeCompleted events.

Initializes a new instance of the SemanticZoomViewChangedEventArgs class.

Provides information about the item and its bounds, once the view change is complete.

Information about the item and its bounds.

Gets or sets a value that indicates whether the starting view is the ZoomedInView.

**true** if the starting view is the ZoomedInView; otherwise, **false**.

Provides information about the item and its bounds, for the item as represented in the previous view.

Information about the item and its bounds.

Represents the method that will handle the ViewChangeStarted and ViewChangeCompleted events.

The object where the handler is attached. Event data for the event.

Represents a control that provides in-context access to settings that affect the current app. (Not recommended for Universal Windows Platform (UWP) app.)

Initializes a new instance of the SettingsFlyout class.

Gets or sets the Brush that fills the background of the SettingsFlyout header.

The brush that provides the background of the SettingsFlyout header. The default is a null brush from a pure code perspective, but the default control template for SettingsFlyout applies a theme resource brush (**SettingsFlyoutHeaderBackgroundThemeBrush**) for this in a runtime instance of a SettingsFlyout control.

Identifies the HeaderBackground dependency property.

The identifier for the HeaderBackground dependency property.

Gets or sets the Brush that fills the foreground of the SettingsFlyout header.

The brush that provides the foreground of the SettingsFlyout header. The default is a null brush from a pure code perspective, but the default control template for SettingsFlyout applies a theme resource brush (**SettingsFlyoutHeaderForegroundThemeBrush**) for this in a runtime instance of a SettingsFlyout control.

Identifies the HeaderForeground dependency property.

The identifier for the HeaderForeground dependency property.

Gets or sets the icon image displayed in the SettingsFlyout header.

The icon image displayed in the SettingsFlyout header area, typically to the right of the Title. The default is **null**, which results in no displayed image.

Identifies the IconSource dependency property.

The identifier for the IconSource dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a SettingsFlyout control.

An object that provides calculated values for templates.

Gets or sets the title of the SettingsFlyout control when displayed.

The title of the SettingsFlyout control. This typically appears in the SettingsFlyout control header area. The default is an empty string.

Identifies the Title dependency property.

The identifier for the Title dependency property.

Occurs when the user clicks the back button on a SettingsFlyout control.

Closes the Settings flyout.

Opens the Settings flyout, and returns the user to the Settings pane after the flyout is dismissed.

Opens the Settings flyout, and returns the user to the app after the flyout is dismissed.

Represents a control that lets the user select from a range of values by moving a Thumb control along a track.

Initializes a new instance of the Slider class.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets the value of the Slider while the user is interacting with it, before the value is snapped to either the tick or step value. The value the Slider snaps to is specified by the SnapsTo property.

A temporary value.

Identifies the IntermediateValue dependency property.

The identifier for the IntermediateValue dependency property.

Gets or sets a value that indicates the direction of increasing value.

**true** if the direction of increasing value is to the left for a horizontal slider or down for a vertical slider; otherwise, **false**. The default is **false**.

Identifies the IsDirectionReversed dependency property.

The identifier for the IsDirectionReversed dependency property.

Gets or sets a value that determines whether the slider value is shown in a tool tip for the Thumb component of the Slider.

**True** if a tool tip is shown for the Thumb component; otherwise, **false**. The default is **true**.

Identifies the IsThumbToolTipEnabled dependency property.

The identifier for the IsThumbToolTipEnabled dependency property.

Gets or sets the orientation of a Slider.

One of the Orientation values. The default is **Horizontal**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets or sets a value that indicates how the Slider conforms the thumb position to its steps or tick marks.

An enumeration value that specifies whether the Slider snaps to steps or tick marks. The default is **StepValues**.

Identifies the SnapsTo dependency property.

The identifier for the SnapsTo dependency property.

Gets or sets the value part of a value range that steps should be created for.

The value part of a value range that steps should be created for.

Identifies the StepFrequency dependency property.

The identifier for the StepFrequency dependency property.

Gets or sets the converter logic that converts the range value of the Slider into tool tip content.

A converter implementation.

Identifies the ThumbToolTipValueConverter dependency property.

The identifier for the ThumbToolTipValueConverter dependency property.

Gets or sets the increment of the value range that ticks should be created for.

The increment to create tick marks for. The default is 0.0.

Identifies the TickFrequency dependency property.

The identifier for the TickFrequency dependency property.

Gets or sets a value that indicates where to draw tick marks in relation to the track.

An enumeration value that specifies where to draw tick marks in relation to the track. The default is **Inline**.

Identifies the TickPlacement dependency property.

The identifier for the TickPlacement dependency property.

Defines constants that specify how panning snap points are processed for gesture/manipulation input.

Content always stops at the snap point closest to where inertia would naturally stop along the direction of inertia.

Content always stops at the snap point closest to the release point along the direction of inertia.

No snapping behavior. Only the manipulation influences the final location.

Content stops at a snap point closest to where inertia would naturally stop along the direction of inertia, depending on how close the snap point is.

Content stops at the next snap point, if the motion starts far from it.

Represents a button with two parts that can be invoked separately. One part behaves like a standard button and the other part invokes a flyout.

Initializes a new instance of the SplitButton class.

Gets or sets the command to invoke when this button is pressed.

The command to invoke when this button is pressed. The default is **null**.

Gets or sets the parameter to pass to the Command property.

The parameter to pass to the Command property. The default is **null**.

Identifies the CommandParameter dependency property.

The identifier for the CommandParameter dependency property.

Identifies the Command dependency property.

The identifier for the Command dependency property.

Gets or sets the flyout associated with this button.

The flyout associated with this button. The default is **null**.

Identifies the Flyout dependency property.

The identifier for the Flyout dependency property.

Occurs when a button control is clicked.

Exposes SplitButton types to Microsoft UI Automation.

Initializes a new instance of the SplitButtonAutomationPeer class.

The SplitButton control instance to create the peer for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Hides the control's drop down menu.

Displays the control's drop down menu.

Sends a request to click the button associated with the automation peer.

Provides event data for the SplitButton.Click event.

Represents a container with two views; one view for the main content and another view that is typically used for navigation commands.

Initializes a new instance of the SplitView class.

Gets or sets the width of the SplitView pane in its compact display mode.

The width of the pane in it's compact display mode. The default is 48 device-independent pixel (DIP) (defined by the **SplitViewCompactPaneThemeLength** resource).

Identifies the CompactPaneLength  dependency property.

The identifier for the CompactPaneLength  dependency property.

Gets or sets the contents of the main panel of a SplitView.

The contents of the main panel of a SplitView. The default is **null**.

Identifies the Content  dependency property.

The identifier for the Content  dependency property.

Gets of sets a value that specifies how the pane and content areas of a SplitView are shown.

A value of the enumeration that specifies how the pane and content areas of a SplitView are shown. The default is **Overlay**.

Identifies the DisplayMode  dependency property.

The identifier for the DisplayMode  dependency property.

Gets or sets a value that specifies whether the SplitView pane is expanded to its full width.

**true** if the pane is expanded to its full width; otherwise, **false**. The default is **true**.

Identifies the IsPaneOpen  dependency property.

The identifier for the IsPaneOpen  dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets the width of the SplitView pane when it's fully expanded.

The width of the SplitView pane when it's fully expanded. The default is 320 device-independent pixel (DIP).

Identifies the  OpenPaneLength dependency property.

The identifier for the OpenPaneLength  dependency property.

Gets or sets the contents of the pane of a SplitView.

The contents of the pane of a SplitView. The default is **null**.

Gets or sets the Brush to apply to the background of the Pane area of the control.

The Brush to apply to the background of the Pane area of the control.

Identifies the PaneBackground  dependency property.

The identifier for the   PaneBackground dependency property.

Gets or sets a value that specifies whether the pane is shown on the right or left side of the SplitView.

A value of the enumeration that specifies whether the pane is shown on the right or left side of the SplitView. The default is **Left**.

Identifies the PanePlacement  dependency property.

The identifier for the   PanePlacement dependency property.

Identifies the Pane  dependency property.

The identifier for the  Pane dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a SplitView control.

An object that provides calculated values for templates.

Identifies the TemplateSettings  dependency property.

The identifier for the TemplateSettings  dependency property.

Occurs when the SplitView pane is closed.

Occurs when the SplitView pane is closing.

Occurs when the SplitView pane is opened.

Occurs when the SplitView pane is opening.

Defines constants that specify how the pane is shown in a SplitView.

The amount of the pane defined by the CompactPaneLength property is shown side-by-side with the content and takes up space in the control layout. The remaining part of the pane pushes the content to the side when it's open and takes up space in the control layout. The pane does not close when the user taps outside of it.

The amount of the pane defined by the CompactPaneLength property is shown side-by-side with the content and takes up space in the control layout. The remaining part of the pane covers the content when it's open and does not take up space in the control layout. The pane closes when the user taps outside of it.

The pane is shown side-by-side with the content and takes up space in the control layout. The pane does not close when the user taps outside of it.

The pane covers the content when it's open and does not take up space in the control layout. The pane closes when the user taps outside of it.

Provides event data for the SplitView.PaneClosing event.

Gets or sets a value that indicates whether the pane closing action should be canceled.

**true** to cancel the pane closing action; otherwise, **false**.

Defines constants that specify whether the pane is to the left or right of the content in a SplitView.

The pane is shown to the left of the SplitView content .

The pane is shown to the right of the SplitView content .

Arranges child elements into a single line that can be oriented horizontally or vertically.

Initializes a new instance of the StackPanel class.

Gets a value that indicates whether the horizontal snap points for the StackPanel are equidistant from each other.

**true** if the horizontal snap points for the StackPanel are equidistant from each other; otherwise, **false**.

Gets or sets a value that indicates whether the generated snap points used for panning in the StackPanel are equidistant from each other.

**true** if the snap points in the StackPanel are equidistant from each other; otherwise, **false**.

Identifies the AreScrollSnapPointsRegular dependency property.

The identifier for the AreScrollSnapPointsRegular dependency property.

Gets a value that indicates whether the vertical snap points for the StackPanel are equidistant from each other.

**true** if the vertical snap points for the StackPanel are equidistant from each other; otherwise, **false**.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

A value of the enumeration that indicates how far the background extends. The default is **InnerBorderEdge**.

Identifies the BackgroundSizing dependency property.

The identifier for the BackgroundSizing dependency property.

Gets or sets a brush that describes the border fill of the panel.

The brush that is used to fill the panel's border. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the BorderBrush dependency property.

The identifier for the BorderBrush dependency property.

Gets or sets the border thickness of the panel.

The border thickness of the panel, as a Thickness value.

Identifies the BorderThickness dependency property.

The identifier for the BorderThickness dependency property.

Gets or sets the radius for the corners of the panel's border.

The degree to which the corners are rounded, expressed as values of the CornerRadius structure.

Identifies the CornerRadius dependency property.

The identifier for the CornerRadius dependency property.

Gets or sets the dimension by which child elements are stacked.

One of the enumeration values that specifies the orientation of child elements. The default is **Vertical**.

Identifies the Orientation  dependency property.

The identifier for the Orientation  dependency property.

Gets or sets the distance between the border and its child object.

The dimensions of the space between the border and its child as a Thickness value. Thickness is a structure that stores dimension values using pixel measures.

Identifies the Padding dependency property.

The identifier for the Padding dependency property.

Gets or sets a uniform distance (in pixels) between stacked items. It is applied in the direction of the StackPanel's Orientation.

The uniform distance (in pixels) between stacked items.

Identifies the Spacing dependency property.

The identifier for the Spacing dependency property.

Occurs when the measurements for horizontal snap points change.

Occurs when the measurements for vertical snap points change.

Returns the index values of the items that the specified point is between.

The point for which to get insertion indexes. The index of the item before the specified point. The index of the item after the specified point.

Returns the set of distances between irregular snap points for a specified orientation and alignment.

The orientation (dimension) for the desired snap point set. The alignment to use when applying the snap points. The read only collection of snap point distances. Returns an empty collection when no snap points are present.

Gets the distance between regular snap points for a specified orientation and alignment.

The orientation/dimension for the desired snap point set. The alignment to use when applying the snap points. Out parameter. The offset of the first snap point. The distance between the equidistant snap points. Returns 0 when no snap points are present.

Defines constants that specify the direction that content is scaled.

The content stretches to fit the parent according to the Stretch property.

The content scales downward only when it is larger than the parent. If the content is smaller, no scaling upward is performed.

The content scales upward only when it is smaller than the parent. If the content is larger, no scaling downward is performed.

Enables custom item style selection logic as a function of the content data and its specific item container.

Initializes a new instance of the StyleSelector class.

Returns a specific Style based on custom logic.

The content. The element to which the style is applied. An application-specific style to apply; may also return null.

When implemented by a derived class, returns a specific Style based on custom logic.

The content. The element to which the style is applied. An application-specific style to apply; may also return null.

Implements a XAML layout surface target for Microsoft DirectX interoperation scenarios. This panel has some atypical restrictions on its usage within an app window; see Remarks.

Initializes a new instance of the SwapChainBackgroundPanel class.

Creates a core input object that handles the input types as specified by the *deviceTypes* parameter.

A combined value of the enumeration. An object that represents the input subsystem for interoperation purposes and can be used for input event connection points.

Provides a hosting surface, where Microsoft DirectX swap chains provide content that can be rendered into a XAML UI. A SwapChainPanel element is a key component for an app that renders Microsoft DirectX graphics and then presents those visuals within a XAML page.

Initializes a new instance of the SwapChainPanel class.

Gets the x-axis scale factor of the SwapChainPanel.

The x-axis scale factor of the SwapChainPanel. A value of 1.0 means no scaling is applied.

Identifies the CompositionScaleX dependency property.

The identifier for the CompositionScaleX dependency property.

Gets the y-axis scale factor of the SwapChainPanel.

The y-axis scale factor of the SwapChainPanel. A value of 1.0 means no scaling is applied.

Identifies the CompositionScaleY dependency property.

The identifier for the CompositionScaleY dependency property.

Occurs when the composition scale factor of the SwapChainPanel has changed.

Creates a core input object that handles the input types as specified by the *deviceTypes* parameter. This core input object can process input events on a background thread.

A combined value of the enumeration. An object that represents the input subsystem for interoperation purposes and can be used for input event connection points.

Defines constants that specify how a SwipeControl behaves after a command is invoked.

In **Reveal** mode, the SwipeControl closes after an item is invoked. In **Execute** mode, the SwipeControl remains open.

The SwipeControl closes after an item is invoked.

The SwipeControl remains open after an item is invoked.

Represents a container that provides access to contextual commands through touch interactions.

Initializes a new instance of the SwipeControl class.

Gets or sets the items that can be invoked when the control is swiped from the bottom up.

The items that can be invoked when the control is swiped from the bottom up.

Identifies the BottomItems dependency property.

The identifier for the BottomItems dependency property.

Gets or sets the items that can be invoked when the control is swiped from the left side.

The items that can be invoked when the control is swiped from the left side.

Identifies the LeftItems dependency property.

The identifier for the LeftItems dependency property.

Gets or sets the items that can be invoked when the control is swiped from the right side.

The items that can be invoked when the control is swiped from the right side.

Identifies the RightItems dependency property.

The identifier for the RightItems dependency property.

Gets or sets the items that can be invoked when the control is swiped from the top down.

The items that can be invoked when the control is swiped from the top down.

Identifies the TopItems dependency property.

The identifier for the TopItems dependency property.

Closes the swipe control.

Represents an individual command in a SwipeControl.

Initializes a new instance of the SwipeItem class.

Gets or sets a brush that provides the background of the control.

The brush that provides the background of the control.

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets a value that indicates how a SwipeControl behaves after this item is invoked.

A value that indicates how a SwipeControl behaves after this item is invoked. The default is **Auto**.

Identifies the BehaviorOnInvoked dependency property.

The identifier for the BehaviorOnInvoked dependency property.

Gets or sets the command to execute when this item is invoked.

The command to execute when this item is invoked. The default is **null**.

Gets or sets the parameter to pass to the Command property.

The parameter to pass to the Command property. The default is **null**.

Identifies the CommandParameter dependency property.

The identifier for the CommandParameter dependency property.

Identifies the Command dependency property.

The identifier for the Command dependency property.

Gets or sets the brush that paints the text and icon of the item.

The brush that paints the text and icon of the item.

Identifies the Foreground dependency property.

The identifier for the Foreground dependency property.

Gets or sets the graphic content of the item.

The graphic content of the item. The default is **null**.

Identifies the IconSource dependency property.

The identifier for the IconSource dependency property.

Gets or sets the text description displayed on the item.

The text description displayed on the item. The default is an empty string.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Occurs when user interaction indicates that the command represented by this item should execute.

Provides event data for the SwipeItem.Invoked event.

Gets the SwipeControl that owns the invoked item.

The SwipeControl that owns the invoked item.

Represents a collection of SwipeItem objects.

Initializes a new instance of the SwipeItems class.

Gets or sets a value that indicates the effect of a swipe interaction.

A value of the enumeration that indicates the effect of a swipe interaction. The default is **Reveal**.

Identifies the Mode dependency property.

The identifier for the Mode dependency property.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the value specified.

The index at which to set the value. The value to set.

Defines constants that specify the effect of a swipe interaction.

A swipe executes a command.

A swipe reveals a menu of commands.

Defines constants that specify a glyph from the **Segoe MDL2 Assets** font to use as the content of a SymbolIcon.

E10B <img alt="Accept icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10b.png" />

E168 <img alt="Account icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e168.png" />

E109 <img alt="Add icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e109.png" />

E1E2 <img alt="Add Friend icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e2.png" />

E1A7 <img alt="Admin icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a7.png" />

E1A1 <img alt="Align Center icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a1.png" />

E1A2 <img alt="Align Left icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a2.png" />

E1A0 <img alt="Align Right icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a0.png" />

E179 <img alt="All Apps icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e179.png" />

E16C <img alt="Attach icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16c.png" />

E12D <img alt="Attach Camera icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12d.png" />

E189 <img alt="Audio icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e189.png" />

E112 <img alt="Back icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e112.png" />

E1D8 <img alt="Back To Window icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d8.png" />

E1E0 <img alt="Block Contact icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e0.png" />

E19B <img alt="Bold icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19b.png" />

E12F <img alt="Bookmarks icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12f.png" />

E155 <img alt="Browse Photos icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e155.png" />

E133 <img alt="Bullets icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e133.png" />

E1D0 <img alt="Calculator icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d0.png" />

E163 <img alt="Calendar icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e163.png" />

E161 <img alt="Calendar Day icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e161.png" />

E1DB <img alt="Calendar Reply icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1db.png" />

E162 <img alt="Calendar Week icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e162.png" />

E114 <img alt="Camera icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e114.png" />

E10A <img alt="Cancel icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10a.png" />

E15A <img alt="Caption icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15a.png" />

E1C9 <img alt="Cell Phone icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c9.png" />

E164 <img alt="Character icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e164.png" />

E106 <img alt="Clear icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e106.png" />

E1C5 <img alt="Clear Selection icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c5.png" />

E121 <img alt="Clock icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e121.png" />

E190 <img alt="Closed Caption icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e190.png" />

E127 <img alt="Close Pane icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e127.png" />

E134 <img alt="Comment icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e134.png" />

E13D <img alt="Contact icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e13d.png" />

E187 <img alt="Contact 2 icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e187.png" />

E136 <img alt="Contact Info icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e136.png" />

E181 <img alt="Contact Presence icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e181.png" />

E16F <img alt="Copy icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16f.png" />

E123 <img alt="Crop icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e123.png" />

E16B <img alt="Cut icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16b.png" />

E107 <img alt="Delete icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e107.png" />

E1D1 <img alt="Directions icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d1.png" />

E194 <img alt="Disable Updates icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e194.png" />

E17A <img alt="Disconnect Drive icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e17a.png" />

E19E <img alt="Dislike icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19e.png" />

E147 <img alt="Dock Bottom icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e147.png" />

E145 <img alt="Dock Left icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e145.png" />

E146 <img alt="Dock Right icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e146.png" />

E130 <img alt="Document icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e130.png" />

E118 <img alt="Download icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e118.png" />

E104 <img alt="Edit icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e104.png" />

E11D <img alt="Emoji icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11d.png" />

E170 <img alt="Emoji 2 icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e170.png" />

E113 <img alt="Favorite icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e113.png" />

E16E <img alt="Filter icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16e.png" />

E11A <img alt="Find icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11a.png" />

E129 <img alt="Flag icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e129.png" />

E188 <img alt="Folder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e188.png" />

E185 <img alt="Font icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e185.png" />

E186 <img alt="Font Color icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e186.png" />

E1C6 <img alt="Font Decrease icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c6.png" />

E1C7 <img alt="Font Increase icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c7.png" />

E1C8 <img alt="Font Size icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c8.png" />

E111 <img alt="Forward icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e111.png" />

E1E9 <img alt="Four Bars icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e9.png" />

E1D9 <img alt="Full Screen icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d9.png" />

E700 <img alt="GlobalNav icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e700.png" />

E12B <img alt="Globe icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12b.png" />

E143 <img alt="Go icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e143.png" />

E1E4 <img alt="Go To Start icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e4.png" />

E184 <img alt="Go To Today icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e184.png" />

E137 <img alt="Hang Up icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e137.png" />

E11B <img alt="Help icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11b.png" />

E16A <img alt="Hide BCC icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16a.png" />

E193 <img alt="Highlight icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e193.png" />

E10F <img alt="Home icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10f.png" />

E150 <img alt="Import icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e150.png" />

E151 <img alt="Import All icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e151.png" />

E171 <img alt="Important icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e171.png" />

E199 <img alt="Italic icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e199.png" />

E144 <img alt="Keyboard icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e144.png" />

E11F <img alt="Leave Chat icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11f.png" />

E1D3 <img alt="Library icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d3.png" />

E19F <img alt="Like icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19f.png" />

E19D <img alt="Like Dislike icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19d.png" />

E167 <img alt="Link icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e167.png" />

E14C <img alt="List icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14c.png" />

E119 <img alt="Mail icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e119.png" />

E135 <img alt="Mail Filled icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e135.png" />

E120 <img alt="Mail Forward icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e120.png" />

E172 <img alt="Mail Reply icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e172.png" />

E165 <img alt="Mail Reply All icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e165.png" />

E178 <img alt="Manage icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e178.png" />

E1C4 <img alt="Map icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c4.png" />

E17B <img alt="Map Drive icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e17b.png" />

E139 <img alt="Map Pin icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e139.png" />

E1D5 <img alt="Memo icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d5.png" />

E15F <img alt="Message icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15f.png" />

E1D6 <img alt="Microphone icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d6.png" />

E10C <img alt="More icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10c.png" />

E19C <img alt="Move To Folder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19c.png" />

E142 <img alt="Music Info icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e142.png" />

E198 <img alt="Mute icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e198.png" />

E1DA <img alt="New Folder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1da.png" />

E17C <img alt="New Window icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e17c.png" />

E101 <img alt="Next icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e101.png" />

E1E6 <img alt="One Bar icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e6.png" />

E1A5 <img alt="Open File icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a5.png" />

E197 <img alt="Open Local icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e197.png" />

E126 <img alt="Open Pane icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e126.png" />

E17D <img alt="Open With icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e17d.png" />

E14F <img alt="Orientation icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14f.png" />

E1A6 <img alt="Other User icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a6.png" />

E1CE <img alt="Outline Star icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1ce.png" />

E132 <img alt="Page icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e132.png" />

E160 <img alt="Page2 icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e160.png" />

E16D <img alt="Paste icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e16d.png" />

E103 <img alt="Pause icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e103.png" />

E125 <img alt="People icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e125.png" />

E192 <img alt="Permissions icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e192.png" />

E13A <img alt="Phone icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e13a.png" />

E1D4 <img alt="Phone Book icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d4.png" />

E158 <img alt="Pictures icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e158.png" />

E141 <img alt="Pin icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e141.png" />

E18A <img alt="Placeholder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e18a.png" />

E102 <img alt="Play icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e102.png" />

E1D7 <img alt="Post Update icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d7.png" />

E295 <img alt="Preview icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e295.png" />

E12A <img alt="Preview Link icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12a.png" />

E100 <img alt="Previous icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e100.png" align="top" />

E749 <img alt="Print icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e749.png" />

E182 <img alt="Priority icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e182.png" />

E131 <img alt="Protected Document icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e131.png" />

E166 <img alt="Read icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e166.png" />

E10D <img alt="Redo icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10d.png" />

E149 <img alt="Refresh icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e149.png" />

E148 <img alt="Remote icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e148.png" />

E108 <img alt="Remove icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e108.png" />

E13E <img alt="Rename icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e13e.png" />

E15E <img alt="Repair icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15e.png" />

E1CD <img alt="Repeat All icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1cd.png" />

E1CC <img alt="Repeat 1 icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1cc.png" />

E1DE <img alt="Report Hacked icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1de.png" />

E1CA <img alt="Reshare icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1ca.png" />

E14A <img alt="Rotate icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14a.png" />

E124 <img alt="Rotate Camera icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e124.png" />

E105 <img alt="Save icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e105.png" />

E159 <img alt="Save Local icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e159.png" />

E294 <img alt="Scan icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e294.png" />

E14E <img alt="Select All icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14e.png" />

E122 <img alt="Send icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e122.png" />

E18C <img alt="Set Lock Screen icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e18c.png" />

E18D <img alt="Set Tile icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e18d.png" />

E115 <img alt="Setting icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e115.png" />

E72D <img alt="Share icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e72d.png" />

E14D <img alt="Shop icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14d.png" />

E169 <img alt="Show BCC icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e169.png" />

E15C <img alt="Show Results icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15c.png" />

E14B <img alt="Shuffle icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e14b.png" />

E173 <img alt="Slide Show icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e173.png" />

E1CF <img alt="Solid Star icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1cf.png" />

E174 <img alt="Sort icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e174.png" />

E15B <img alt="Stop icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15b.png" />

E191 <img alt="Stop Slide Show icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e191.png" />

E1C3 <img alt="Street icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1c3.png" />

E13C <img alt="Switch icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e13c.png" />

E1E1 <img alt="Switch Apps icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e1.png" />

E117 <img alt="Sync icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e117.png" />

E1DF <img alt="Sync Folder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1df.png" />

E1CB <img alt="Tag icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1cb.png" />

E1D2 <img alt="Target icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1d2.png" />

E1E8 <img alt="Three Bars icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e8.png" />

E1E3 <img alt="Touch Pointer icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e3.png" />

E12C <img alt="Trim icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12c.png" />

E1E7 <img alt="Two Bars icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e7.png" />

E11E <img alt="Two Page icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11e.png" />

E19A <img alt="Underline icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e19a.png" />

E10E <img alt="Undo icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e10e.png" />

E195 <img alt="Unfavorite icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e195.png" />

E196 <img alt="UnPin icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e196.png" />

E1DD <img alt="Unsync Folder icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1dd.png" />

E110 <img alt="Up icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e110.png" />

E11C <img alt="Upload icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e11c.png" />

E116 <img alt="Video icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e116.png" />

E13B <img alt="Video Chat icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e13b.png" />

E18B <img alt="View icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e18b.png" />

E138 <img alt="View All icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e138.png" />

E15D <img alt="Volume icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e15d.png" />

E156 <img alt="Web Cam icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e156.png" />

E128 <img alt="World icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e128.png" />

E990 <img alt="Xbox icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e990.png" />

E1E5 <img alt="Zero Bars icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1e5.png" />

E1A3 <img alt="Zoom icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a3.png" />

E12E <img alt="Zoom In icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e12e.png" />

E1A4 <img alt="Zoom Out icon" src="./windows.ui.xaml.controls/images/segoe-mdl/e1a4.png" />

Represents an icon that uses a glyph from the Segoe MDL2 Assets font as its content.

Initializes a new instance of the SymbolIcon class.

Initializes a new instance of the SymbolIcon class using the specified symbol.

A named constant of the enumeration that specifies the Segoe MDL2 Assets glyph to use. The default is **null**.

Gets or sets the Segoe MDL2 Assets glyph used as the icon content.

A named constant of the numeration that specifies the Segoe MDL2 Assets glyph to use.

Identifies the Symbol dependency property.

The identifier for the Symbol dependency property.

Represents an icon source that uses a glyph from the Segoe MDL2 Assets font as its content.

Initializes a new instance of the SymbolIconSource class.

Gets or sets the Segoe MDL2 Assets glyph used as the icon content.

A named constant of the numeration that specifies the Segoe MDL2 Assets glyph to use.

Identifies the Symbol dependency property.

The identifier for the Symbol dependency property.

Provides a lightweight control for displaying small amounts of text.

Initializes a new instance of the TextBlock class.

Returns a value by which each line of text is offset from a baseline.

The amount by which each line of text is offset from the baseline, in device independent pixels. System.Double.NaN indicates that an optimal baseline offset is automatically calculated from the current font characteristics. The default is System.Double.NaN.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Identifies the CharacterSpacing dependency property.

The identifier for the CharacterSpacing dependency property.

Gets a TextPointer object for the end of text content in the TextBlock.

A TextPointer object for the end of text content in the TextBlock.

Gets a TextPointer object for the start of text content in the TextBlock.

A TextPointer object for the start of text content in the TextBlock.

Gets or sets the preferred top-level font family for the text content in this element.

A FontFamily object that specifies the preferred font family, or a primary preferred font family with one or more fallback font families. For information about defaults, see the FontFamily class topic.

Identifies the FontFamily  dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the font size for the text content in this element.

A non-negative value that specifies the font size, measured in pixels. The default is 11.

Identifies the FontSize  dependency property.

The identifier for the FontSize dependency property.

Gets or sets the font stretch for the text content in this element.

The requested font stretch, as a FontStretch constant. The default is Normal.

Identifies the FontStretch  dependency property.

The identifier for the FontStretch dependency property.

Gets or sets the font style for the content in this element.

The requested font style, which is a FontStyle enumeration value. The default is Normal.

Identifies the FontStyle  dependency property.

The identifier for the FontStyle dependency property.

Gets or sets the top-level font weight for the TextBlock.

The requested font weight, which is a FontWeight that is obtained from one of the FontWeights property values. The default is Normal.

Identifies the FontWeight  dependency property.

The identifier for the FontWeight dependency property.

Gets or sets the Brush to apply to the text contents of the TextBlock.

The brush used to apply to the text content. The default is a null brush from a pure code perspective, but the default text styles set this to Black (for **Light** theme) or White (for **Dark** theme) for a TextBlock element in UI.

Identifies the Foreground  dependency property.

The identifier for the Foreground dependency property.

Gets or sets a value that indicates how text is aligned in the TextBlock.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the HorizontalTextAlignment dependency property.

The identifier for the HorizontalTextAlignment dependency property.

Gets the collection of inline text elements within a TextBlock.

A collection that holds all inline text elements from the TextBlock. The default is an empty collection.

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

**true** if color glyphs show in color; otherwise, **false**. The default is **true**.

Identifies the IsColorFontEnabled dependency property.

The identifier for the IsColorFontEnabled dependency property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets a value that indicates whether text selection is enabled in the TextBlock, either through user action or calling selection-related API.

**true** if text selection is enabled; otherwise, **false**.

Identifies the IsTextSelectionEnabled dependency property.

The identifier for the IsTextSelectionEnabled dependency property.

Gets a value that indicates whether the control has trimmed text that overflows the content area.

**true** if text is trimmed; otherwise, **false**.

Identifies the IsTextTrimmed dependency property.

The identifier for the IsTextTrimmed dependency property.

Gets or sets the height of each line of content.

The height of each line in pixels. A value of 0 indicates that the line height is determined automatically from the current font characteristics. The default is 0.

Identifies the LineHeight  dependency property.

The identifier for the LineHeight dependency property.

Gets or sets a value that indicates how a line box is determined for each line of text in the TextBlock.

A value that indicates how a line box is determined for each line of text in the TextBlock. The default is **MaxHeight**.

Identifies the LineStackingStrategy  dependency property.

The identifier for the LineStackingStrategy dependency property.

Gets or sets the maximum number of lines of text shown in the TextBlock.

The maximum number of lines of text shown in the TextBlock. The default is 0, which is a special value that represents "Auto" behavior. The value cannot be negative.

Identifies the MaxLines dependency property.

The identifier for the MaxLines dependency property.

Get or sets a value that indicates how the font is modified to align with fonts of different sizes.

A value of the enumeration that indicates how the font is modified to align at different sizes. The default is **None**.

Identifies the OpticalMarginAlignment dependency property.

The identifier for the OpticalMarginAlignment dependency property.

Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a TextBlock.

A Thickness structure that specifies the amount of padding to apply.

Identifies the Padding  dependency property.

The identifier for the Padding dependency property.

Gets a text range of selected text.

A text range of the selected text.

Identifies the SelectedText dependency property.

The identifier for the SelectedText dependency property.

Gets the end position of the text selected in the TextBlock.

An object that represents the selection end, or null if no selection exists.

Gets or sets the flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown.

The flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown. The default is an instance of TextCommandBarFlyout.

Identifies the SelectionFlyout dependency property.

The identifier for the SelectionFlyout dependency property.

Gets or sets the brush used to highlight the selected text.

The brush used to highlight the selected text. The default is a null brush from a pure code perspective, but the system uses base text styles to supply a runtime value for apps (unless you specifically override that style). The practical default is a brush using the theme resource **TextSelectionHighlightThemeColor**.

Identifies the SelectionHighlightColor dependency property.

The identifier for the SelectionHighlightColor dependency property.

Gets the starting position of the text selected in the TextBlock.

An object that represents the selection start, or null if no selection exists.

Gets or sets the text contents of a TextBlock.

A string that specifies the text contents of this TextBlock. The default is an empty string.

Gets or sets a value that indicates the horizontal alignment of text content.

The text alignment. The default is **Left**.

Identifies the TextAlignment  dependency property.

The identifier for the TextAlignment dependency property.

Gets or sets a value that indicates what decorations are applied to the text.

A value of the enumeration. The default is **None**.

Identifies the **TextDecorations** dependency property.

The identifier for the **TextDecorations** dependency property.

Gets the collection of text highlights.

The collection of text highlights.

Gets or sets a value that indicates how the line box height is determined for each line of text in the TextBlock.

A value that indicates how the line box height is determined for each line of text in the TextBlock. The default is **Full**.

Identifies the TextLineBounds dependency property.

The identifier for the TextLineBounds dependency property.

Identifies the Text  dependency property.

The identifier of the Text dependency property.

Gets or sets a value that indicates how the reading order is determined for the TextBlock.

A value that indicates how the reading order is determined for the TextBlock. The default is **DetectFromContent**.

Identifies the TextReadingOrder dependency property.

The identifier for the TextReadingOrder dependency property.

Gets or sets the text trimming behavior to employ when content overflows the content area.

One of the TextTrimming values that specifies the text trimming behavior to employ. The default is **None**.

Identifies the TextTrimming dependency property.

The identifier of the TextTrimming dependency property.

Gets or sets how the TextBlock wraps text.

A value that indicates how the TextBlock wraps text. The default is **NoWrap**.

Identifies the TextWrapping  dependency property.

The identifier of the TextWrapping dependency property.

Occurs when the system processes an interaction that displays a context menu.

Occurs when the IsTextTrimmed property value has changed.

Occurs when the text selection has changed.

Copies the selected content to the Windows clipboard.

Focuses the TextBlock, as if it were a conventionally focusable control.

Specifies the desired target for focus state, as a value of the enumeration. **true** if focus was set to the TextBlock, or focus was already there. **false** if the TextBlock is not focusable.

Returns a mask that represents the alpha channel of the text as a CompositionBrush.

A mask that represents the alpha channel of the text in a TextBlock.

Selects a range of text in the TextBlock.

An object that represents the start of the range to select. An object that represents the end of the range to select.

Selects the entire contents in the TextBlock.

Represents a control that can be used to display and edit plain text (single or multi-line).

Initializes a new instance of the TextBox class.

Gets or sets the value that determines whether the text box allows and displays the newline or return characters.

**true** if the text box allows newline characters; otherwise, **false**. The default is **false**.

Identifies the AcceptsReturn dependency property.

The identifier for the AcceptsReturn dependency property.

Gets a value that indicates whether clipboard content can be pasted into the control.

**true** if clipboard content can be pasted into the control; otherwise, **false**.

Identifies the CanPasteClipboardContent dependency property.

The identifier for the CanPasteClipboardContent dependency property.

Gets a value that indicates whether the redo buffer contains an action that can be redone.

**true** if the redo buffer contains an action that can be redone; otherwise, **false**.

Identifies the CanRedo dependency property.

The identifier for the CanRedo dependency property.

Gets a value that indicates whether the undo buffer contains an action that can be undone.

**true** if the undo buffer contains an action that can be undone; otherwise, **false**.

Identifies the CanUndo dependency property.

The identifier for the CanUndo dependency property.

Gets or sets a value that indicates how the control modifies the case of characters as they are typed.

A value of the enumeration that indicates how the control modifies the case of characters as they are typed. The default is **Normal**, which indicates that the charcters are not changed.

Identifies the CharacterCasing dependency property.

The identifier for the CharacterCasing dependency property.

Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control.

The content to be displayed below the control. The default is **null**.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets a value that indicates the preferred alignment of the Input Method Editor (IME).

A value of the enumeration that indicates the preferred alignment of the Input Method Editor (IME). The default is **Default**.

Identifies the DesiredCandidateWindowAlignment dependency property.

The identifier for the DesiredCandidateWindowAlignment dependency property.

Gets or sets the HandwritingView associated with this text control.

The HandwritingView associated with this text control.

Identifies the HandwritingView dependency property.

The identifier for the HandwritingView dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that indicates how text is aligned in the TextBox.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the HorizontalTextAlignment dependency property.

The identifier for the HorizontalTextAlignment dependency property.

Gets or sets the context for input used by this TextBox.

The input scope, which provides a hint at the type of text input expected by the control.

Identifies the InputScope dependency property.

The identifier for the InputScope dependency property.

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

**true** if color glyphs show in color; otherwise, **false**. The default is **true**.

Identifies the IsColorFontEnabled dependency property.

The identifier for the IsColorFontEnabled dependency property.

Gets or sets a value that indicates whether a user can enter text in the handwriting view.

**true** to allow the user to enter text in the handwriting view; otherwise, **false**.

Identifies the IsHandwritingViewEnabled dependency property.

The identifier for the IsHandwritingViewEnabled dependency property.

Gets or sets the value that determines if the user can change the text in the text box.

**true** if the text box is read-only; otherwise, **false**. The default is **false**.

Identifies the IsReadOnly dependency property.

The identifier for the IsReadOnly dependency property.

Gets or sets a value that specifies whether the TextBox input interacts with a spell check engine.

**true** if the TextBox input interacts with a spell check engine; otherwise, **false**. The default is **true**.

Identifies the IsSpellCheckEnabled dependency property.

The identifier for the IsSpellCheckEnabled dependency property.

Gets or sets a value that determines whether text prediction features ("autocomplete") should be enabled for this TextBox.

**true** to enable text prediction features, otherwise, **false**. The default is **true**.

Identifies the IsTextPredictionEnabled dependency property.

The identifier for the IsTextPredictionEnabled dependency property.

Gets or sets the value that specifies the maximum number of characters allowed for user input.

The maximum number of characters allowed for user input. The default is 0 (no limit).

Identifies the MaxLength dependency property.

The identifier for the MaxLength dependency property.

Gets or sets a brush that describes the color of placeholder text.

The brush that describes the color of placeholder text.

Identifies the PlaceholderForeground dependency property.

The identifier for the PlaceholderForeground dependency property.

Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation.

The text that is displayed in the control when no value is entered. The default is an empty string ("").

Identifies the PlaceholderText dependency property.

The identifier for the PlaceholderText dependency property.

Gets or sets a value that indicates whether the on-screen keyboard is shown when the control receives focus programmatically.

**true** if the on-screen keyboard is not shown when the control receives focus programmatically; otherwise, **false**. The default is **false**.

Identifies the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

The identifier for the PreventKeyboardDisplayOnProgrammaticFocus dependency property.

Gets the flyout that shows proofing commands.

The flyout that shows proofing commands.

Identifies the ProofingMenuFlyout dependency property.

The identifier for the ProofingMenuFlyout dependency property.

Gets or sets the content of the current selection in the text box.

The currently selected text in the text box. If no text is selected, the value is String.Empty.

Gets or sets the flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown.

The flyout that is shown when text is selected using touch or pen, or **null** if no flyout is shown. The default is an instance of TextCommandBarFlyout.

Identifies the SelectionFlyout dependency property.

The identifier for the SelectionFlyout dependency property.

Gets or sets the brush used to highlight the selected text.

The brush used to highlight the selected text. The practical default is a brush using the theme resource **TextSelectionHighlightThemeColor**.

Identifies the SelectionHighlightColor dependency property.

The identifier for the SelectionHighlightColor dependency property.

Gets or sets the brush used to highlight the selected text when the TextBox does not have focus.

The brush used to highlight the selected text when TextBox loses focus. The default is a null brush from a pure code perspective, but the default control template for TextBox applies a Transparent brush for this in a runtime instance of a TextBox control. To disable the SelectionHighlightColorWhenNotFocused, set the brush to Transparent once again.

Identifies the **SelectionHighlightColorWhenNotFocused** dependency property.

The identifier for the **SelectionHighlightColorWhenNotFocused** dependency property.

Gets or sets the number of characters in the current selection in the text box.

The number of characters in the current selection in the text box, or 0 if there is no selection.

Gets or sets the starting position of the text selected in the text box. When the SelectionLength is 0 (there is no selected text), the SelectionStart property corresponds to the cursor position.

The starting position of the current selection or the current cursor position.

Gets or sets the text contents of the text box.

A string containing the text contents of the text box. The default is an empty string ("").

Gets or sets how the text should be horizontally aligned in the text box.

One of the TextAlignment enumeration values. The default is **Left**.

Identifies the TextAlignment dependency property.

The identifier for the TextAlignment dependency property.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Gets or sets a value that indicates how the reading order is determined for the TextBox.

A value that indicates how the reading order is determined for the TextBox. The default is **DetectFromContent**.

Identifies the TextReadingOrder dependency property.

The identifier for the TextReadingOrder dependency property.

Gets or sets how line breaking occurs if a line of text extends beyond the available width of the text box.

One of the TextWrapping values. The default is **NoWrap**.

Identifies the TextWrapping dependency property.

The identifier for the TextWrapping dependency property.

Occurs synchronously when the text in the text box starts to change, but before the **Text** property is updated.

Occurs when the Input Method Editor (IME) window open, updates, or closes.

Occurs when the system processes an interaction that displays a context menu.

Occurs before copied text is moved to the clipboard.

Occurs before cut text is moved to the clipboard.

Occurs when text is pasted into the control.

Occurs when the text selection has changed.

Occurs when the text selection starts to change.

Occurs when content changes in the text box.

Occurs synchronously when the text in the text box starts to change, but before it is rendered.

Occurs when text being composed through an Input Method Editor (IME) changes.

Occurs when a user stops composing text through an Input Method Editor (IME).

Occurs when a user starts composing text through an Input Method Editor (IME).

Empties the undo and redo buffers.

Copies the selected content to the Windows clipboard.

Moves the selected content to the Windows clipboard and removes it from the text control.

Asynchronously gets a list of candidate words based on the provided phonetic characters in an Input Method Editor (IME).

A list of candidate words based on the provided phonetic characters in an Input Method Editor (IME).

Returns a rectangular region for the leading or trailing edge of a character at a specific character index.

A zero-based index of the character for which to retrieve the rectangle. **true** to get the trailing edge; **false** to get the leading edge of the character. A rectangle for the edge of the character at the specified index.

Copies content from the Windows clipboard into the text control.

Reapplies the first action in the redo buffer.

Selects a range of text in the text box.

The zero-based index of the first character in the selection. The length of the selection, in characters.

Selects the entire contents of the text box.

Undoes the first action in the undo buffer.

Provides event data for the TextBox.BeforeTextChanging event.

Gets or sets a value that indicates whether to cancel the text changes.

**true** to cancel the text changes; otherwise, **false**. The default is **false**.

Gets the new text that is entered into the text box.

The new text value that is entered into the text box.

Provides event data for the TextBox.SelectionChanging event.

Gets or sets a value that indicates whether the selection operation should be canceled.

**true** to cancel the selection operation; otherwise, **false**. The default is **false**.

Gets the length of the text selection.

The length of the text selection.

Gets the starting index of the text selection.

The starting index of the text selection.

Provides event data for the TextBox.TextChanging event.

Gets a value that indicates whether the event occured due to a change in the text content.

**true** if a change to the text content caused the event; otherwise, **false**.

Provides data for the TextChanged event.

Represents the method that will handle the TextChanged event.

The object where the event handler is attached. The event data.

Represents a specialized command bar flyout that contains commands for editing text.

Initializes a new instance of the TextCommandBarFlyout class.

Provides event data for the TextCompositionChanged event on TextBox and RichEditBox.

Gets the length of the portion of the text that the user is composing with an Input Method Editor (IME).

The length of the portion of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Gets the starting location of the text that the user is composing with an Input Method Editor (IME).

The starting location of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Provides event data for the TextCompositionEnded event on TextBox and RichEditBox.

Gets the length of the portion of the text that the user is composing with an Input Method Editor (IME).

The length of the portion of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Gets the starting location of the text that the user is composing with an Input Method Editor (IME).

The starting location of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Provides event data for the TextCompositionStarted event on TextBox and RichEditBox.

Gets the length of the portion of the text that the user is composing with an Input Method Editor (IME).

The length of the portion of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Gets the starting location of the text that the user is composing with an Input Method Editor (IME).

The starting location of the text that the user is composing with an [Input Method Editor (IME)](https://docs.microsoft.com/previous-versions/windows/apps/hh967427(v=win.10)).

Provides event data for the **CopyingToClipboard** event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which causes the default copy action to be performed. The default is **false**.

Provides event data for the **CuttingToClipboard** event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which causes the default cut action to be performed. The default is **false**.

Provides data for the text control **Paste** event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Represents the method that will handle a **Paste** event.

The object where the handler is attached. Event data for the event.

Provides data for the TimePicked event.

Initializes a new instance of the TimePickedEventArgs class.

Gets the time that was selected by the user.

The time that was selected by the user.

Gets the old time value.

The old time value.

Represents a control that allows a user to pick a time value.

Initializes a new instance of the TimePicker class.

Gets or sets the clock system to use.

The name of the clock system to use. See Remarks.

Gets the identifier for the ClockIdentifier dependency property.

The identifier for the ClockIdentifier dependency property.

Gets or sets the content for the control's header.

The content of the control's header. The default is **null**.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the content of the control's header.

The template that specifies the visualization of the header object. The default is **null**.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets a value that indicates the time increments shown in the minute picker. For example, 15 specifies that the TimePicker minute control displays only the choices 00, 15, 30, 45.

An integer from 0-59 that indicates the increments shown in the minute picker. The default is 1.

Gets the identifier for the MinuteIncrement dependency property.

The identifier for the MinuteIncrement dependency property.

Gets or sets the time currently selected in the time picker.

The time currently selected in the time picker.

Identifies the SelectedTime dependency property.

The identifier for the SelectedTime dependency property.

Gets or sets the time currently set in the time picker.

The time currently set in the time picker.

Gets the identifier for the Time dependency property.

The identifier for the Time dependency property.

Occurs when the selected time value is changed.

Occurs when the time value is changed.

Represents a control that allows a user to pick a time value.

Initializes a new instance of the TimePickerFlyout class.

Gets or sets the clock system to use.

The name of the clock system to use.

Gets the identifier for the ClockIdentifier dependency property.

The identifier for the ClockIdentifier dependency property.

Gets or sets a value that indicates the time increments shown in the minute picker. For example, 15 specifies that minute picker displays only the choices 00, 15, 30, 45.

An integer from 0-59 that indicates the increments shown in the minute picker. The default is 1.

Gets the identifier for the MinuteIncrement dependency property.

The identifier for the MinuteIncrement dependency property.

Gets or sets the time currently set in the time picker.

The time currently set in the time picker.

Gets the identifier for the Time dependency property.

The identifier for the Time dependency property.

Occurs when the user has selected a time in the time picker flyout.

Begins an asynchronous operation to show the flyout placed in relation to the specified element.

The element to use as the flyout's placement target. An asynchronous operation.

Represents the visual container for the TimePickerFlyout.

Gets or sets a value that indicates whether the default shadow effect is shown.

**true** if the default shadow effect is shown; otherwise, **false**. The default is **true**.

Identifies the IsDefaultShadowEnabled dependency property.

The identifier for the IsDefaultShadowEnabled dependency property.

Provides event data for the TimePicker.SelectedTimeChanged event.

Gets the new time selected in the picker.

The new time selected in the picker.

Gets the time previously selected in the picker.

The time previously selected in the picker.

Provides event data for the TimePicker.TimeChanged event.

Gets the new time selected in the picker.

The new time selected in the picker.

Gets the time previously selected in the picker.

The time previously selected in the picker.

Represents an item in a MenuFlyout that a user can change between two states, checked or unchecked.

Initializes a new instance of the ToggleMenuFlyoutItem class.

Gets or sets whether the ToggleMenuFlyoutItem is checked.

**true** if the ToggleMenuFlyoutItem is checked; **false** if the ToggleMenuFlyoutItem is unchecked. The default is **false**.

Identifies the IsChecked dependency property.

The identifier for the IsChecked dependency property.

Represents a button with two parts that can be invoked separately. One part behaves like a toggle button and the other part invokes a flyout.

Initializes a new instance of the ToggleSplitButton class.

Gets or sets whether the ToggleSplitButton is checked.

**true** if the ToggleSplitButton is checked; **false** if the ToggleSplitButton is unchecked. The default is **false**.

Occurs when the value of the IsChecked property is changed.

Exposes ToggleSplitButton types to Microsoft UI Automation.

Initializes a new instance of the ToggleSplitButtonAutomationPeer class.

The ToggleSplitButton control instance to create the peer for.

Gets the state, expanded or collapsed, of the control.

A value of the enumeration.

Gets the toggle state of the control.

A value of the enumeration.

Hides the control's drop down menu.

Displays the control's drop down menu.

Cycles through the toggle states of a control.

Provides event data for the ToggleSplitButton.IsCheckedChanged event.

Represents a switch that can be toggled between two states.

Initializes a new instance of the ToggleSwitch class.

Gets or sets the header content.

The header content for the ToggleSwitch.

Identifies the Header dependency property.

The identifier for the Header dependency property.

Gets or sets the DataTemplate used to display the control's header.

The DataTemplate used to display the control's header.

Identifies the HeaderTemplate dependency property.

The identifier for the HeaderTemplate dependency property.

Gets or sets a value that declares whether the state of the ToggleSwitch is "On".

**true** if the state is "On"; **false** if the state is "Off".

Identifies the IsOn dependency property.

The identifier for the IsOn dependency property.

Provides the object content that should be displayed using the OffContentTemplate when this ToggleSwitch has state of "Off".

The object content. In some cases this is a string, in other cases it is a single element that provides a root for further composition content. Probably the most common "set" usage is to place a binding here.

Identifies the OffContent dependency property.

The identifier for the OffContent dependency property.

Gets or sets the DataTemplate used to display the control's content while in "Off" state.

The DataTemplate that displays the control's content while in "Off" state.

Identifies the OffContentTemplate dependency property.

The identifier for the OffContentTemplate dependency property.

Provides the object content that should be displayed using the OnContentTemplate when this ToggleSwitch has state of "On".

The object content. In some cases this is a string, in other cases it is a single element that provides a root for further composition content. Probably the most common "set" usage is to place a binding here.

Identifies the OnContent dependency property.

The identifier for the OnContent dependency property.

Gets or sets the DataTemplate used to display the control's content while in "On" state.

The DataTemplate that displays the control's content while in "On" state.

Identifies the OnContentTemplate dependency property.

The identifier for the OnContentTemplate dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a ToggleSwitch control.

An object that provides calculated values for templates.

Occurs when "On"/"Off" state changes for this ToggleSwitch.

Invoked when the content for Header changes.

The string or object content of the old content. The string or object content of the new content.

Invoked when the content for OffContent changes.

The string or object content of the old content. The string or object content of the new content that is about to display.

Invoked when the content for OnContent changes.

The string or object content of the old content. The string or object content of the new content that is about to display.

Invoked before the Toggled event is raised.

Represents a control that creates a pop-up window that displays information for an element in the UI.

Initializes a new instance of the ToolTip class.

Gets or sets the horizontal distance between the target origin and the pop-up alignment point.

The horizontal distance between the target origin and the pop-up alignment point. The default is 0.

Identifies the HorizontalOffset  dependency property.

The identifier for the HorizontalOffset  dependency property.

Gets or sets a value that indicates whether the ToolTip is visible.

**true** if the ToolTip is visible; otherwise, **false**. The default is **false**.

Identifies the IsOpen  dependency property.

The identifier for the IsOpen  dependency property.

Gets or sets how a ToolTip is positioned in relation to the placement target element.

One of the PlacementMode values.

Identifies the Placement dependency property.

The identifier for the Placement dependency property.

Gets or sets the rectangular area that the tooltip should be positioned in relation to when opened by the ToolTipService. If space allows, the open tooltip will not occlude the area defined by its PlacementRect.

The rectangular area that the tooltip is positioned in relation to when opened by the ToolTipService. The default is **null**.

Identifies the PlacementRect dependency property.

The identifier for the PlacementRect dependency property.

Gets or sets the visual element or control that the tool tip should be positioned in relation to when opened by the ToolTipService.

The visual element or control that the tool tip is positioned in relation to when opened by the ToolTipService. The default is **null**.

Identifies the PlacementTarget dependency property.

The identifier for the PlacementTarget dependency property.

Gets an object that provides calculated values that can be referenced as **TemplateBinding** sources when defining templates for a ToolTip.

An object that provides calculated values for templates.

Gets or sets the vertical distance between the target origin and the pop-up alignment point.

The vertical distance between the target origin and the pop-up alignment point. The default is 0.

Identifies the VerticalOffset  dependency property.

The identifier for the VerticalOffset  dependency property.

Occurs when a ToolTip is closed and is no longer visible.

Occurs when a ToolTip becomes visible.

Represents a service that provides static methods to display a ToolTip.

Identifies the ToolTipService.Placement XAML attached property.

The identifier for the ToolTipService.Placement XAML attached property.

Identifies the ToolTipService.PlacementTarget XAML attached property.

The identifier for the ToolTipService.PlacementTarget XAML attached property.

Identifies the ToolTipService.ToolTip XAML attached property.

The identifier for the ToolTipService.ToolTip XAML attached property.

Gets the ToolTipService.Placement XAML attached property value for the specified target element.

The target element for the attached property value. The relative position of the specified tooltip.

Gets the ToolTipService.PlacementTarget XAML attached property value for the specified target element.

The target element for the attached property value. The visual element that the tooltip is positioned relative to.

Gets the value of the ToolTipService.ToolTip XAML attached property for an object.

The object from which the property value is read. The object's tooltip content.

Sets the ToolTipService.Placement XAML attached property value for the specified target element.

The target element for the attached property value. One of the PlacementMode values, which specifies where the tooltip should appear relative to the control that is the placement target.

Sets the ToolTipService.PlacementTarget XAML attached property value for the specified target element.

The target element for the attached property value. The visual element that should be the placement target for the tooltip.

Sets the value of the ToolTipService.ToolTip XAML attached property.

The object to set tooltip content on. The value to set for tooltip content.

Represents a hierarchical list with expanding and collapsing nodes that contain nested items.

Initializes a new instance of the TreeView control.

Gets or sets a value that indicates whether items in the view can be dragged as data payload.

**true** if items in the view can be dragged as data payload; otherwise, **false**. The default is **false**.

Identifies the CanDragItems dependency property.

The identifier for the CanDragItems dependency property.

Gets or sets a value that indicates whether items in the view can be reordered through user interaction.

**true** if items in the view can be reordered through user interaction; otherwise, **false**. The default is **false**.

Identifies the CanReorderItems dependency property.

The identifier for the CanReorderItems dependency property.

Gets or sets the style that is used when rendering the item containers.

The style applied to the item containers. The default is **null**.

Identifies the ItemContainerStyle dependency property.

The identifier for the ItemContainerStyle dependency property.

Gets or sets a reference to a custom StyleSelector logic class. The StyleSelector returns different Style values to use for the item container based on characteristics of the object being displayed.

A custom StyleSelector logic class.

Identifies the ItemContainerStyleSelector dependency property.

The identifier for the ItemContainerStyleSelector dependency property.

Gets or sets the collection of Transition style elements that apply to the item containers of a TreeView.

The collection of Transition style elements that apply to the item containers of an ItemsControl.

Identifies the ItemContainerTransitions dependency property.

The identifier for the ItemContainerTransitions dependency property.

Gets or sets an object source used to generate the content of the TreeView.

The object that is used to generate the content of the TreeView. The default is **null**.

Identifies the ItemsSource dependency property.

The identifier for the ItemsSource dependency property.

Gets or sets the DataTemplate used to display each item.

The template that specifies the visualization of the data objects. The default is **null**.

Identifies the ItemTemplate dependency property.

The identifier for the ItemTemplate dependency property.

Gets or sets a reference to a custom DataTemplateSelector logic class. The DataTemplateSelector referenced by this property returns a template to apply to items.

A reference to a custom DataTemplateSelector logic class.

Identifies the ItemTemplateSelector dependency property.

The identifier for the ItemTemplateSelector dependency property.

Gets or sets the collection of root nodes of the tree.

The collection of root nodes of the tree.

Gets or sets the collection of nodes that are selected in the tree.

The collection of nodes that are selected in the tree. The default is an empty collection.

Gets or sets the selection behavior for a TreeView instance.

An enumeration value that specifies the selection behavior for a TreeView. The default is **Single** selection.

Identifies the SelectionMode dependency property.

The identifier for the SelectionMode dependency property.

Occurs when a node in the tree is collapsed.

Occurs when a drag operation that involves one of the items in the view is ended.

Occurs when a drag operation that involves one of the items in the view is initiated.

Occurs when a node in the tree starts to expand.

Occurs when an item in the tree is invoked.

Collapses the specified node in the tree.

The tree node to collapse.

Returns the container corresponding to the specified item.

The item to retrieve the container for. A container that corresponds to the specified item, if the item has a container and exists in the collection; otherwise, **null**.

Returns the container corresponding to the specified node.

The node to retrieve the container for. A container that corresponds to the specified node, if the node has a container and exists in the collection; otherwise, **null**.

Expands the specified node in the tree.

The tree node to expand.

Returns the item that corresponds to the specified, generated container.

The DependencyObject that corresponds to the item to be returned. The contained item, or the container if it does not contain an item.

Returns the TreeViewNode corresponding to the specified container.

The container to retrieve the TreeViewNode for. The node that corresponds to the specified container.

Selects all nodes in the tree.

Provides event data for the TreeView.Collapsed event.

Gets the TreeView item that is collapsed.

The TreeView item that is collapsed.

Gets the TreeView node that is collapsed.

The TreeView node that is collapsed.

Provides event data for the TreeView.DragItemsCompleted event.

Gets a value that indicates what operation was performed on the dragged data, and whether it was successful.

A value of the enumeration that indicates what operation was performed on the dragged data.

Gets the loosely typed collection of objects that are selected for the item drag action.

A loosely typed collection of objects.

Provides event data for the TreeView.DragItemsStarting event.

Gets or sets a value that indicates whether the item drag action should be canceled.

**true** to cancel the item drag action; otherwise, **false**.

Gets the data payload associated with an items drag action.

The data payload.

Gets the loosely typed collection of objects that are selected for the item drag action.

A loosely typed collection of objects.

Provides event data for the TreeView.Expanding event.

Gets the data item for the tree view node that is expanding.

The data item for the tree view node that is expanding.

Gets the tree view node that is expanding.

The tree view node that is expanding.

Represents the container for an item in a TreeView control.

Initializes a new instance of the TreeViewItem control.

Gets or sets the glyph to show for a collapsed tree node.

The glyph to show for a collapsed tree node.

Identifies the CollapsedGlyph dependency property.

The identifier for the CollapsedGlyph dependency property.

Gets or sets the glyph to show for an expanded tree node.

The glyph to show for an expanded tree node.

Identifies the ExpandedGlyph dependency property.

The identifier for the ExpandedGlyph dependency property.

Gets or sets the Brush used to paint node glyphs on a TreeView.

The Brush used to paint node glyphs on a TreeView.

Identifies the GlyphBrush dependency property.

The identifier for the GlyphBrush dependency property.

Gets or sets the opacity of node glyphs on a TreeView.

The opacity of node glyphs on a TreeView.

Identifies the GlyphOpacity dependency property.

The identifier for the GlyphOpacity dependency property.

Gets or sets the size of node glyphs on a TreeView.

The opacity of size glyphs on a TreeView.

Identifies the GlyphSize dependency property.

The identifier for the GlyphSize dependency property.

Gets or sets a value that indicates whether the current item has child items that haven't been shown.

**true** of the current item has child items that haven't been shown; otherwise, **false**.

Identifies the HasUnrealizedChildren dependency property.

The identifier for the HasUnrealizedChildren dependency property.

Gets or sets a value that indicates whether a tree node is expanded.

**true** if the tree node is expanded; otherwise, **false**.

Identifies the IsExpanded dependency property.

The identifier for the IsExpanded dependency property.

Gets or sets an object source used to generate the content of the TreeView.

The object that is used to generate the content of the TreeViewItem. The default is **null**.

Identifies the ItemsSource dependency property.

The identifier for the ItemsSource dependency property.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for a TreeViewItem control.

An object that provides calculated values for templates.

Identifies the TreeViewItemTemplateSettings dependency property.

The identifier for the TreeViewItemTemplateSettings dependency property.

Provides event data for the TreeView.ItemInvoked event.

Gets or sets a value that marks the routed event as handled. A **true** value for prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the TreeView item that is invoked.

The TreeView item that is invoked.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a TreeViewItem control. Not intended for general use.

Initializes a new instance of the TreeViewItemTemplateSettings class.

Gets the visibilty of a collapsed glyph.

The visibilty of a collapsed glyph.

Identifies the CollapsedGlyphVisibility dependency property.

The identifier for the CollapsedGlyphVisibility dependency property.

Gets the number of items being dragged.

The number of items being dragged.

Identifies the DragItemsCount dependency property.

The identifier for the DragItemsCount dependency property.

Gets the visibilty of an expanded glyph.

The visibilty of an expanded glyph.

Identifies the ExpandedGlyphVisibility dependency property.

The identifier for the ExpandedGlyphVisibility dependency property.

Gets the amount that the item is indented.

The amount that the item is indented.

Identifies the Indentation dependency property.

The identifier for the Indentation dependency property.

Represents a flattened list of tree view items so that operations such as keyboard navigation and drag-and-drop can be inherited from ListView.

Initializes a new instance of the TreeViewList control.

Represents a node in a TreeView control.

Initializes a new instance of the TreeViewNode class.

Gets the collection of nodes that are children of the current node.

The collection of nodes that are children of the current node. The default is an empty collection.

Gets or sets the data content for the current node.

The data content for the current node.

Identifies the Content dependency property.

The identifier for the Content dependency property.

Gets a value that indicates how far the current node is from the root node of the tree.

The depth of the current node from the root node of the tree.

Identifies the Depth dependency property.

The identifier for the Depth dependency property.

Gets a value that indicates whether the current node has child items.

**true** if the current node has child items; otherwise, **false**.

Identifies the HasChildren dependency property.

The identifier for the HasChildren dependency property.

Gets or sets a value that indicates whether the current node has child items that haven't been shown.

**true** of the current node has child items that haven't been shown; otherwise, **false**.

Gets or sets a value that indicates whether the cuurent tree view node is expanded.

**true** if the node is expanded; otherwise, **false**.

Identifies the IsExpanded dependency property.

The identifier for the IsExpanded dependency property.

Gets or sets the node that is the parent of the current node.

The node that is the parent of the current node.

Defines constants that specify the selection behavior for a TreeView instance.

The user can select multiple items.

A user can't select items.

A user can select a single item.

Represents a container with two views that size and position content in the available space, either side-by-side or top-bottom.

Initializes a new instance of the TwoPaneView class.

Gets or sets the minimum height at which panes are shown in tall mode.

The minimum height at which panes are shown in tall mode.

Identifies the MinTallModeHeight dependency property.

The identifier for the MinTallModeHeight dependency property.

Gets or sets the minimum width at which panes are shown in wide mode.

The minimum width at which panes are shown in wide mode.

Identifies the MinWideModeWidth dependency property.

The identifier for the MinWideModeWidth dependency property.

Gets a value that indicates how panes are shown.

An enumeration value that indicates how panes are shown.

Identifies the Mode dependency property.

The identifier for the Mode dependency property.

Gets or sets the content of pane 1.

The content of pane 1.

Gets the calculated width (in wide mode) or height (in tall mode) of pane 1, or sets the GridLength value of pane 1.

The GridLength that represents the width or height of the pane.

Identifies the Pane1Length dependency property.

The identifier for the Pane1Length dependency property.

Identifies the Pane1 dependency property.

The identifier for the Pane1 dependency property.

Gets or sets the content of pane 2.

The content of pane 2.

Gets the calculated width (in wide mode) or height (in tall mode) of pane 2, or sets the GridLength value of pane 2.

The GridLength that represents the width or height of the pane.

Identifies the Pane2Length dependency property.

The identifier for the Pane2Length dependency property.

Identifies the Pane2 dependency property.

The identifier for the Pane2 dependency property.

Gets or sets a value that indicates which pane has priority.

An enumeration value that indicates which pane has priority.

Identifies the PanePriority dependency property.

The identifier for the PanePriority dependency property.

Gets or sets a value that indicates how panes are shown in tall mode.

An enumeration value that indicates how panes are shown in tall mode.

Identifies the TallModeConfiguration dependency property.

The identifier for the TallModeConfiguration dependency property.

Gets or sets a value that indicates how panes are shown in wide mode.

An enumeration value that indicates how panes are shown in wide mode.

Identifies the WideModeConfiguration dependency property.

The identifier for the WideModeConfiguration dependency property.

Occurs when the Mode of the TwoPaneView has changed.

Defines constants that specify how panes are shown in a TwoPaneView.

Only one pane is shown.

Panes are shown top-bottom.

Panes are shown side-by-side.

Defines constants that specify which pane has priority in a TwoPaneView.

Pane 1 has priority.

Pane 2 has priority.

Defines constants that specify how panes are shown in a TwoPaneView in tall mode.

The pane that has priority is shown on the bottom, the other pane is shown on top.

Only the pane that has priority is shown, the other pane is hidden.

The pane that has priority is shown on top, the other pane is shown on the bottom.

Defines constants that specify how panes are shown in a TwoPaneView in wide mode.

The pane that has priority is shown on the left, the other pane is shown on the right.

The pane that has priority is shown on the right, the other pane is shown on the left.

Only the pane that has priority is shown, the other pane is hidden.

Represents an ordered collection of UIElement objects.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator object that can iterate over the items in the UIElementCollection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The UIElement value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view. This object implements IVectorView<T> with a UIElement constraint.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Moves the item at the specified index to a new location in the collection.

The zero-based index specifying the location of the item to be moved. The zero-based index specifying the new location of the item.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the UIElement value specified.

The index at which to set the value. The value to set.

Provides the base class for defining a new control that encapsulates related existing controls and provides its own logic.

Initializes a new instance of the UserControl class.

Gets or sets the content that is contained within a user control.

The content of the user control.

Identifies the Content dependency property.

The identifier for the Content dependency property.

Provides a grid-style layout panel where each tile/cell can be variable size based on content.

Initializes a new instance of the VariableSizedWrapGrid class.

Identifies the VariableSizedWrapGrid.ColumnSpan XAML attached property.

The identifier for the VariableSizedWrapGrid.ColumnSpan XAML attached property.

Gets or sets the alignment rules by which child elements are arranged for the horizontal dimension.

A value of the enumeration. The default is **Left**.

Identifies the HorizontalChildrenAlignment dependency property.

The identifier for the HorizontalChildrenAlignment dependency property.

Gets or sets the height of the layout area for each item that is contained in a VariableSizedWrapGrid.

The height of the layout area for each item that is contained in a VariableSizedWrapGrid. The default is Double.NaN, which results in the "Auto" layout behavior.

Identifies the ItemHeight dependency property.

The identifier for the ItemHeight dependency property.

Gets or sets the width of the layout area for each item that is contained in a VariableSizedWrapGrid.

The width of the layout area for each item that is contained in a VariableSizedWrapGrid. The default is Double.NaN, which results in the "Auto" layout behavior.

Identifies the ItemWidth dependency property.

The identifier for the ItemWidth dependency property.

Gets or sets a value that influences the wrap point, also accounting for Orientation.

The maximum rows or columns that this VariableSizedWrapGrid should present before it introduces wrapping to the layout. The default is -1, which is a special value that indicates no maximum.

Identifies the MaximumRowsOrColumns dependency property.

The identifier for the MaximumRowsOrColumns dependency property.

Gets or sets the direction in which child elements are arranged.

A value of the enumeration. The default is **Vertical**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Identifies the VariableSizedWrapGrid.RowSpan XAML attached property.

The identifier for the VariableSizedWrapGrid.RowSpan XAML attached property.

Gets or sets the alignment rules by which child elements are arranged for the vertical dimension.

A value of the enumeration. The default is **Top**.

Identifies the VerticalChildrenAlignment dependency property.

The identifier for the VerticalChildrenAlignment dependency property.

Gets the value of the VariableSizedWrapGrid.ColumnSpan XAML attached property from a target element.

The target element. The obtained value.

Gets the value of the VariableSizedWrapGrid.RowSpan XAML attached property from a target element.

The target element. The obtained value.

Sets the value of the VariableSizedWrapGrid.ColumnSpan XAML attached property on a target element.

The target element. The value to set.

Sets the value of the VariableSizedWrapGrid.RowSpan XAML attached property on a target element.

The target element. The value to set.

Defines a content decorator that can stretch and scale a single child to fill the available space.

Initializes a new instance of the Viewbox class.

Gets or sets the single child element of a Viewbox element.

The single child element of a Viewbox element.

Gets or sets the Stretch mode, which determines how content fits into the available space.

A Stretch mode, which determines how content fits in the available space. The default is **Uniform**.

Gets or sets the StretchDirection, which determines how scaling is applied to the contents of a Viewbox.

A StretchDirection, which determines how scaling is applied to the contents of a Viewbox. The default is **Both**.

Identifies the StretchDirection dependency property.

The identifier for the StretchDirection dependency property.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Defines constants that specify how VirtualizingStackPanel manages item containers for its child items.

Reuse the item containers.

Create and discard the item containers.

Provides a framework for Panel elements that virtualize their visual children.

Gets a value that identifies the ItemContainerGenerator for this VirtualizingPanel.

The ItemContainerGenerator for this VirtualizingPanel.

Adds the specified UIElement to the Children collection of a VirtualizingPanel element.

The UIElement child to add to the collection.

Generates the item at the specified index location and makes it visible.

The index position of the item that is generated and made visible.

Adds the specified UIElement to the collection of a VirtualizingPanel element at the specified index position.

The index position within the collection at which the child element is inserted. The UIElement child to add to the collection.

Called when the collection of child elements is cleared by the base Panel class.

Called when the Items collection that is associated with the ItemsControl for this Panel changes.

The Object that raised the event. Provides data for the ItemsChanged event.

Removes child elements from the Children collection.

The beginning index position within the collection at which the first child element is removed. The total number of child elements to remove from the collection.

Arranges and virtualizes content on a single line that is oriented either horizontally or vertically. Can only be used to display items in an ItemsControl.

Initializes a new instance of the VirtualizingStackPanel class.

Gets or sets a value that indicates whether the generated snap points used for panning in the VirtualizingStackPanel are equidistant from each other.

**true** if the snap points in the VirtualizingStackPanel are equidistant from each other; otherwise, **false**.

Identifies the AreScrollSnapPointsRegular dependency property.

The identifier for the AreScrollSnapPointsRegular dependency property.

Identifies the **VirtualizingStackPanel.IsVirtualizing** attached property.

The identifier for the **VirtualizingStackPanel.IsVirtualizing** attached property.

Gets or sets a value that describes the horizontal or vertical orientation of stacked content.

The Orientation of child content, as a value of the enumeration. The default is **Vertical**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Identifies the VirtualizingStackPanel.VirtualizationMode XAML attached property.

The identifier for the VirtualizingStackPanel.VirtualizationMode XAML attached property.

Occurs when an item that is hosted by the VirtualizingStackPanel is re-virtualized.

Gets a value that determines whether an item is currently being virtualized as part of an items set where the ItemsPanel is templated with a VirtualizingStackPanel.

The object item where you want to determine the current virtualization state. **true** if the item specified by *o* is currently virtualizing its content; otherwise, **false**.

Gets the VirtualizingStackPanel.VirtualizationMode XAML attached property value for the specified target element.

The object from which the VirtualizationMode is read. One of the enumeration values that specifies whether the object uses container recycling.

Called when an item that is hosted by the VirtualizingStackPanel is re-virtualized.

Data about the event.

Sets the VirtualizingStackPanel.VirtualizationMode XAML attached property on the specified target element.

The target element. One of the enumeration values that specifies whether *element* uses container recycling.

Provides a control that hosts HTML content in an app.

Initializes a new instance of the WebView class.

Initializes a new instance of the WebView class with the specified execution mode.

A value of the enumeration that indicates whether the WebView hosts content on the UI thread or a non-UI thread.

Gets or sets a safe list of URIs that are permitted to fire ScriptNotify events to this WebView.

The safe list of URIs that are permitted to fire ScriptNotify events.

Identifies the AllowedScriptNotifyUris dependency property.

The identifier for the AllowedScriptNotifyUris dependency property.

Gets a value that you can use to set the AllowedScriptNotifyUris property to indicate that any page can fire ScriptNotify events to this WebView.

The safe list of URIs that are permitted to fire ScriptNotify events.

Gets a value that indicates whether there is at least one page in the backward navigation history.

**true** if the WebView can navigate backward; otherwise, **false**.

Identifies the CanGoBack dependency property.

The identifier for the CanGoBack dependency property.

Gets a value that indicates whether there is at least one page in the forward navigation history.

**true** if the WebView can navigate forward; otherwise, **false**.

Identifies the CanGoForward dependency property.

The identifier for the CanGoForward dependency property.

Gets a value that indicates whether the WebView contains an element that supports full screen.

**true** if the WebView contains an element that supports full screen; otherwise, **false**.

Identifies the ContainsFullScreenElement dependency property.

The identifier for the ContainsFullScreenElement dependency property.

Gets a clipboard DataPackage as passed to the WebView.

A clipboard data package.

Identifies the DataTransferPackage dependency property.

The identifier for the DataTransferPackage dependency property.

Gets or sets the color to use as the WebView background when the HTML content does not specify a color.

The background color.

Identifies the DefaultBackgroundColor dependency property.

The identifier for the DefaultBackgroundColor dependency property.

Gets the default threading behavior of WebView instances in the current app.

The default threading behavior of WebView instances in the current app.

Gets a collection of permission requests that are waiting to be granted or denied.

A collection of WebViewDeferredPermissionRequest objects that are waiting to be granted or denied.

Gets the title of the page currently displayed in the WebView.

The page title.

Identifies the DocumentTitle dependency property.

The identifier of the DocumentTitle dependency property.

Gets a value that indicates whether the WebView hosts content on the UI thread or a non-UI thread.

A value of the enumeration that specifies whether the WebView hosts content on the UI thread or a non-UI thread.

Gets a WebViewSettings object that contains properties to enable or disable WebView features.

A WebViewSettings object that contains properties to enable or disable WebView features.

Gets or sets the Uniform Resource Identifier (URI) source of the HTML content to display in the WebView control.

The Uniform Resource Identifier (URI) source of the HTML content to display in the WebView control.

Identifies the Source dependency property.

The identifier for the Source dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) down.

The object that gets focus when a user presses the Directional Pad (D-pad).

Identifies the XYFocusDown dependency property.

The identifier for the XYFocusDown dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) left.

The object that gets focus when a user presses the Directional Pad (D-pad).

Identifies the XYFocusLeft dependency property.

The identifier for the XYFocusLeft dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) right.

The object that gets focus when a user presses the Directional Pad (D-pad).

Identifies the XYFocusRight dependency property.

The identifier for the XYFocusRight dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (D-pad) up.

The object that gets focus when a user presses the Directional Pad (D-pad).

Identifies the XYFocusUp dependency property.

The identifier for the XYFocusUp dependency property.

Occurs when the status of whether the WebView currently contains a full screen element or not changes.

Occurs when the WebView has started loading new content.

Occurs when the WebView has finished parsing the current HTML content.

Occurs when a frame in the WebView has started loading new content.

Occurs when a frame in the WebView has finished parsing its current HTML content.

Occurs when a frame in the WebView has finished loading its content.

Occurs before a frame in the WebView navigates to new content.

Occurs when top-level navigation completes and the content loads into the WebView control or when an error occurs during loading.

Occurs periodically while the WebView executes JavaScript, letting you halt the script.

Occurs when the WebView has finished loading the current content or if navigation has failed.

Occurs when the WebView cannot complete the navigation attempt.

Occurs before the WebView navigates to new content.

Occurs when a user performs an action in a WebView that causes content to be opened in a new window.

Occurs when an action in a WebView requires that permission be granted.

Occurs when the content contained in the WebView control passes a string to the application by using JavaScript.

Occurs when a WebView runs with an ExecutionMode of **SeparateProcess**, and the separate process is lost.

Occurs when the WebView shows a warning page for content that was reported as unsafe by SmartScreen Filter.

Occurs when an attempt is made to navigate to a Uniform Resource Identifier (URI) using a scheme that WebView doesn't support.

Occurs when the WebView attempts to download an unsupported file.

Occurs when an HTTP request has been made.

Adds a native Windows Runtime object as a global parameter to the top level document inside of a WebView.

The name of the object to expose to the document in the WebView. The object to expose to the document in the WebView.

Creates a URI that you can pass to NavigateToLocalStreamUri.

A unique identifier for the content the URI is referencing. This defines the root of the URI. The path to the resource, relative to the root. The URI created by combining and normalizing the *contentIdentifier* and *relativePath*.

Creates an image of the current WebView contents and writes it to the specified stream.

The stream to write the image to. An asynchronous action to await the capture operation.

Asynchronously gets a DataPackage that contains the selected content within the WebView.

When this method completes, it returns the selected content as a DataPackage.

Clears the WebView 's cache and **IndexedDB** data.

An asynchronous action to await the clear operation.

Returns the deferred permission request with the specified Id.

The Id of the deferred permission request. The deferred permission request with the specified Id.

Sets the input focus to the WebView.

A value that indicates how the focus was set. **true** if focus was set; otherwise, **false**.

Navigates the WebView to the previous page in the navigation history.

Navigates the WebView to the next page in the navigation history.

Executes the specified script function from the currently loaded HTML, with specific arguments.

Use InvokeScriptAsync instead of InvokeScript. For more info, see MSDN. The name of the script function to invoke. A string array that packages arguments to the script function. The result of the script invocation.

Executes the specified script function from the currently loaded HTML, with specific arguments, as an asynchronous action.

The name of the script function to invoke. A string array that packages arguments to the script function. When this method returns, the string result of the script invocation.

Loads the HTML content at the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) to load.

Loads local web content at the specified URI using an IUriToStreamResolver.

A URI identifying the local HTML content to load. A resolver that converts the URI into a stream to load.

Loads the specified HTML content as a new document.

The HTML content to display in the WebView control.

Navigates the WebView to a URI with a POST request and HTTP headers.

The details of the HTTP request.

Reloads the current content in the WebView.

Halts the current WebView navigation or download.

Provides a brush that renders the content that is currently hosted in a WebView control.

Initializes a new instance of the WebViewBrush class.

Gets or sets the name of the source WebView control that provides the HTML content.

The Name or x:Name attribute of the WebView that provides the HTML content.

Identifies the SourceName dependency property.

The identifier for the SourceName dependency property.

Causes the WebViewBrush to get updated source pixels from the associated WebView and its current content. This happens asynchronously.

Sets the source of the content for the WebViewBrush.

The WebView hosting the HTML content that is the source for the brush.

Provides data for the WebView.ContentLoading event.

Gets the Uniform Resource Identifier (URI) of the content the WebView is loading.

The Uniform Resource Identifier (URI) of the content.

Represents a deferred request for permissions in a WebView.

Gets the identifier for the permission request.

The identifier for the permission request.

Gets a value that indicates the type of permission that's requested.

An enumeration value that indicates the type of permission requested.

Gets the Uniform Resource Identifier (URI) of the content where the permission request originated.

The Uniform Resource Identifier (URI) of the content where the permission request originated.

Grants the requested permission.

Denies the requested permission.

Provides data for the DOMContentLoaded event.

Gets the Uniform Resource Identifier (URI) of the content the WebView is loading.

The Uniform Resource Identifier (URI) of the content.

Defines constants that specify whether WebView hosts HTML content on the UI thread or on a non-UI thread.

Content is hosted on the UI thread.

Content is hosted on a separate process off the app process. All of an app's WebView instances share the same separate process, there is not a separate process per WebView instance.

Content is hosted on a background thread.

Provides data for the WebView.LongRunningScriptDetected event.

Gets the number of milliseconds that the WebView control has been executing a long-running script.

The number of milliseconds the script has been running.

Halts a long-running script executing in a WebView control.

**true** to halt the script; otherwise, **false**.

Provides data for the WebView.NavigationCompleted and FrameNavigationCompleted events.

Gets a value that indicates whether the navigation completed successfully.

**true** if the navigation completed successfully; otherwise, **false**.

Gets the Uniform Resource Identifier (URI) of the WebView content.

The Uniform Resource Identifier (URI) of the content.

If the navigation was unsuccessful, gets a value that indicates why

A value that explains an unsuccessful navigation.

Provides data for the WebView.NavigationFailed event.

Gets the URI that the WebView attempted to navigate to.

The attempted navigation target.

Gets the error that occurred when navigation failed.

The navigation error.

Represents the method that will handle the WebView.NavigationFailed  event.

The object where the event handler is attached. The event data.

Provides data for the WebView.NavigationStarting and FrameNavigationStarting events.

Gets or sets a value indicating whether to cancel the WebView navigation.

**true** to cancel the navigation; otherwise, **false**.

Gets the Uniform Resource Identifier (URI) of the content the WebView is loading.

The Uniform Resource Identifier (URI) of the content.

Provides data for the WebView.NewWindowRequested event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents other handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the Uniform Resource Identifier (URI) of the content where the navigation was initiated.

The Uniform Resource Identifier (URI) of the content where the navigation was initiated.

Gets the Uniform Resource Identifier (URI) of the content the WebView is attempting to navigate to.

The Uniform Resource Identifier (URI) of the content the WebView is attempting to navigate to.

Represents a request for permissions in a WebView.

Gets the identifier for the permission request.

The identifier for the permission request.

Gets a value that indicates the type of permission that's requested.

An enumeration value that indicates the type of permission requested.

Gets the current state of the permission request.

An enumeration value that indicates the current state of the permission request. The default is **Unknown**.

Gets the Uniform Resource Identifier (URI) of the content where the permission request originated.

The Uniform Resource Identifier (URI) of the content where the permission request originated.

Grants the requested permission.

Defers the permission request to be allowed or denied at a later time.

Denies the requested permission.

Provides event data for the WebView.PermissionRequested event.

Gets the WebViewPermissionRequest object that contains information about the request.

The WebViewPermissionRequest object that contains information about the request.

Defines constants that specify the state of a WebView.PermissionRequested event.

WebViewPermissionRequest.Allow was called. The permission request is allowed.

WebViewPermissionRequest.Defer was called. The permission request is deferred.

WebViewPermissionRequest.Deny was called. The permission request is denied.

The state of the permission request can't be determined.

Defines constants the specify the type of permission requested in a WebView.

Permission is for geolocation.

Permission is for immersive view (WebVR).

Permission is for media.

Permission is for pointer lock.

Permission is for screen capture.

Permission is for unlimited **IndexedDB** data storage.

Permission is for web notifications.

Provides event data for the WebView.SeparateProcessLost event.

Defines properties that enable or disable WebView features.

Gets or sets a value that indicates whether the use of **IndexedDB** is allowed in the WebView.

**true** if **IndexedDB** is allowed in the WebView; otherwise, **false**. The default is **true**.

Gets or sets a value that indicates whether the use of JavaScript is allowed in the WebView.

**true** if JavaScript is allowed in the WebView; otherwise, **false**. The default is **true**.

Provides data for the WebView.UnsupportedUriSchemeIdentified event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents other handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the Uniform Resource Identifier (URI) of the content the WebView attempted to navigate to.

The Uniform Resource Identifier (URI) of the content.

Provides data for the WebView.UnviewableContentIdentified event.

Gets the media type of content that can't be viewed.

The media type of content that can't be viewed.

Gets the Uniform Resource Identifier (URI) of the page that contains the link to the unviewable content.

The Uniform Resource Identifier (URI) of the referring page.

Gets the Uniform Resource Identifier (URI) of the content the WebView attempted to load.

The Uniform Resource Identifier (URI) of the content.

Provides event data for the WebView.WebResourceRequested event.

Gets the web resource request.

The web resource request.

Gets or sets the response to the web resource request.

The response to the web resource request.

Gets a deferral object for managing the work done in the WebResourceRequested event handler.

A deferral object.

Positions child elements sequentially from left to right or top to bottom. When elements extend beyond the container edge, elements are positioned in the next row or column. Can only be used to display items in an ItemsControl. See Remarks.

Initializes a new instance of the WrapGrid class.

Gets or sets the alignment rules by which child elements are arranged for the horizontal dimension.

A value of the enumeration. The default is **Left**.

Identifies the HorizontalChildrenAlignment dependency property.

The identifier for the HorizontalChildrenAlignment dependency property.

Gets or sets the height of the layout area for each item that is contained in a WrapGrid.

The height of the layout area for each item that is contained in a WrapGrid. The default is Double.NaN, which results in the "Auto" layout behavior.

Identifies the ItemHeight dependency property.

The identifier for the ItemHeight dependency property.

Gets or sets the width of the layout area for each item that is contained in a WrapGrid.

The width of the layout area for each item that is contained in a WrapGrid. The default is Double.NaN, which results in the "Auto" layout behavior.

Identifies the ItemWidth dependency property.

The identifier for the ItemWidth dependency property.

Gets or sets a value that influences the wrap point, also accounting for Orientation.

The maximum rows or columns that this WrapGrid should present before it introduces wrapping to the layout. The default is -1, which is a special value that indicates no maximum.

Identifies the MaximumRowsOrColumns dependency property.

The identifier for the MaximumRowsOrColumns dependency property.

Gets or sets the direction in which child elements are arranged.

A value of the enumeration. The default is **Vertical**.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets or sets the alignment rules by which child elements are arranged for the vertical dimension.

A value of the enumeration. The default is **Top**.

Identifies the VerticalChildrenAlignment dependency property.

The identifier for the VerticalChildrenAlignment dependency property.

Defines constants that specify the current mode for zoom behavior in the ScrollViewer content.

Zoom of content is disabled.

Zoom of content is enabled.

Provides a source of custom tiles for a MapTileSource. Use this class when you can't use HttpMapTileDataSource or LocalMapTileDataSource. For example, CustomMapTileDataSource supports drawing tiles in memory and returning them as a stream of pixels.

Initializes a new instance of the CustomMapTileDataSource class.

Occurs when the bitmap is requested for a CustomMapTileDataSource. An instance of MapTileBitmapRequestedEventArgs provides data for this event.

Provides a source of tiles for a MapTileSource. The tiles are fetched by using the HTTP or HTTPS protocol. Note that, as of build 15063, local uris don't work anymore.

Initializes a new instance of the HttpMapTileDataSource class.

Initializes a new instance of the HttpMapTileDataSource class with the specified Uri format.

The Uri format to use.

Gets or sets additional HTTP request headers and their values for fetching tiles from an HTTP source.

Additional HTTP request headers and their values for fetching tiles from an HTTP source.

Gets or sets a value that indicates whether the Internet cache is checked before fetching a tile from an HTTP source. When caching is disabled, a new request for the tile is made every time.

**true** if the Internet cache is checked before fetching a tile from an HTTP source; otherwise, **false**.

Gets or sets the format of the Uri for fetching tiles from an HTTP source.

The format of the Uri for fetching tiles from an HTTP source.

Occurs when the tile is requested for an HttpMapTileDataSource. An instance of MapTileUriRequestedEventArgs provides data for this event.

Provides a source of tiles for a MapTileSource. The tiles are fetched by using a local protocol such as **ms-appdata**.

Initializes a new instance of the LocalMapTileDataSource class.

Initializes a new instance of the LocalMapTileDataSource class with the specified Uri format.

The Uri format to use.

Gets or sets the format of the Uri for fetching tiles from a local source.

The format of the Uri for fetching tiles from a local source.

Occurs when the tile is requested for an LocalMapTileDataSource. An instance of MapTileUriRequestedEventArgs provides data for this event.

Provides data for the ActualCameraChanged event.

Initializes a new instance of the MapActualCameraChangedEventArgs class.

Gets the current position of the map's camera.

The current position of the map's camera.

Indicates the reason the ActualCameraChanged event was triggered.

The reason the ActualCameraChanged event was triggered.

Provides data for the ActualCameraChanging event.

Initializes a new instance of the MapActualCameraChangingEventArgs class.

Gets the position of the map's camera before it started moving.

Gets the position of the map's camera before it started moving.

Indicates the reason the ActualCameraChanging event was triggered.

The reason the ActualCameraChanging event was triggered.

Specifies the animation to use when you change the view of the map. For example, you can specify animation when calling the TrySetViewAsync or TrySetViewBoundsAsync methods.

A parabolic animation.

The default animation.

A linear animation.

No animation

Displays an image that scales and fades in relation to its distance from the ReferenceCamera of the MapBillboard.

Initializes a new instance of the MapBillboard class.

The MapCamera settings that define the current position of the reference camera.

Gets or sets the behavior of a MapBillboard when it collides with other map features due to zoom level.

The behavior of a MapBillboard when it collides with other map features due to zoom level.

Identifies the CollisionBehaviorDesired dependency property.

Identifier for the CollisionBehaviorDesired dependency property.

Gets or sets the image for the MapBillboard. Provide an optional custom image to replace the default point of interest (POI) image.

The point of interest (POI) image for the MapBillboard.

Gets or sets the geographic location of the MapBillboard on the MapControl. The location is the geographic location on the MapControl at which the NormalizedAnchorPoint of the MapBillboard is positioned.

The geographic location of the MapBillboard on the MapControl.

Identifies the Location dependency property.

The identifier for the Location dependency property.

Gets or sets the anchor point of the MapBillboard. The anchor point is the point on the MapBillboard that is positioned at the point on the MapControl specified by the Location property.

The anchor point of the MapBillboard.

Identifies the NormalizedAnchorPoint dependency property.

The identifier for the NormalizedAnchorPoint dependency property.

Gets the MapCamera settings that define the position and orientation where the image appears at a 1x scale.

The MapCamera settings that define the position and orientation where the image appears at a 1x scale.

Represents the position of a camera to define the view of a map.

Creates a map camera, to define the view of a map based on location.

The location of the camera in the map.

Creates a map camera, to define the view of a map based on location and heading.

The location of the camera in the map. The directional heading of the camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0.

Creates a map camera, to define the view of a map based on location, heading, and pitch.

The location of the camera in the map. The directional heading of the camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0.

Creates a map camera, to define the view of a map based on location, heading, pitch, roll, and field of view.

The location of the camera in the map. The directional heading of the camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0. The roll of the camera in degrees, where -90 is tilting to the left and +90 is tilting to the right. The default *rollInDegrees* value is 0. The horizontal angle of view that appears in the camera, in degrees. The default *fieldOfViewInDegrees* value is 45.0.

Gets or sets the vertical angle of view that appears in the camera, in degrees.

The vertical angle of view that appears in the camera, in degrees.

Gets or sets the directional heading of the camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The directional heading of the camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

Gets or sets the location of the camera in the map.

The location of the camera in the map.

Gets or sets the pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum).

The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum).

Gets or sets the roll of the camera in degrees, where -90 is tilting to the left and +90 is tilting to the right.

The roll of the camera in degrees, where -90 is tilting to the left and +90 is tilting to the right.

Specifies the reason the position of the map's camera has changed.

The position of the map's camera changed programmatically.

The system changed the position of the map's camera.

The user manually changed the position of the map's camera.

Specifies the ColorScheme of the MapControl.

The dark color scheme.

The light color scheme.

Provides event data for the MapContextRequested event.

Initializes a new instance of the MapContextRequestedEventArgs class.

Gets a geolocation on the map of a context input gesture, such as a right-click.

The geolocation on the map of a context input gesture, such as a right-click.

Gets a collection of MapElement objects at the point on the map specified by the Location property.

A collection of MapElement objects at the point on the map specified by the Location property.

Gets the x- and y-coordinate values that define the point on the map of a context input gesture, such as a right-click.

The x- and y-coordinate values that define the point on the map of a context input gesture, such as a right-click.

Represents a symbolic or photorealistic map of the Earth.

Initializes a new instance of the MapControl class.

Gets the MapCamera settings that define the current position of the camera.

The MapCamera settings that define the current position of the camera.

This property is not implemented.

This property is not implemented.

This property is not implemented.

This property is not implemented.

Gets or sets a value that indicates whether businesses are displayed on the map.

**true** if businesses are displayed on the map; otherwise, **false**.

Identifies the BusinessLandmarksVisible dependency property.

The identifier for the BusinessLandmarksVisible dependency property.

Gets a value indicating if the map can be tilted down

Identifies the CanTiltDown dependency property.

The identifier for the CanTiltDown dependency property.

Gets a value indicating if the map can be tilted up

Identifies the CanTiltUp dependency property.

The identifier for the CanTiltUp dependency property.

Gets a value indicating if the map can be zoomed in

Identifies the CanZoomIn dependency property.

The identifier for the CanZoomIn dependency property.

Gets a value indicating if the map can be zoomed out

Identifies the CanZoomOut dependency property.

The identifier for the CanZoomOut dependency property.

Gets or sets the center of the map.

The center of the map.

Identifies the Center dependency property.

The identifier for the Center dependency property.

Gets the collection of objects that are children of the MapControl.

The collection of objects that are children of the MapControl.

Identifies the Children dependency property.

The identifier for the Children dependency property.

Gets or sets the color scheme of the map – for example, light or dark.

The color scheme of the map – for example, light or dark.

Identifies the ColorScheme dependency property.

The identifier for the ColorScheme dependency property.

Gets or sets a custom experience for the MapControl.

A custom experience for the MapControl.

Gets or sets a value that indicates by how many degrees you want the map to be tilted. Sometimes the desired pitch cannot be set.

A value that indicates by how many degrees you want the map to be tilted. Sometimes the desired pitch cannot be set.

Identifies the DesiredPitch dependency property.

The identifier for the DesiredPitch dependency property.

Gets or sets the directional heading of the map in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The directional heading of the map in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

Identifies the Heading dependency property.

The identifier for the Heading dependency property.

Gets a value that indicates if 3D is supported within the map.

**true** if 3D is supported within the map; otherwise, **false**.

Identifies the Is3DSupported dependency property.

Is the identifier for the Is3DSupported dependency property.

Gets a value that indicates if Streetside is supported within the map.

**true** if Streetside is supported within the map; otherwise, **false**.

Identifies the IsStreetsideSupported dependency property.

Is the identifier for the IsStreetsideSupported dependency property.

Gets or sets a value that indicates whether 3D buildings are displayed on the map.

**true** if 3D buildings are displayed on the map; otherwise, **false**.

Identifies the LandmarksVisible dependency property.

The identifier for the LandmarksVisible dependency property.

Gets the collection of MapLayer objects that are children of the MapControl.

The collection of MapLayer objects that are children of the MapControl.

Identifies the Layers dependency property.

The Layers dependency property.

Gets the loading status of the map to be displayed in the MapControl.

The loading status of the map to be displayed in the MapControl.

Identifies the LoadingStatus dependency property.

The identifier for the LoadingStatus dependency property.

Identifies the MapControl.Location XAML attached property.

The identifier for the MapControl.Location XAML attached property.

Gets the collection of MapElement objects that are children of the MapControl.

The collection of MapElement objects that are children of the MapControl.

Identifies the MapElements dependency property.

The identifier for the MapElements dependency property.

Gets or sets a MapProjection that specifies how to transform the latitudes and longitudes of the map.

An MapProjection that specifies how to transform the latitudes and longitudes of the map.

Identifies the MapProjection dependency property.

The identifier for the MapProjection dependency property.

Gets or sets the authentication key required for using the MapControl and online mapping services.

The authentication key required for using the MapControl and online mapping services.

Identifies the MapServiceToken dependency property.

The identifier for the MapServiceToken dependency property.

Gets the maximum zoom level for the map.

The maximum zoom level for the map.

Gets the minimum zoom level for the map.

The minimum zoom level for the map.

Identifies the MapControl.NormalizedAnchorPoint XAML attached property.

The identifier for the MapControl.NormalizedAnchorPoint XAML attached property.

Gets or sets a value that indicates if the pan gesture is recognized on the map.

A value that indicates if the pan gesture is recognized on the map.

Identifies the PanInteractionMode dependency property.

Identifier for the PanInteractionMode dependency property.

Gets or sets a value that indicates whether pedestrian features such as public stairs are displayed on the map.

**true** if pedestrian features such as public stairs are displayed on the map; otherwise, **false**.

Identifies the PedestrianFeaturesVisible dependency property.

The identifier for the PedestrianFeaturesVisible dependency property.

Gets the actual pitch of the map. Sometimes the pitch requested by setting the DesiredPitch property cannot be set.

The actual pitch of the map. Sometimes the pitch requested by setting the property cannot be set.

Identifies the Pitch dependency property.

The identifier for the Pitch dependency property.

Gets or sets the region (for example, the state or province) of an address.

The region (for example, the state or province) of an address.

Identifies the Region dependency property.

Identifier for the Region dependency property.

Gets or sets a value that indicates if the map responds to the rotate gesture and if the corresponding UI control appears on the map.

A value that specifies if the map responds to the rotate gesture and if the corresponding UI control appears on the map.

Identifies the RotateInteractionMode dependency property.

Identifier for the RotateInteractionMode dependency property.

Gets the collection of MapRouteView objects displayed on the map.

The collection of MapRouteView objects displayed on the map.

Identifies the Routes dependency property.

The identifier for the Routes dependency property.

Gets or sets the MapScene associated with this MapControl.

The MapScene associated with this MapControl.

Identifies the Scene dependency property.

The identifier for the Scene dependency property.

Specifies the style of the map - for example, a road map or an aerial map.

The style of the map - for example, a road map or an aerial map.

Identifies the Style dependency property.

The identifier for the Style dependency property.

Gets or sets an object that defines the style of the map control.

An object that defines the style of the map control.

Identifies the StyleSheet dependency property.

The identifier for the StyleSheet dependency property.

Gets the MapCamera settings that define the final position of the camera.

The MapCamera settings that define the final position of the camera.

Gets or sets the collection of MapTileSource objects that are children of the MapControl.

The collection of MapTileSource objects that are children of the MapControl.

Identifies the TileSources dependency property.

The identifier for the TileSources dependency property.

Gets or sets a value that indicates if the map responds to the tilt gesture and if the corresponding UI control appears on the map.

A value that specifies if the map responds to the tilt gesture and if the corresponding UI control appears on the map.

Identifies the TiltInteractionMode dependency property.

Identifier for the TiltInteractionMode dependency property.

Gets or sets a value that indicates whether traffic conditions are displayed on the map.

**true** if traffic conditions are displayed on the map; otherwise, **false**.

Identifies the TrafficFlowVisible dependency property.

The identifier for the TrafficFlowVisible dependency property.

Gets or sets a point to which the logical center of the map is transformed.

A point to which the logical center of the map is transformed. Use a value between 0 and 1 (but not 0 or 1) for the X and Y properties of the Point.

Identifies the TransformOrigin dependency property.

The identifier for the TransformOrigin dependency property.

This property is not implemented.

This property is not implemented.

This property is not implemented.

This property is not implemented.

Gets or sets a value that indicates if transit features are displayed on the map.

**true** if transit features are displayed on the map; otherwise, **false**.

Identifies the TransitFeaturesVisible dependency property.

The identifier for the TransitFeaturesVisible dependency property.

Gets or sets the padding inside a map control.

The amount of space between the content of a MapControl and its Margin or Border. The default is a Thickness with values of 0 on all four sides.

Identifies the ViewPadding dependency property.

The identifier for the ViewPadding dependency property.

Gets or sets a value that determines when the watermark of the map is displayed.

A value that determines when the watermark of the map is displayed.

Identifies the WatermarkMode dependency property.

The identifier for the WatermarkMode dependency property.

Gets or sets a value that indicates if the map responds to the zoom gesture and if the corresponding UI control appears on the map.

A value that specifies if the map responds to the zoom gesture and if the corresponding UI control appears on the map.

Identifies the ZoomInteractionMode dependency property.

Identifier for the ZoomInteractionMode dependency property.

Gets or sets the zoom level of the map, which is a value between 1 and 20 in 2D views.

The zoom level of the map, which is a value between 1 and 20 in 2D views.

Identifies the ZoomLevel dependency property.

The identifier for the ZoomLevel dependency property.

Occurs when the current position of the map's camera has changed.

Occurs when the current position of the map's camera changes.

Occurs when the value of the Center property of the MapControl changes.

Occurs when the custom experience of the MapControl changes.

Occurs when the value of the Heading property of the MapControl changes.

Occurs when the value of the LoadingStatus property of the MapControl changes.

Occurs when the user has completed a context input gesture on a map, such as a right-click.

Occurs when the user double-taps the MapControl. An instance of MapInputEventArgs provides data for this event.

Occurs when the user taps or clicks a MapElement on the MapControl.

Occurs when a pointer moves into the bounding area of a MapElement on a MapControl.

Occurs when a pointer moves out of the bounding area of a MapElement on a MapControl.

Occurs when the user taps and holds on the MapControl. An instance of MapInputEventArgs provides data for this event.

Occurs when the user presses-and-holds the MapControl or clicks on it using the right mouse button. An instance of MapRightTappedEventArgs provides data for this event.

Occurs when the user taps the MapControl or clicks on it with the left mouse button. An instance of MapInputEventArgs provides data for this event.

Occurs when the value of the Pitch property of the MapControl changes.

Occurs when the final position of the map's camera has changed.

Occurs when the value of the TransformOrigin property of the MapControl changes.

Occurs when the value of the ZoomLevel property of the MapControl changes.

Retrieves the collection of MapElement objects at the specified point on the map.

The point on the map from which to retrieve the collection of MapElement objects. The collection of MapElement objects at the specified point on the map.

Retrieves the collection of MapElement objects within the specified radius.

The point on the map that marks the center of a radius from which to retrieve the collection of MapElement objects. A number that's added to the offset to mark the edge of the radius. The collection of MapElement objects within the specified radius.

Gets the value of the MapControl.Location XAML attached property from the specified child element of a MapControl. The location is the geographic location on the MapControl at which the MapControl.NormalizedAnchorPoint of the child element is positioned.

The element from which to read the property value. The value of the MapControl.Location XAML attached property on the specified child element of a MapControl.

Converts a point on the map to a geographic location by using the specified altitude reference system.

A point on the map to convert to a geographic location. The altitude reference system of the geographic point. A value of **Unspecified** for the altitude reference system has the same effect as using the default GetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devices.Geolocation.Geopoint location) overload. When this method returns, contains the corresponding geographic location.

Converts a point on the map to a geographic location.

A point on the map to convert to a geographic location. When this method returns, contains the corresponding geographic location.

Gets the value of the MapControl.NormalizedAnchorPoint XAML attached property from the specified child element of a MapControl. The anchor point is the point on the child element that is positioned at the point on the MapControl specified by the MapControl.Location attached property.

The element from which to read the property value. The value of the MapControl.NormalizedAnchorPoint XAML attached property on the specified child element of a MapControl.

Converts a geographic location to a point on the map.

A geographic location to convert to a point on the map. When this method returns, contains the corresponding point on the map.

Gets the visible region of the map control.

The visible region kind. The geopath indicating the visible region of the map control. The returned value can be null when a valid visible region cannot be calculated.

Determines whether the specified geographic location is located in the portion of the map currently visible in the MapControl.

A geographic location. When this method returns, contains **true** if the specified geographic location is located in the portion of the map currently visible in the MapControl; otherwise, contains **false**.

Sets the value of the MapControl.Location XAML attached property on the specified child element of a MapControl. The location is the geographic location on the MapControl at which the MapControl.NormalizedAnchorPoint of the child element is positioned.

The element on which to set the property value. The value of the MapControl.Location XAML attached property to set on the specified child element of a MapControl.

Sets the value of the MapControl.NormalizedAnchorPoint XAML attached property on the specified child element of a MapControl. The anchor point is the point on the child element that is positioned at the point on the MapControl specified by the MapControl.Location attached property.

The element on which to set the property value. The value of the MapControl.NormalizedAnchorPoint XAML attached property to set on the specified child element of a MapControl.

Starts an asynchronous operation to pan the map continuously from its current position.

The pixels per second to pan horizontally. The pixels per second to pan vertically.

Starts an asynchronous operation to rotate the map's camera continuously from its current position.

The degrees that the map's camera rotates per second in a horizontal clockwise direction.

Starts an asynchronous operation to tilt the map's camera continuously from its current position.

The degrees of Pitch that the map's camera tilts down to the ground per second.

Starts an asynchronous operation to zoom in continuously until the map's maximum ZoomLevel is reached.

The change in ZoomLevel per second.

Stops an asynchronous operation to pan the map continuously from its current position.

Stops an asynchronous operation to rotate the map's camera continuously from its current position.

Stops an asynchronous operation to tilt the map's camera continuously from its current position.

Stops an asynchronous operation to zoom in continuously until the map's maximum ZoomLevel is reached.

Converts a point on the map to a geographic location by using the specified altitude reference system.

A point on the map to convert to a geographic location. The altitude reference system of the geographic point. A value of **Unspecified** for the altitude reference system has the same effect as using the default TryGetLocationFromOffset(Windows.Foundation.Point offset, Windows.Devices.Geolocation.Geopoint location) overload. When this method returns, contains the corresponding geographic location. Returns **true** if the location is invalid; otherwise, **false**.

Converts a point on the map to a geographic location.

A point on the map to convert to a geographic location. When this method returns, contains the corresponding geographic location. Returns **true** if the location is invalid; otherwise, **false**.

Starts an asynchronous operation to pan the map from its current position.

The pixels to pan horizontally. The pixels to pan vertically. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to pan the map to a specific location.

The coordinates of a geographic location to which you want to pan the map. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to rotate the map's camera from its current position.

The degrees that the map's camera rotates in a horizontal clockwise direction. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to rotate the map's camera to a specific orientation.

The final Heading of the map's camera, in degrees. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Sets the scene of the map displayed in the MapControl using the specified scene.

Defines the item or area to appear in the map. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the scene of the map displayed in the MapControl using the specified scene and animation.

Defines the item or area to appear in the map. Specifies the animation to use when you change the scene of the map. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the view of the map displayed in the MapControl using the specified center.

The center to use in the view. For more info, see the Center property. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the view of the map displayed in the MapControl using the specified center and zoom level.

The center to use in the view. For more info, see the Center property. The zoom level to use in the view. For more info, see the ZoomLevel property. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the view of the map displayed in the MapControl using the specified center, zoom level, heading, and pitch.

The center to use in the view. For more info, see the Center property. The zoom level to use in the view. For more info, see the ZoomLevel property. The heading to use in the view. For more info, see the Heading property. The pitch to use in the view. For more info, see the DesiredPitch property. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the view of the map displayed in the MapControl using the specified center, zoom level, heading, and pitch. The view change uses the specified animation.

The center to use in the view. For more info, see the Center property. The zoom level to use in the view. For more info, see the ZoomLevel property. The heading to use in the view. For more info, see the Heading property. The pitch to use in the view. For more info, see the DesiredPitch property. The animation to use when changing the view. For more info, see MapAnimationKind. **true** if the asynchronous operation succeeded; otherwise, **false**.

Sets the view of the map displayed in the MapControl to the contents of the specified GeoboundingBox with the specified margin. The view change uses the specified animation.

The geographic area to display in the view. The margin to use in the view. The animation to use when changing the view. For more info, see MapAnimationKind. **true** if the asynchronous operation succeeded; otherwise, **false**.

Starts an asynchronous operation to tilt the map's camera from its current position.

The degrees of Pitch that the map's camera tilts down to the ground. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to tilt the map's camera to a specific orientation.

The final Pitch of the map's camera in degrees. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to zoom in, increasing the map's ZoomLevel by one.

Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to zoom out, decreasing the map's ZoomLevel by one.

Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Starts an asynchronous operation to zoom the map to a specific ZoomLevel.

The final zoom level of the map, between 1 and 20. Contains the results of the operation: **true** if the operation completed successfully; otherwise, **false**.

Represents a custom experience for the MapControl.

This API is for internal use only. Use StreetsideExperience to create a street-level views.

Provides data for the CustomExperienceChanged event.

Initializes a new instance of the MapCustomExperienceChangedEventArgs class.

Represents an element displayed on a MapControl.

Initializes a new instance of the MapElement class.

Indicates whether users can interact with the MapElement.

**true** if users can interact with the MapElement; otherwise, **false**.

Identifies the IsEnabled dependency property.

Identifier for the IsEnabled dependency property.

Gets or sets the name of an entry in the map's style sheet that you'd like to apply to this MapElement.

The name of the entry in the map's style sheet that you'd like to apply to this MapElement. This name may be an existing map element (see remarks) that acts like an existing base map element of that type. Or the name may be an extension that is not used by the base map but is set by the style sheet creator and can be changed without affecting the base map (see the example code).

Identifies for the MapStyleSheetEntry dependency property.

Identifier for the MapStyleSheetEntry dependency property.

Gets or sets the name of the state of this MapElement. If the style sheet defines a style for that state, that style is applied to this element. Values defined in the style sheet for the state override values defined in the MapStyleSheetEntry.

The name of the state of this MapElement.

Identifies for the MapStyleSheetEntryState dependency property.

Identifier for the MapStyleSheetEntryState dependency property.

Gets or sets a value that determines the order in which elements of the MapControl receive focus when the user navigates through those elements by pressing the Tab key.

A value that determines the order of logical navigation across elements in a MapControl.

Identifies the MapTabIndex dependency property.

The identifier for the MapTabIndex dependency property.

Gets or sets an arbitrary object value that can be used to store custom information about this object.

An arbitrary object value that can be used to store custom information about this object.

Identifies the Tag dependency property.

The Tag dependency property.

Gets or sets a value that indicates whether the MapElement is visible on the MapControl.

**true** if the MapElement is visible on the MapControl; otherwise, **false**.

Identifies the Visible dependency property.

The identifier for the Visible dependency property.

Gets or sets the z-index of the MapElement. A MapElement with a higher z-index is displayed on top of a MapElement with a lower z-index.

The z-index of the MapElement.

Identifies the ZIndex dependency property.

The identifier for the ZIndex dependency property.

Represents a 3D element displayed on a MapControl.

Creates a MapElement3D instance.

Gets or sets the directional heading of the 3D map element in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West.

The directional heading of the map in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default value is 0.

Identifies the Heading dependency property.

The Heading dependency property.

Gets or sets the geographic location of the MapElement3D on the MapControl. .

The geographic location of the MapElement3D on the MapControl.

Identifies the LocationProperty dependency property.

The LocationProperty dependency property.

Gets or sets the 3D model that represents a 3D object.

the 3D model that represents a 3D object.

Gets or sets a value that indicates by how many degrees you want the 3D map element to be tilted. A value of 0 is looking out at the horizon and a value of -90 is looking straight down. A value of 90 is looking straight up. The default value is 0.

A value that indicates by how many degrees you want the 3D map element to be tilted.

Identifies the Pitch dependency property.

The Pitch dependency property.

Gets or sets the roll of the 3D map element in degrees, where -90 is tilting to the left and +90 is tilting to the right.

The roll of the 3D map element in degrees, where -90 is tilting to the left and +90 is tilting to the right.

Identifies the Pitch dependency property.

The Pitch dependency property.

The scale to apply to the 3D map element.

The scale to apply to the 3D map element. A value of Vector3 (1.0,1.0,1.0) is equivalent to 100%.

Identifies the Roll dependency property.

The Roll dependency property.

Provides data for the MapElementClick event.

Initializes a new instance of the MapElementClickEventArgs class.

Gets the geographic location that corresponds to where the MapControl received user input.

The geographic location that corresponds to where the MapControl received user input.

Gets a list of map elements that correspond to where the MapControl received user input.

A list of map elements that correspond to where the MapControl received user input.

Gets the physical position on the MapControl where it received user input.

The physical position on the MapControl where it received user input, in terms of X and Y coordinates.

Specifies the behavior of a MapIcon when it collides with other map features due to zoom level.

Hide the MapIcon when it collides with other map features.

Show the MapIcon at all zoom levels.

Provides data for the MapElementPointerEntered event.

Initializes a new instance of the MapElementPointerEnteredEventArgs class.

Gets the geographic location that corresponds to where the MapControl received user input.

The geographic location that corresponds to where the MapControl received user input.

Gets the map element that correspond to where the MapControl received user input.

The map element that correspond to where the MapControl received user input.

Gets the physical position on the MapControl where it received user input.

The physical position on the MapControl where it received user input, in terms of X and Y coordinates.

Provides data for the MapElementPointerExited event.

Initializes a new instance of the MapElementPointerExitedEventArgs class.

Gets the geographic location that corresponds to where the MapControl received user input.

The geographic location that corresponds to where the MapControl received user input.

Gets the map element that correspond to where the MapControl received user input.

The map element that correspond to where the MapControl received user input.

Gets the physical position on the MapControl where it received user input.

The physical position on the MapControl where it received user input, in terms of X and Y coordinates.

Represents a collection of map elements to which you can bind data and manipulate independently of other map elements.

Creates a MapElementsLayer instance.

Gets the collection of MapElement objects that are children of the MapElementsLayer.

The collection of MapElement objects that are children of the MapElementsLayer.

Identifies the MapElements dependency property.

The MapElements dependency property.

Occurs when the user has completed a context input gesture on a map layer, such as a right-click.

Occurs when the user taps or clicks a MapElement that has been add to the MapElementsLayer.

Occurs when a pointer moves into the bounding area of a MapElement on a MapElementsLayer.

Occurs when a pointer moves out of the bounding area of a MapElement on a MapElementsLayer.

Provides data for the MapElementClick event.

Initializes a new instance of the MapElementsLayerClickEventArgs class.

Gets the geographic location that corresponds to where the MapElementsLayer received user input.

The geographic location that corresponds to where the MapElementsLayer received user input.

Gets a list of map elements that correspond to where the MapElementsLayer received user input.

A list of map elements that correspond to where the MapElementsLayer received user input.

Gets the physical position on the MapElementsLayer where it received user input.

The physical position on the MapElementsLayer where it received user input, in terms of X and Y coordinates.

Provides event data for the MapContextRequested event.

Initializes a new instance of the MapElementsLayerContextRequestedEventArgs class.

Gets a geolocation on the map layer of a context input gesture, such as a right-click.

The geolocation on the map layer of a context input gesture, such as a right-click.

Gets a collection of MapElement objects at the point on the map layer specified by the Location property.

A collection of MapElement objects at the point on the map layer specified by the Location property.

Gets the x- and y-coordinate values that define the point on the map layer of a context input gesture, such as a right-click.

The x- and y-coordinate values that define the point on the map layer of a context input gesture, such as a right-click.

Provides data for the MapElementPointerEntered event.

Initializes a new instance of the MapElementsLayerPointerEnteredEventArgs class.

Gets the geographic location that corresponds to where the MapElementsLayer received user input.

The geographic location that corresponds to where the MapElementsLayer received user input.

Gets the map element that correspond to where the MapElementsLayer received user input.

The map element that correspond to where the MapElementsLayer received user input.

Gets the physical position on the MapElementsLayer where it received user input.

The physical position on the MapElementsLayer where it received user input, in terms of X and Y coordinates.

Provides data for the MapElementPointerExited event.

Initializes a new instance of the MapElementsLayerPointerExitedEventArgs class.

Gets the geographic location that corresponds to where the MapElementsLayer received user input.

The geographic location that corresponds to where the MapElementsLayer received user input.

Gets the map element that correspond to where the MapElementsLayer received user input.

The map element that correspond to where the MapElementsLayer received user input.

Gets the physical position on the MapElementsLayer where it received user input.

The physical position on the MapElementsLayer where it received user input, in terms of X and Y coordinates.

Displays an image such as a pushpin with optional text on a MapControl. Use the default image or provide a custom image.

Initializes a new instance of the MapIcon class.

Gets or sets the behavior of a MapIcon when it collides with other map features due to zoom level.

The behavior of a MapIcon when it collides with other map features due to zoom level.

Identifies the CollisionBehaviorDesired dependency property.

Identifier for the CollisionBehaviorDesired dependency property.

Gets or sets the image for the MapIcon. Provide an optional custom image to replace the default point of interest (POI) image.

The point of interest (POI) image for the MapIcon.

Gets or sets the geographic location of the MapIcon on the MapControl. The location is the geographic location on the MapControl at which the NormalizedAnchorPoint of the MapIcon is positioned.

The geographic location of the MapIcon on the MapControl.

Identifies the Location dependency property.

The identifier for the Location dependency property.

Gets or sets the anchor point of the MapIcon. The anchor point is the point on the MapIcon that is positioned at the point on the MapControl specified by the Location property.

The anchor point of the MapIcon.

Identifies the NormalizedAnchorPoint dependency property.

The identifier for the NormalizedAnchorPoint dependency property.

Gets or sets the optional text of the MapIcon.

The title of the MapIcon.

Identifies the Title dependency property.

The identifier for the Title dependency property.

Provides data about user input for the MapTapped, MapDoubleTapped, and MapHolding events of the MapControl.

Initializes a new instance of the MapInputEventArgs class.

Gets the geographic location on the MapControl that received user input.

The geographic location on the MapControl that received user input.

Gets the physical location on the MapControl that received user input.

The physical location on the MapControl that received user input.

Specifies if the map responds to a touch gesture and if the corresponding UI control appears on the map.

Map UI control, mouse, keyboard, pen, and touch input are enabled based on the type of device that your app is running on.

Map responds to the UI control only; the corresponding touch input is disabled.

Map UI control and touch input are disabled.

Map UI control and touch input are enabled. Pointer and keyboard are not.

Map responds to touch input only; the corresponding UI control is not visible. Use PointerAndKeyboard, if you want all forms of pointer input.

Map responds to mouse, pen, touch and keyboard.

All forms of input are enabled including mouse, pen, touch, keyboard, and Map UI control.

Map responds to mouse, pen, or touch only.

Contains a collection of XAML controls to be displayed on a MapControl.

Initializes a new instance of the MapItemsControl class.

Gets a collection of XAML controls to be displayed on a MapControl.

A collection of XAML controls to be displayed on a MapControl.

Identifies the Items dependency property.

The identifier for the Items dependency property.

Gets or sets a source that provides the content of the MapItemsControl.

A source that provides the content of the MapItemsControl.

Identifies the ItemsSource dependency property.

The identifier for the ItemsSource dependency property.

Gets or sets the DataTemplate used to display each item.

The DataTemplate used to display each item.

Identifies the ItemTemplate dependency property.

The identifier for the ItemTemplate dependency property.

Represents a collection of map data to which you can bind data and manipulate independently of other map types of map data.

Creates a MapLayer instance.

Gets or sets a value that determines the order in which objects of the MapLayer receive focus when the user navigates through those elements by pressing the Tab key.

A value that determines the order of logical navigation across elements in a MapLayer.

Identifies the MapTagIndex dependency property.

The MapTagIndex dependency property.

Gets or sets a value that indicates whether the MapLayer is visible on the MapControl.

**true** if the MapLayer is visible on the MapControl; otherwise, **false**.

Identifies the Visible dependency property.

The Visible dependency property.

Gets or sets the z-index of the MapLayer. A MapLayer with a higher z-index is displayed on top of a MapLayer with a lower z-index.

The z-index of the MapLayer.

Identifies the ZIndex dependency property.

The ZIndex dependency property.

Specifies the LoadingStatus of the MapControl.

Map data is unavailable.

Downloaded maps manager is unavailable

The map is loaded.

The map is loading.

Represents a 3D object to show on a map.

Creates an instance of a MapElement3D.

Creates an instance of a MapModel3D by importing a 3D object from a 3D Manufacturing Format (3MF) file.

A 3D Manufacturing Format (3MF) file file that describes a 3D object. A 3D model object.

Creates an instance of a MapModel3D by importing a 3D object from a 3D Manufacturing Format (3MF) file.

A 3D Manufacturing Format (3MF) file file that describes a 3D object. The type of shading that you would like to appear for the object. A 3D model object.

Specifies the type of shading that you want to appear for 3D objects.

The vertex normals of the imported 3D model or flat shading if that data is not available.

Flat shading.

Smooth shading.

Specifies if the pan gesture is recognized on the map.

Panning touch gestures are recognized on the map.

Panning touch gestures are not recognized on the map.

Represents a polygon on a MapControl.

Initializes a new instance of the MapPolygon class.

Gets or sets the color used to fill the MapPolygon.

The color to be used to fill the MapPolygon.

Gets or sets the collection of coordinates that define the MapPolygon shape.

The collection of coordinates that define the MapPolygon shape.

Identifies the Path dependency property.

The identifier for the Path dependency property.

Gets a list of Geopath objects that define the MapPolygon shape.

A list of Geopath objects that define the MapPolygon shape.

Gets or sets the color used to draw the MapPolygon.

The color to be used to draw the MapPolygon.

Gets or sets a value that indicates whether the line used to draw the MapPolygon is dashed.

**true** if the line used for drawing the MapPolygon is dashed; otherwise, **false**.

Identifies the StrokeDashed dependency property.

The identifier for the StrokeDashed dependency property.

Gets or sets the width of the line used to draw the MapPolygon, in logical pixels.

The width of the line used to draw the MapPolygon, in logical pixels.

Identifies the StrokeThickness dependency property.

The identifier for the StrokeThickness dependency property.

Represents a polyline on a MapControl.

Initializes a new instance of the MapPolyline class.

Gets or sets the collection of coordinates that define the MapPolyline shape.

The collection of coordinates that define the MapPolyline shape.

Identifies the Path dependency property.

The identifier for the Path dependency property.

Gets or sets the color used to draw the MapPolyline.

The color to be used to draw the MapPolyline.

Gets or sets a value that indicates whether the line used to draw the MapPolyline is dashed.

**true** if the line used for drawing the MapPolyline is dashed; otherwise, **false**.

Identifies the StrokeDashed dependency property.

The identifier for the StrokeDashed dependency property.

Gets or sets the width of the line used to draw the MapPolyline, in logical pixels.

The width of the line used to draw the MapPolyline, in logical pixels.

Specifies how to transform the latitudes and longitudes of the map

Globe projection. World map appears as a globe that can be rotated.

The Web Mercator projection. World map appears as a flat surface.

Provides data for the MapRightTapped event.

Initializes a new instance of the MapRightTappedEventArgs class.

Gets the geographic location that corresponds to where the MapControl received user input.

The geographic location that corresponds to where the MapControl received user input.

Gets the physical position on the MapControl where it received user input.

The physical position on the MapControl where it received user input, in terms of X and Y coordinates.

Displays a MapRoute on a MapControl.

Initializes a new instance of the MapRouteView class with the specified MapRoute.

The route to display on the map.

Gets or sets the color of the outline of the route displayed in the MapRouteView.

The color of the outline of the route displayed in the MapRouteView.

Gets the MapRoute displayed by the MapRouteView.

The MapRoute displayed by the MapRouteView.

Gets or sets the color of the route displayed in the MapRouteView.

The color of the route displayed in the MapRouteView.

Represents a view of a map.

Gets the MapCamera settings that define the final position of the camera.

The MapCamera settings that define the final position of the camera.

Occurs when the final position of the map's camera has changed.

Creates a scene to appear in a map based on a four-sided geographic area.

The four-sided geographic area to appear in the scene. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on a four-sided geographic area, heading, and pitch.

The four-sided geographic area to appear in the scene. The directional heading of the map's camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on the position of the specified MapCamera.

The current position of the specified camera. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on a single geographic location.

The center of the scene. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on a single geographic location, heading, and pitch.

The center of the scene. The directional heading of the map's camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on a single geographic location and radius.

The center of the scene. The radius around the center to appear in the scene, in meters. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on a single geographic location, radius, heading, and pitch.

The center of the scene. The radius around the center to appear in the scene, in meters. The directional heading of the map's camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on multiple geographic locations.

The locations to appear in the scene. Represents a view of a map in the MapControl.

Creates a scene to appear in a map based on multiple geographic locations, a heading, and pitch.

The locations to appear in the scene. The directional heading of the map's camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 0. Represents a view of a map in the MapControl.

Specifies the Style of the MapControl.

An aerial map.

An aerial 3D map.

A hybrid map that combines an aerial 3D map with roads.

A hybrid map that combines an aerial map with roads.

A style is not specified.

A road map.

A terrain map.

Represents a set of rules that define the style of the map in a map control. This class provides methods to:

Gets a MapStyleSheet that presents an aerial view of the map.

A MapStyleSheet that presents an aerial view of the map.

Gets a MapStyleSheet that presents a hybrid map that combines an aerial map with roads.

A MapStyleSheet that presents a hybrid map that combines an aerial map with roads.

Combines the rules defined in two MapStyleSheet instances.

The MapStyleSheet instances that you want to combine. A MapStyleSheet instance that contains the combined rules defined in each MapStyleSheet instance that you passed to the *styleSheets* parameter.

Creates a stylesheet by parsing a JSON markup string that defines a set of custom rules.

A JSON markup string that defines a set of custom rules. A MapStyleSheet that represents the rules defined in JSON markup string.

Gets a MapStyleSheet that presents a road map with a dark theme.

A MapStyleSheet that presents a road map with a dark theme.

Gets a MapStyleSheet styles the map with a high contrast dark theme.

A MapStyleSheet styles the map with a high contrast dark theme.

Gets a MapStyleSheet styles the map with a high contrast light theme.

A MapStyleSheet styles the map with a high contrast light theme.

Gets a MapStyleSheet that presents a road map with a light theme.

A MapStyleSheet that presents a road map with a light theme.

Creates stylesheet by parsing a JSON markup string that defines a set of custom rules.

A JSON markup string that defines a set of custom rules. The MapStyleSheet that will represent the rules defined in JSON markup string. **true** if the operation completed successfully; otherwise, **false**.

Provides the names of JavaScript Object Notation (JSON) supported style entries in the map style sheet.

Gets the JSON entry name that represents admin1, states, provinces, etc.

The JSON entry name that represents admin1, states, provinces, etc.

Gets the JSON entry name for icons that represent the capital of a state or province.

The JSON entry name for icons that represent the capital of a state or province.

Gets the JSON entry name that represents areas that encompass an airport.

The JSON entry name that represents areas that encompass an airport.

Gets the JSON entry name that represents areas of land use.

The JSON entry name that represents areas of land use.

Gets the JSON entry name for lines that represent main roads with heavy traffic.

The JSON entry name for lines that represent main roads with heavy traffic.

Gets the JSON entry name that represents a building.

The JSON entry name that represents a building.

Gets the JSON entry name that represents restaurants, hospitals, schools, etc.

The JSON entry name that represents restaurants, hospitals, schools, etc.

Gets the JSON entry name for icons that represent the capital of a populated place.

The JSON entry name for icons that represent the capital of a populated place.

Gets the JSON entry name that represents areas of cemeteries.

The JSON entry name that represents areas of cemeteries.

Gets the JSON entry name that represents areas of entire continents.

The JSON entry name that represents areas of entire continents.

Gets the JSON entry name for lines that represent highways with restricted access.

The JSON entry name for lines that represent highways with restricted access.

Gets the JSON entry name that represents a country.

The JSON entry name that represents a country.

Gets the JSON entry name for icons that represent the capital of a country or region.

The JSON entry name for icons that represent the capital of a country or region.

Gets the JSON entry name that represents admin2, counties, etc.

The JSON entry name that represents admin2, counties, etc.

Gets the JSON entry name that represents a driving route.

The JSON entry name that represents a driving route.

Gets the JSON entry name that represents areas of schools.

The JSON entry name that represents areas of schools.

Gets the JSON entry name that represents an educational building such as a school.

The JSON entry name that represents an educational building such as a school.

Gets the JSON entry name that represents restaurants, cafés, etc.

The JSON entry name that represents restaurants, cafés, etc.

Gets the JSON entry name that represents area of forest land.

The JSON entry name that represents area of forest land.

Gets the JSON entry name that represents areas of golf courses.

The JSON entry name that represents areas of golf courses.

Gets the JSON entry name for lines that represent ramps. These ramps typically appear alongside of controlled access highways.

The JSON entry name for lines that represent ramps. These ramps typically appear alongside of controlled access highways.

Gets the JSON entry name for lines that represent highways.

The JSON entry name for lines that represent highways.

Gets the JSON entry name that represents areas of Indian reservations.

The JSON entry name that represents areas of Indian reservations.

Gets the JSON entry name that represents labels in island areas.

The JSON entry name that represents labels in island areas.

Gets the JSON entry name for lines that represent main roads.

The JSON entry name for lines that represent main roads.

Gets the JSON entry name that represents areas of land that are used for medical purposes (For example: a hospital campus).

The JSON entry name that represents areas of land that are used for medical purposes (For example: a hospital campus).

Gets the JSON entry name that represents buildings that are used for medical purposes (For example: a hospital).

The JSON entry name that represents buildings that are used for medical purposes (For example: a hospital).

Gets the JSON entry name that represents areas of military bases.

The JSON entry name that represents areas of military bases.

Gets the JSON entry name for icons that represent natural landmarks such as a volcano peak or waterfall.

The JSON entry name for icons that represent natural landmarks such as a volcano peak or waterfall.

Gets the JSON entry name that represents areas of land that are used for nautical purposes.

The JSON entry name that represents areas of land that are used for nautical purposes.

Gets the JSON entry name that represents labels in areas defined as neighborhoods.

The JSON entry name that represents labels in areas defined as neighborhoods.

Gets the JSON entry name that represents park areas.

The JSON entry name that represents park areas.

Gets the JSON entry name for icons that represent mountain peaks.

The JSON entry name for icons that represent mountain peaks.

Gets the JSON entry name that represents extracted pitches such as a baseball field or tennis court.

The JSON entry name that represents extracted pitches such as a baseball field or tennis court.

Gets the JSON entry name that represents all point features that are rendered with an icon of some sort.

The JSON entry name that represents all point features that are rendered with an icon of some sort.

Gets the JSON entry name that represents restaurants, hospitals, schools, marinas, ski areas, etc.

The JSON entry name that represents restaurants, hospitals, schools, marinas, ski areas, etc.

Gets the JSON entry name for political regions such as countries, regions and states.

The JSON entry name for political regions such as countries, regions and states.

Gets the JSON entry name for icons that represent the size of populated place (For example: a city or town).

The JSON entry name for icons that represent the size of populated place (For example: a city or town).

Gets the JSON entry name that represents railway lines.

The JSON entry name that represents railway lines.

Gets the JSON entry name that represents lines that represent the entrance and exit of a highway.

The JSON entry name that represents lines that represent the entrance and exit of a highway.

Gets the JSON entry name that represents areas of nature reserves.

The JSON entry name that represents areas of nature reserves.

Gets the JSON entry name that represents rivers, streams, or other water passages.

the JSON entry name that represents rivers, streams, or other water passages.

Gets the JSON entry name for lines that represent all roads.

The JSON entry name for lines that represent all roads.

Gets the JSON entry name for icons that represent exits, typically from a controlled access highway.

The JSON entry name for icons that represent exits, typically from a controlled access highway.

Gets the JSON entry name for signs that represent the compact name for a road. (For example: I-5).

The JSON entry name for signs that represent the compact name for a road. (For example: I-5).

Gets the JSON entry name that represents the styling for all route lines.

The JSON entry name that represents the styling for all route lines.

Gets the JSON entry name that represents land areas that are covered by a runway.

The JSON entry name that represents land areas that are covered by a runway.

Gets the JSON entry name that represents sandy areas like beaches.

The JSON entry name that represents sandy areas like beaches.

Gets the JSON entry name that represents areas of ground allocated for malls or other shopping centers.

The JSON entry name that represents areas of ground allocated for malls or other shopping centers.

Gets the JSON entry name that represents area of a stadium.

The JSON entry name that represents area of a stadium.

Gets the JSON entry name for lines that represent streets.

The JSON entry name for lines that represent streets.

Gets the JSON entry name that represents building and other building-like structures.

The JSON entry name that represents building and other building-like structures.

Gets the JSON entry name that represents roads that cost money to use.

The JSON entry name that represents roads that cost money to use.

Gets the JSON entry name that represents walking trails through parks or hiking trails.

The JSON entry name that represents walking trails through parks or hiking trails.

Gets the JSON entry name for icons that represent bus stops, train stops, airports, etc.

The JSON entry name for icons that represent bus stops, train stops, airports, etc.

Gets the JSON entry name that represents a transit building such as a bus station.

The JSON entry name that represents a transit building such as a bus station.

Gets the JSON entry name that represents lines that are part of the transportation network (For example: roads, trains, and ferries).

The JSON entry name that represents lines that are part of the transportation network (For example: roads, trains, and ferries).

Gets the JSON entry name for lines that represent unpaved streets.

The JSON entry name for lines that represent unpaved streets.

Gets the JSON entry name that represents forests, grassy areas, etc.

The JSON entry name that represents forests, grassy areas, etc.

Gets the JSON entry name for icons that represent volcano peaks.

The JSON entry name for icons that represent volcano peaks.

Gets the JSON entry name that represents a walking route.

The JSON entry name that represents a walking route.

Gets the JSON entry name that represents anything that looks like water. This includes oceans and streams.

The JSON entry name that represents anything that looks like water. This includes oceans and streams.

Gets the JSON entry name for icons that represent water feature locations such as a waterfall.

The JSON entry name for icons that represent water feature locations such as a waterfall.

Gets the JSON entry name that represents ferry route lines.

The JSON entry name that represents ferry route lines.

Provides the names of the supported style entry states of a map style sheet. These states map to state-specific styles defined in the map's style sheet.

Gets the name for the disabled visual state of the MapElement.

The name for the disabled visual state of the MapElement.

Gets the name for the hover visual state of the MapElement.

The name for the hover visual state of the MapElement.

Gets the name for the selected visual state of the MapElement.

The name for the selected visual state of the MapElement.

Provides data for the TargetCameraChanged event.

Initializes a new instance of the MapTargetCameraChangedEventArgs class.

Gets the camera position corresponding to the TargetCameraChanged event.

The camera position corresponding to the TargetCameraChanged event.

Gets or sets the camera change reason.

The reason the camera changed.

Specifies the AnimationState of the MapTileSource.

The map tile animation is paused. If the MapTileSource was playing an animation, it continues to display the current frame.

The map tile animation is playing.

The map tile animation is not playing or paused.

Represents a bitmap request for a tile for a CustomMapTileDataSource.

Initializes a new instance of MapTileBitmapRequest class.

Gets the bitmap data for the CustomMapTileDataSource.

The bitmap data.

Gets a MapTileBitmapRequestDeferral that the app can use to respond asynchronously to the bitmap request.

The deferral object that the app uses to indicate that it has finished responding to a BitmapRequested event and that the request is complete.

Represents a deferral that can be used by an app to respond asynchronously to a bitmap request for a tile.

Initializes a new instance of the MapTileBitmapRequestDeferral class.

Notifies the system that the app has finished processing the bitmap request for a tile.

Provides data for the CustomMapTileDataSource.BitmapRequested event.

Initializes a new instance of the MapTileBitmapRequestedEventArgs class.

Gets the number of frame of the requested tile.

The number of frame of the requested tile.

Gets the bitmap request.

The bitmap request.

Gets the X value of the requested tile.

The X value of the requested tile.

Gets the Y value of the requested tile.

The Y value of the requested tile.

Gets the zoom level of the requested tile.

The zoom level of the requested tile.

Provides a source of tiles for a MapTileSource. This class serves as the base class for HttpMapTileDataSource, LocalMapTileDataSource, and CustomMapTileDataSource.

Initializes a new instance of the MapTileDataSource class.

Specifies the Layer type of a MapTileSource.

The MapTileSource is an area overlay.

The MapTileSource is a background overlay.

The MapTileSource is a background replacement overlay.

The MapTileSource is a label overlay.

The MapTileSource is a road overlay.

Represents a source of tiles to overlay on the MapControl.

Initializes a new instance of the MapTileSource class.

Initializes a new instance of the MapTileSource class with the specified data source.

The data source to use for the tiles.

Initializes a new instance of the MapTileSource class with the specified data source and zoom level range.

The data source to use for the tiles. The zoom level range for the tiles.

Initializes a new instance of the MapTileSource class with the specified data source, zoom level range, and bounding rectangle.

The data source to use for the tiles. The zoom level range for the tiles. The geographic area of tiles requested.

Initializes a new instance of the MapTileSource class with the specified data source, zoom level range, bounding rectangle, and tile size.

The data source to use for the tiles. The zoom level range for the tiles. The geographic area of tiles requested. The size of individual square tiles in pixels.

Gets or sets a value that specifies whether to stretch the current tile while a higher-resolution tile is being downloaded.

**true** to stretch the current tile while a higher-resolution tile is being downloaded; otherwise, **false**.

Identifies the AllowOverstretch dependency property.

The identifier for the AllowOverstretch dependency property.

Gets the animation state of this MapTileSource to be displayed in the MapControl.

The animation state of this MapTileSource.

Identifies the AnimationState dependency property.

The identifier for the AnimationState dependency property.

Gets or sets a value that indicates whether map tiles will begin playback automatically when this MapTileSource gets added to the TileSources property of the MapControl.

**true** if playback is automatic; otherwise, **false**. The default is **true**.

Identifies the AutoPlay dependency property.

The identifier for the AutoPlay dependency property.

Gets or sets the rectangular area to contain the tiles.

The rectangular area to contain the tiles.

Identifies the Bounds dependency property.

The identifier for the Bounds dependency property.

Gets or sets the data source for the tiles.

The data source for the tiles.

Identifies the DataSource dependency property.

The identifier for the DataSource dependency property.

Gets or sets the number of frames in the animation of this MapTileSource.

The number of frames in the animation of this MapTileSource.

Identifies the FrameCount dependency property.

The identifier for the FrameCount dependency property.

Gets or sets the time duration of each frame in the animation of this MapTileSource.

The time duration of each frame in the animation of this MapTileSource.

Identifies the FrameDuration dependency property.

The identifier for the FrameDuration dependency property.

Gets or sets a value that indicates whether fading is enabled for the tiles.

**true** if fading is enabled for the tiles; otherwise, **false**.

Identifies the IsFadingEnabled dependency property.

The identifier for the IsFadingEnabled dependency property.

Gets or sets a value that indicates whether retry is enabled for the tiles.

**true** if retry is enabled for the tiles; otherwise, **false**.

Identifies the IsRetryEnabled dependency property.

The identifier for the IsRetryEnabled dependency property.

Gets or sets a value that indicates whether transparency is enabled for the tiles.

**true** if transparency is enabled for the tiles; otherwise, **false**.

Identifies the IsTransparencyEnabled dependency property.

The identifier for the IsTransparencyEnabled dependency property.

Gets or sets the layer that contains the tiles.

The layer that contains the tiles.

Identifies the Layer dependency property.

The identifier for the Layer dependency property.

Gets or sets the size of the tiles in pixels.

The size of the tiles in pixels.

Identifies the TilePixelSize dependency property.

The identifier for the TilePixelSize dependency property.

Gets or sets a value that indicates whether the MapTileSource is visible.

**true** if the MapTileSource is visible; otherwise, **false**.

Identifies the Visible dependency property.

The identifier for the Visible dependency property.

Gets or sets the z-index of the tiles.

The z-index of the tiles.

Identifies the ZIndex dependency property.

The identifier for the ZIndex dependency property.

Gets or sets the minimum and maximum zoom level of the tiles. Tiles are only visible when the ZoomLevel of the MapControl is within the ZoomLevelRange.

The minimum and maximum zoom level of the tiles.

Identifies the ZoomLevelRange dependency property.

The identifier for the ZoomLevelRange dependency property.

Pauses the animation at the current frame.

Plays the animation from the current frame.

Stops and resets the animation to be played from the beginning.

Represents a Uri request for a tile for an HttpMapTileDataSource or a LocalMapTileDataSource.

Initializes a new instance of the MapTileUriRequest class.

Gets the Uri of the request.

The Uri of the request.

Gets a MapTileUriRequestDeferral that the app can use to respond asynchronously to the Uri request.

A MapTileUriRequestDeferral that the app can use to respond asynchronously to the Uri request.

Represents a deferral that can be used by an app to respond asynchronously to a Uri request for a tile.

Initializes a new instance of the MapTileUriRequestDeferral class.

Notifies the system that the app has finished processing the Uri request for a tile.

Provides data for the HttpMapTileDataSource.UriRequested event and the LocalMapTileDataSource.UriRequested event.

Initializes a new instance of the MapTileUriRequestedEventArgs class.

Gets the number of frame of the requested tile.

The number of frame of the requested tile.

Gets the Uri request.

The Uri request.

Gets the X value of the requested tile.

The X value of the requested tile.

Gets the Y value of the requested tile.

The Y value of the requested tile.

Gets the zoom level of the requested tile.

The zoom level of the requested tile.

Indicates the kind of visible region.

The full visible region of the map control.

Visible region on the map control that doesn't include things that are further away towards the horizon and is orthogonal to whether landmarks are present or not.

Specifies the WatermarkMode of the MapControl.

The watermark of the MapControl is turned on or off according to OEM settings.

The watermark of the MapControl is displayed.

Specifies the minimum and maximum zoom level for a MapTileSource. This structure is used by the ZoomLevelRange property of a MapTileSource.

The maximum zoom level for a MapTileSource.

The minimum zoom level for a MapTileSource.

Represents a custom map experience that provides a street-level view of a geographic location.

Creates a StreetsideExperience based on the specified panoramic view.

The panoramic view to appear in the StreetsideExperience.

Creates a StreetsideExperience based on the specified panoramic view and camera position.

The panoramic view to appear in the StreetsideExperience. The directional heading of the map's camera in degrees, where 0 or 360 = North, 90 = East, 180 = South, and 270 = West. The default *headingInDegrees* value is 0. The pitch of the map's camera in degrees, where 90 is looking out at the horizon (maximum) and 0 is looking straight down (minimum). The default *pitchInDegrees* value is 90. The horizontal angle of view that appears in the map's camera, in degrees. The default *fieldOfViewInDegrees* value is 75.

Gets or sets a value that indicates if address text is visible in the StreetsideExperience.

**true** if address text is visible in the StreetsideExperience; otherwise, **false**.

Gets or sets a value that indicates if the cursor is visible in the StreetsideExperience.

**true** if the cursor is visible in the StreetsideExperience; otherwise, **false**.

Gets or sets a value that indicates if the exit button is visible in the StreetsideExperience.

**true** if the exit button is visible in the StreetsideExperience; otherwise, **false**.

Gets or sets a value that indicates if the overview map is visible in the StreetsideExperience.

**true** if the overview map is visible in the StreetsideExperience; otherwise, **false**.

Gets or sets a value that indicates if street labels are visible in the StreetsideExperience.

**true** if street labels are visible in the StreetsideExperience; otherwise, **false**.

Gets or sets a value that indicates if zoom buttons are visible in the StreetsideExperience.

**true** if zoom buttons are visible in the StreetsideExperience; otherwise, **false**.

Represents a panoramic view of a geographic location from a street-level perspective.

Gets the geographic location that corresponds to the StreetsidePanorama.

The geographic location that corresponds to the StreetsidePanorama.

Creates a StreetsidePanorama near the specified geographic location.

The center of the panoramic view. If available, the nearest StreetsidePanorama; otherwise, **null**.

Creates a StreetsidePanorama near the specified geographic location and radius.

The center of the panoramic view. The radius to appear in the panoramic view, in meters. If available, the nearest StreetsidePanorama; otherwise, **null**.

Defines constants that specify the direction in which an animation translates from start to end.

The animation or transition progresses in a down direction.

The animation or transition progresses in a left direction.

The animation or transition progresses in a right direction.

The animation or transition progresses in an up direction.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for an AppBarButton control. Not intended for general use.

Gets the minimum width allocated for the accelerator key tip of an AppBarButton.

A number that specifies the minimum width allocated for the accelerator key tip of an AppBarButton.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for an AppBar control. Not intended for general use.

Gets the Rect that describes the clipped area of the AppBar.

A Rect that describes the clipped area of the AppBar.

Gets the margin of the AppBar root in the compact state.

The margin of the AppBar root in the compact state.

Gets the vertical delta of the AppBar in the compact state.

The vertical delta of the AppBar in the compact state.

Gets the margin of the AppBar root in the hidden state.

The margin of the AppBar root in the hidden state.

Gets the vertical delta of the AppBar in the hidden state.

The vertical delta of the AppBar in the hidden state.

Gets the margin of the AppBar root in the minimal state.

The margin of the AppBar root in the minimal state.

Gets the vertical delta of the AppBar in the minimal state.

The vertical delta of the AppBar in the minimal state.

Gets the negative vertical delta of the AppBar in the compact state.

The negative vertical delta of the AppBar in the compact state.

Gets the negative vertical delta of the AppBar in the hidden state.

The negative vertical delta of the AppBar in the hidden state.

Gets the negative vertical delta of the AppBar in the minimal state.

The negative vertical delta of the AppBar in the minimal state.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for an AppBarToggleButton control. Not intended for general use.

Gets the minimum width allocated for the accelerator key tip of an AppBarToggleButton.

A number that specifies the minimum width allocated for the accelerator key tip of an AppBarToggleButton.

Represents the base class for all button controls, such as Button, RepeatButton, and HyperlinkButton.

Provides base class initialization behavior for ButtonBase derived classes.

Gets or sets a value that indicates when the Click event occurs, in terms of device behavior.

A value of the enumeration that indicates when the Click event occurs.

Identifies the ClickMode dependency property.

The identifier for the ClickMode dependency property.

Gets or sets the command to invoke when this button is pressed.

The command to invoke when this button is pressed. The default is null.

Gets or sets the parameter to pass to the Command property.

The parameter to pass to the Command property. The default is null.

Identifier for the CommandParameter dependency property.

The identifier for the CommandParameter dependency property.

Identifier for the Command dependency property.

The identifier for the Command dependency property.

Gets a value that indicates whether a device pointer is located over this button control.

**True** if a pointer is over the button control; otherwise **false**. The default is **false**.

Identifies the IsPointerOver dependency property.

The identifier for the IsPointerOver dependency property.

Gets a value that indicates whether a ButtonBase is currently in a pressed state.

**True** if the ButtonBase is in a pressed state; otherwise **false**. The default is **false**.

Identifies the IsPressed dependency property.

The identifier for the IsPressed dependency property.

Occurs when a button control is clicked.

Represents a panel that contains a calendar.

Initializes a new instance of the CalendarPanel class.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a CalendarView control. Not intended for general use.

Gets the X coordinate of the CalendarView 's center point.

The X coordinate of the CalendarView 's center point.

Gets the Y coordinate of the CalendarView 's center point.

The Y coordinate of the CalendarView 's center point.

Gets the rectangle used to clip the CalendarView.

The rectangle used to clip the CalendarView.

Gets a value that indicates whether the CalendarView has more content after the displayed content.

**true** if the CalendarView has more content after the displayed content; otherwise, **false**.

Gets a value that indicates whether the CalendarView has more content before the displayed content.

**true** if the CalendarView has more content after the displayed content; otherwise, **false**.

Gets a value that indicates whether the CalendarView has more views (like year or decade) that can be shown.

**true** if the CalendarView has more views (like year or decade) that can be shown; otherwise, **false**.

Gets the text of the header.

The text of the header.

Gets the minimum width of the view.

The minimum width of the view.

Gets the first day of the week.

The first day of the week.

Gets the second day of the week.

The second day of the week.

Gets the third day of the week.

The third day of the week.

Gets the fourth day of the week.

The fourth day of the week.

Gets the fifth day of the week.

The fifth day of the week.

Gets the sixth day of the week.

The sixth day of the week.

Gets the seventh day of the week.

The seventh day of the week.

Represents a panel that arranges its items in a line and circles around to the first item when the last item is reached.

Initializes a new instance of the CarouselPanel class.

Gets a value that indicates whether the horizontal snap points for the CarouselPanel are equidistant from each other.

**true** if the horizontal snap points for the CarouselPanel are equidistant from each other; otherwise, **false**.

Gets a value that indicates whether the vertical snap points for the CarouselPanel are equidistant from each other.

**true** if the vertical snap points for the CarouselPanel are equidistant from each other; otherwise, **false**.

Not intended for general use. Gets or sets a value that indicates whether scrolling on the horizontal axis is possible.

**true** if scrolling is possible; otherwise, **false**.

Not intended for general use. Gets or sets a value that indicates whether scrolling on the vertical axis is possible.

**true** if scrolling is possible; otherwise, **false**.

Gets the vertical size of the panel extent.

A value in pixels.

Gets the horizontal size of the panel extent.

A value in pixels.

Gets the horizontal offset of the scrolled content.

A value in pixels.

Gets or sets a reference to a ScrollViewer that is the scroll host or scroll owner for scrolling behavior of the CarouselPanel.

The scroll host or scroll owner for scrolling behavior.

Gets the vertical offset of the scrolled content.

A value in pixels.

Gets the vertical size of the viewport/content area.

A value in pixels.

Gets the horizontal size of the viewport/content area.

A value in pixels.

Occurs when the measurements for horizontal snap points change.

Occurs when the measurements for vertical snap points change.

Returns the set of distances between irregular snap points for a specified orientation and alignment.

The orientation/dimension for the desired snap point set. The alignment to use when applying the snap points. The read only collection of snap point distances. Returns an empty collection when no snap points are present.

Gets the distance between regular snap points for a specified orientation and alignment.

The orientation/dimension for the desired snap point set. The alignment to use when applying the snap points. Out parameter. The offset of the first snap point. The distance between the equidistant snap points. Returns 0 when no snap points are present.

Scrolls content by one line towards the bottom.

Scrolls content by one line towards the left.

Scrolls content by one line towards the right.

Scrolls content by one line towards the top.

Changes existing offsets in order to make the provided element visible in the viewport, and returns a Rect measurement and position of the area.

The element to make visible. A rectangle representing the element's coordinate space. A rectangle that represents the input *rectangle* Rect transformed by using the CarouselPanel coordinate space.

Scrolls content by one mousewheel click towards the bottom.

Scrolls content by one mousewheel click towards the left.

Scrolls content by one mousewheel click towards the right.

Scrolls content by one mousewheel click towards the top.

Scrolls content by one page towards the bottom.

Scrolls content by one page towards the left.

Scrolls content by one page towards the left.

Scrolls content by one page towards the top.

Changes the horizontal offset of content within the CarouselPanel viewport.

The horizontal offset to set, in pixels.

Changes the vertical offset of content within the CarouselPanel viewport.

The vertical offset to set, in pixels.

Represents a slider in a ColorPicker control.

Initializes a new instance of the ColorPickerSlider class.

Gets or sets a value that indicates which color channel the slider modifies.

A value of the enumeration that indicates which color channel the slider modifies.

Identifies the ColorChannel dependency property.

The identifier for the ColorChannel dependency property.

Represents a control that lets a user choose a color from a visual spectrum.

Initializes a new instance of the ColorSpectrum class.

Gets or sets the current color value.

The current color value.

Identifies the Color dependency property.

The identifier for the Color dependency property.

Gets or sets a value that indicates how the Hue-Saturation-Value (HSV) color components are mapped onto the ColorSpectrum.

A value of the enumeration. The default is **HueSaturation**.

Identifies the Components dependency property.

The identifier for the Components dependency property.

Gets or sets the current color value as a Vector4.

The current HSV color value.

Identifies the HsvColor dependency property.

The identifier for the HsvColor dependency property.

Gets or sets the maximum Hue value in the range 0-359.

The maximum Hue value in the range 0-359. The default is 359.

Identifies the MaxHue dependency property.

The identifier for the MaxHue dependency property.

Gets or sets the maximum Saturation value in the range 0-100.

The maximum Saturation value in the range 0-100. The default is 100.

Identifies the MaxSaturation dependency property.

The identifier for the MaxSaturation dependency property.

Gets or sets the maximum Value value in the range 0-100.

The maximum Value value in the range 0-100. The default is 100.

Identifies the MaxValue dependency property.

The identifier for the MaxValue dependency property.

Gets or sets the minimum Hue value in the range 0-359.

The minimum Hue value in the range 0-359. The default is 0.

Identifies the MinHue dependency property.

The identifier for the MinHue dependency property.

Gets or sets the minimum Saturation value in the range 0-100.

The minimum Saturation value in the range 0-100. The default is 100.

Identifies the MinSaturation dependency property.

The identifier for the MinSaturation dependency property.

Gets or sets the minimum Value value in the range 0-100.

The minimum Value value in the range 0-100. The default is 100.

Identifies the MinValue dependency property.

The identifier for the MinValue dependency property.

Gets or sets a value that indicates whether the ColorSpectrum is shown as a square or a circle.

A value of the enumeration. The default is **Box**, which shows the spectrum as a square.

Identifies the Shape dependency property.

The identifier for the Shape dependency property.

Occurs when the Color property has changed.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ComboBox control. Not intended for general use.

Gets a value that reports the run-time layout slot height of the "Popup" part of a ComboBox in the "Closed" state.

The run-time layout slot height, in pixels.

Gets the minimum width value of the drop down content.

The minimum width value of the drop down content.

Gets a value that reports the run-time offset value that is useful for a **Split** animation of the "Popup" part of a ComboBox.

The run-time offset value in pixels.

Gets a value that reports the run-time layout slot height of the "Popup" part of a ComboBox in the "Opened" state.

The run-time layout slot height, in pixels.

Gets a value that reports the selection direction in a ComboBox. This is either **Bottom** or **Top** depending on how DropDownOffset is set.

A value of the enumeration.

Represents a specialized command bar used in a CommandBarFlyout.

Initializes a new instance of the CommandBarFlyoutCommandBar class.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for a CommandBarFlyoutCommandBar control.

An object that provides calculated values for templates.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a CommandBarFlyout control. Not intended for general use.

Gets the end position for the close animation.

The end position for the animation.

Gets the rectangle used to clip the content.

The rectangle used to clip the content.

Gets the current width of the control.

The current width of the control.

Gets the end position for the expand down animation.

The end position for the animation.

Gets the hold position for the expand down animation.

The hold position for the animation.

Gets the start position for the expand down animation.

The start position for the animation.

Gets the vertical position of the overflow when expanded down.

The vertical position of the overflow when expanded down.

Gets the width of the control when expanded.

The width of the control when expanded.

Gets the end position for the expand up animation.

The end position for the animation.

Gets the hold position for the expand up animation.

The hold position for the animation.

Gets the start position for the expand up animation.

The start position for the animation.

Gets the vertical position of the overflow when expanded up.

The vertical position of the overflow when expanded up.

Gets the end position for the open animation.

The end position for the animation.

Gets the start position for the open animation.

The start position for the animation.

Gets the rectangle used to clip the overflow content.

The rectangle used to clip the overflow content.

Gets the end position for the width expansion animation.

The end position for the animation.

Gets the start position for the width expansion animation.

The start position for the animation.

Gets the amount of change for the width expansion.

The amount of change for the width expansion.

Gets the end position for the "more" button width expansion animation.

The end position for the animation.

Gets the start position for the "more" button width expansion animation.

The start position for the animation.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a CommandBar control. Not intended for general use.

Gets the height of the CommandBar content.

The height of the CommandBar content.

Gets the effective visibility of the command bar's overflow button.

The effective visibility of the command bar's overflow button.

Gets the height of the overflow content when the overflow direction is negative.

The height of the overflow content when the overflow direction is negative.

Gets the Rect that describes the clipped area of the overflow content.

A Rect that describes the clipped area of the overflow content.

Gets the translation of the overflow content on the Y-axis in the compact state.

The translation of the overflow content on the Y-axis in the compact state.

Gets the height of the overflow content.

The height of the overflow content.

Gets the translation of the overflow content on the Y-axis in the hidden state.

The translation of the overflow content on the Y-axis in the hidden state.

Gets the horizontal offset value of the overflow content.

The horizontal offset value of the overflow content.

Gets the maximum height value of the overflow content.

The maximum height value of the overflow content.

Gets the maximum width value of the overflow content.

The maximum width value of the overflow content.

Gets the translation of the overflow content on the Y-axis in the minimal state.

The translation of the overflow content on the Y-axis in the minimal state.

Gets the minimum width value of the overflow content.

The minimum width value of the overflow content.

Defines constants that specify the lookup behavior for references to application resources by Uniform Resource Identifier (URI) path.

Lookup treats the APPXPACKAGE as the root.

Lookup expects that the resource is a nested resource of a component.

Provides data for the DragCompleted event that occurs when a user completes a drag operation with the mouse of a Thumb control.

Initializes a new instance of the DragCompletedEventArgs class.

The horizontal change in position of the Thumb control, resulting from the drag operation. The vertical change in position of the Thumb control, resulting from the drag operation. A value that indicates whether the drag operation was canceled by a call to the CancelDrag method.

Gets a value that indicates whether the drag operation was canceled.

**true** if the drag operation was canceled; otherwise, **false**.

Gets the horizontal distance between the current mouse position and the thumb coordinates.

The horizontal distance between the current mouse position and the thumb coordinates.

Gets the vertical distance between the current mouse position and the thumb coordinates.

The vertical distance between the current mouse position and the thumb coordinates.

Represents the method that will handle the DragCompleted event of a Thumb.

The object where the event handler is attached. The event data.

Provides data for the DragDelta event that occurs one or more times when a user drags a Thumb control with the mouse.

Initializes a new instance of the DragDeltaEventArgs class.

The horizontal change in the Thumb position since the last DragDelta event. The vertical change in the Thumb position since the last DragDelta event.

Gets the horizontal change in the Thumb position since the last DragDelta event.

The horizontal change in the Thumb position since the last DragDelta event.

Gets the vertical change in the Thumb position since the last DragDelta event.

The vertical change in the Thumb position since the last DragDelta event.

Represents the method that will handle the DragDelta event of a Thumb.

The object where the event handler is attached. The event data.

Provides data for the DragStarted event that occurs when a user drags a Thumb control with the mouse.

Initializes a new instance of the DragStartedEventArgs class.

The horizontal distance between the current mouse position and the thumb coordinates. The vertical distance between the current mouse position and the thumb coordinates.

Gets the horizontal distance between the current mouse position and the thumb coordinates.

The horizontal distance between the current mouse position and the thumb coordinates.

Gets the vertical distance between the current mouse position and the thumb coordinates.

The vertical distance between the current mouse position and the thumb coordinates.

Represents the method that will handle the DragStarted event of a Thumb.

The object where the event handler is attached. The event data.

Defines constants that specify the location of edge transitions for edge UI, such as app bars.

Edge transition goes to bottom.

Edge transition goes to left.

Edge transition goes to right.

Edge transition goes to top.

Represents the base class for flyout controls, such as Flyout and MenuFlyout.

Provides base class initialization behavior for FlyoutBase derived classes.

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

**true** if the element gets focus when a user interacts with it; otherwise, **false**.

Identifies the AllowFocusOnInteraction dependency property.

The identifier for the AllowFocusOnInteraction dependency property.

Gets or sets a value that specifies whether the control can receive focus when it's disabled.

**true** if the control can receive focus when it's disabled; otherwise, **false**.

Identifies the AllowFocusWhenDisabled dependency property.

The identifier for the AllowFocusWhenDisabled dependency property.

Gets or sets a value that indicates whether animations are played when the flyout is opened or closed.

**true** if animations are played when the flyout is opened or closed; otherwise, **false**.

Identifies the AreOpenCloseAnimationsEnabled dependency property.

The identifier for the AreOpenCloseAnimationsEnabled dependency property.

Identifies the FlyoutBase.AttachedFlyout XAML attached property.

The identifier for the FlyoutBase.AttachedFlyout XAML attached property.

Gets or sets a value that specifies the control's preference for whether it plays sounds.

An enumeration value that specifies the control's preference for whether it plays sounds. The default is **Default**.

Identifies the ElementSoundMode dependency property.

The identifier for the ElementSoundMode dependency property.

Gets a value that indicates whether the input device used to open the flyout does not easily open the secondary commands.

**true** if the input device used to open the flyout does not easily open the secondary commands; otherwise, **false**.

Identifies the InputDevicePrefersPrimaryCommands dependency property.

The identifier for the InputDevicePrefersPrimaryCommands dependency property.

Gets a value that indicates whether the flyout is shown within the bounds of the XAML root.

**true** if the flyout is shown within the bounds of the XAML root; otherwise, **false**.

Gets a value that indicates whether the flyout is open.

**true** if the flyout is open; otherwise, **false**.

Identifies the IsOpen dependency property.

The identifier for the IsOpen dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay.

The element that should receive pointer input events even when underneath the flyout's overlay.

Identifies the **OverlayInputPassThroughElement** dependency property.

The identifier for the **OverlayInputPassThroughElement** dependency property.

Gets or sets the default placement to be used for the flyout, in relation to its placement target.

A named constant of the enumeration that indicates where the flyout is placed in relation to its placement target. The default is Top.

Identifies the Placement dependency property.

The identifier for the Placement dependency property.

Gets or sets a value that indicates whether the flyout should be shown within the bounds of the XAML root.

**true** if the flyout should be shown within the bounds of the XAML root; otherwise, **false**. The default is **false**.

Identifies the ShouldConstrainToRootBounds dependency property.

The identifier for the ShouldConstrainToRootBounds dependency property.

Gets or sets a value that indicates how a flyout behaves when shown.

A value of the enumeration that indicates how a flyout behaves when shown.

Identifies the ShowMode dependency property.

The identifier for the ShowMode dependency property.

Gets the element to use as the flyout's placement target.

The element to use as the flyout's placement target.

Identifies the Target dependency property.

The identifier for the Target dependency property.

Gets or sets the XamlRoot in which this flyout is being viewed.

The XamlRoot in which this flyout is being viewed. The default is **null**.

Occurs when the flyout is hidden.

Occurs when the flyout starts to be hidden.

Occurs when the flyout is shown.

Occurs before the flyout is shown.

When overridden in a derived class, initializes a control to show the flyout content as appropriate for the derived control. Note: This method has no base class implementation and must be overridden in a derived class.

The control that displays the content of the flyout.

Gets the flyout associated with the specified element.

The element for which to get the associated flyout. The flyout attached to the specified element.

Closes the flyout.

Called just before a keyboard shortcut (accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

The ProcessKeyboardAcceleratorEventArgs.

Associates the specified flyout with the specified FrameworkElement.

The element to associate the flyout with. The flyout to associate with the specified element.

Shows the flyout placed in relation to the specified element using the specified options.

The element to use as the flyout's placement target. The options to use when showing the flyout.

Shows the flyout placed in relation to the specified element.

The element to use as the flyout's placement target.

Shows the flyout associated with the specified element, if any.

The element for which to show the associated flyout.

Attempts to invoke a keyboard shortcut (accelerator).

The ProcessKeyboardAcceleratorEventArgs.

Provides data for the FlyoutBase.Closing event

Gets or sets a value that indicates whether the flyout should be prevented from closing.

**true** to prevent the flyout from closing; otherwise, **false**.

Defines constants that specify the preferred location for positioning a FlyoutBase derived control relative to a visual element.

The preferred location of the flyout is below the target element.

The preferred location of the flyout is centered on the screen.

The preferred location of the flyout is to the left of the target element.

The preferred location of the flyout is to the right of the target element.

The preferred location of the flyout is above the target element.

Defines constants that specify how a flyout behaves when shown.

The show mode is determined automatically based on the method used to show the flyout.

Behavior is typical of a flyout shown reactively, like a context menu. The open flyout takes focus. For a CommandBarFlyout, it opens in it's expanded state.

Behavior is typical of a flyout shown proactively. The open flyout does not take focus. For a CommandBarFlyout, it opens in it's collapsed state.

The flyout exhibits Transient behavior while the cursor is close to it, but is dismissed when the cursor moves away.

Represents the options used to show a flyout.

Initializes a new instance of the FlyoutShowOptions class.

Gets or sets a rectangular area that the flyout tries to not overlap.

The rectangular area that the flyout tries to not overlap.

Gets or sets a value that indicates where the flyout is placed in relation to it's target element.

A value of the enumeration that indicates where the flyout is placed in relation to it's target element.

Gets or sets the position where the flyout opens.

The position where the flyout opens.

Gets or sets a value that indicates how the flyout behaves when opened.

A value of the enumeration that indicates how the flyout behaves when opened.

Defines constants that specify the direction in which item generation will occur.

Items are generated in a backward direction.

Items are generated in a forward direction.

GeneratorPosition is used to describe the position of an item that is managed by ItemContainerGenerator.

The index that is relative to the generated (realized) items.

The offset that is relative to the ungenerated (unrealized) items near the indexed item.

Provides utility methods for evaluating and creating GeneratorPosition structure values. C# and Microsoft Visual Basic code should use members of GeneratorPosition instead.

Creates a GeneratorPosition value using provided values for index and offset. C# and Microsoft Visual Basic code should use GeneratorPosition(Int32,Int32) instead.

The index value to create with. The offset value to create with. The created GeneratorPosition structure with the desired values.

Represents the visual elements of a GridViewItem. When developing for Windows 10, use ListViewItemPresenter instead of GridViewItemPresenter in your item container style, both for ListView and for GridView. If you edit a copy of the default item container styles then you will get the correct type.

Initializes a new instance of the GridViewItemPresenter class.

Gets or sets the brush used to render the check mark on a selected item.

The brush used to render the check mark on a selected item.

Identifies the CheckBrush dependency property.

The identifier for the CheckBrush dependency property.

Gets or sets the brush used to render the check mark hint.

The brush used to render the check mark hint.

Identifies the CheckHintBrush dependency property.

The identifier for the CheckHintBrush dependency property.

Gets or sets the brush used to render the check mark on an item while it's being selected using a swipe interaction.

The brush used to render the check mark on an item while it's being selected using a swipe interaction.

Identifies the CheckSelectingBrush dependency property.

The identifier for the CheckSelectingBrush dependency property.

Gets or sets an internal margin between presented content and its presenter.

A Thickness value.

Identifies the ContentMargin dependency property.

The identifier for the ContentMargin dependency property.

Gets or sets the opacity of an item that is disabled.

The opacity of an item that is disabled. The value should be between 0 and 1. 0 is no opacity (transparent), 1 is full opacity (renders normally). The effective default value at run-time comes from themes.

Identifies the DisabledOpacity dependency property.

The identifier for the DisabledOpacity dependency property.

Gets or sets the brush used to render the background of an item that's being dragged.

The brush used to render the background of an item that's being dragged.

Identifies the DragBackground dependency property.

The identifier for the DragBackground dependency property.

Gets or sets the brush used to render the foreground of an item that's being dragged.

The brush used to render the foreground of an item that's being dragged.

Identifies the DragForeground dependency property.

The identifier for the DragForeground dependency property.

Gets or sets the opacity of an item that's being dragged.

The opacity of an item that's being dragged. The value should be between 0 and 1. 0 is no opacity (transparent), 1 is full opacity (renders normally). The effective default value at run-time comes from themes.

Identifies the DragOpacity dependency property.

The identifier for the DragOpacity dependency property.

Gets or sets the brush used to render the border of an item that has focus.

The brush used to render the border of an item that has focus.

Identifies the FocusBorderBrush dependency property.

The identifier for the FocusBorderBrush dependency property.

Gets or sets the horizontal alignment of the content being presented.

A value of the enumeration.

Identifies the GridViewItemPresenterHorizontalContentAlignment dependency property.

The identifier for the GridViewItemPresenterHorizontalContentAlignment dependency property.

Gets or sets the padding between the presenter and the GridView.

A Thickness value.

Identifies the GridViewItemPresenterPadding dependency property.

The identifier for the GridViewItemPresenterPadding dependency property.

Gets or sets the vertical alignment of the content being presented.

A value of the enumeration.

Identifies the GridViewItemPresenterVerticalContentAlignment dependency property.

The identifier for the GridViewItemPresenterVerticalContentAlignment dependency property.

Gets or sets the brush used to render the placeholder background for an item.

The brush used to render the placeholder background for an item.

Identifies the PlaceholderBackground dependency property.

The identifier for the PlaceholderBackground dependency property.

Gets or sets the brush used to render the background of an item that has the pointer over it.

The brush used to render the background of an item that has the pointer over it.

Gets or sets the margin of the background displayed for pointer-over input actions in the GridView item cell, versus the cell.

A Thickness value.

Identifies the PointerOverBackgroundMargin dependency property.

The identifier for the PointerOverBackgroundMargin dependency property.

Identifies the PointerOverBackground dependency property.

The identifier for the PointerOverBackground dependency property.

Gets or sets the amount that the reorder hint is offset.

The amount that the reorder hint is offset, in pixels. The effective default value at run-time comes from themes.

Identifies the ReorderHintOffset dependency property.

The identifier for the ReorderHintOffset dependency property.

Gets or sets the brush used to render the background of an item that's selected.

The brush used to render the background of an item that's selected.

Identifies the SelectedBackground dependency property.

The identifier for the SelectedBackground dependency property.

Gets or sets the thickness of the border around an item that's selected.

The thickness of the border around an item that's selected, as a Thickness value.

Identifies the SelectedBorderThickness dependency property.

The identifier for the SelectedBorderThickness dependency property.

Gets or sets the brush used to render the foreground of an item that's selected.

The brush used to render the foreground of an item that's selected.

Identifies the SelectedForeground dependency property.

The identifier for the SelectedForeground dependency property.

Gets or sets the brush used to render the background of an item that's selected and has the pointer over it.

The brush used to render the background of an item that's selected and has the pointer over it.

Identifies the SelectedPointerOverBackground dependency property.

The identifier for the SelectedPointerOverBackground dependency property.

Gets or sets the brush used to render the border of an item that's selected and has the pointer over it.

The brush used to render the border of an item that's selected and has the pointer over it.

Identifies the SelectedPointerOverBorderBrush dependency property.

The identifier for the SelectedPointerOverBorderBrush dependency property.

Gets or sets a value that indicates whether the check mark is shown when the item is selected.

**true** to show the selection check mark; otherwise, **false**. The default is **true**.

Identifies the SelectionCheckMarkVisualEnabled dependency property.

The identifier for the SelectionCheckMarkVisualEnabled dependency property.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a GridView control. Not intended for general use.

Gets a value that reports the count of items in the current drag operation.

A value that reports the count of items in the current drag operation.

Declares where the header is placed in relation to the items in an items grouping control.

Header appears to the left of items.

Header appears on top of items.

Describes snap point behavior for objects that contain and present items.

Gets a value that indicates whether the horizontal snap points for the container are equidistant from each other.

**true** if the horizontal snap points for the container are equidistant from each other; otherwise, **false**.

Gets a value that indicates whether the vertical snap points for the container are equidistant from each other.

**true** if the vertical snap points for the container are equidistant from each other; otherwise, **false**.

Occurs when the measurements for horizontal snap points change.

Occurs when the measurements for vertical snap points change.

Returns the set of distances between irregular snap points for a specified orientation and alignment.

The orientation/dimension for the desired snap point set. The alignment to use when applying the snap points. The read-only collection of snap point distances. Returns an empty collection when no snap points are present.

Gets the distance between regular snap points for a specified orientation and alignment.

The orientation/dimension for the desired snap point set. The alignment to use when applying the snap points. Out parameter. The offset of the first snap point. The distance between the equidistant snap points. Returns 0 when no snap points are present.

Provides data for the ItemsChanged event.

Gets the action that occurred on the items collection.

Returns the action that occurred.

Gets the number of items that were involved in the change.

Integer that represents the number of items involved in the change.

Gets the number of UI elements involved in the change.

Integer that represents the number of UI elements involved in the change.

Gets the position in the collection before the change occurred.

Returns a GeneratorPosition.

Gets the position in the collection where the change occurred.

Returns a GeneratorPosition.

Represents the method that will handle the ItemsChanged event.

The source of the event. The event data.

Provides the appropriate background Brush for elements in the item template of a jump list to bind to. The Brush reflects the current theme and accent color, and it's also used to shade empty-group jump list items. By default, the Brush matches built-in apps, but you can override that to suit your design needs using the Enabled and Disabled properties.

Initializes a new instance of the JumpListItemBackgroundConverter class.

Gets or sets the brush to be used for the background when the group is empty and the jump list item is disabled.

The brush to be used for the background when the group is empty and the jump list item is disabled.

Identifies the Disabled dependency property.

The identifier for the Disabled dependency property.

Gets or sets the brush to be used for the background when the group is not empty and the jump list item is enabled.

The brush to be used for the background when the group is not empty and the jump list item is enabled.

Identifies the Enabled dependency property.

The identifier for the Enabled dependency property.

Returns the enabled brush if the item is not empty, otherwise returns the disabled brush.

The source data being passed to the target. The Type of data expected by the target dependency property. An optional parameter to be used in the converter logic. The culture of the conversion. The enabled brush if the item is not empty, otherwise the disabled brush.

Modifies the target data before passing it to the source object.

The target data being passed to the source. The Type of data expected by the source object. An optional parameter to be used in the converter logic. The culture of the conversion. The value to be passed to the source object.

Provides the appropriate foreground Brush for elements in the item template of a jump list to bind to. The Brush reflects the current theme and accent color, and it's also used to shade empty-group jump list items. By default, the Brush matches built-in apps, but you can override that to suit your design needs using the Enabled and Disabled properties.

Initializes a new instance of the JumpListItemForegroundConverter class.

Gets or sets the brush to be used for the foreground when the group is empty and the jump list item is disabled.

The brush to be used for the foreground when the group is empty and the jump list item is disabled.

Identifies the Disabled dependency property.

The identifier for the Disabled dependency property.

Gets or sets the brush to be used for the foreground when the group is not empty and the jump list item is enabled.

The brush to be used for the foreground when the group is not empty and the jump list item is enabled.

Identifies the Enabled dependency property.

The identifier for the Enabled dependency property.

Returns the enabled brush if the item is not empty, otherwise returns the disabled brush.

The source data being passed to the target. The Type of data expected by the target dependency property. An optional parameter to be used in the converter logic. The culture of the conversion. The enabled brush if the item is not empty, otherwise the disabled brush.

Modifies the target data before passing it to the source object

The target data being passed to the source. The Type of data expected by the source object. An optional parameter to be used in the converter logic. The culture of the conversion. The value to be passed to the source object.

Defines methods that provide additional information about the layout of an element.

Returns the Size value that was most recently used to measure the specified element.

The element for which to return the most recent size. The Size given as an argument on the most recent call to measure this element, or a Size of 0,0 if the element has not been measured yet.

Returns the element that was being processed by the layout system at the moment of an unhandled exception.

The *dispatcher* object that defines the scope of the operation. Direct support for "Dispatcher" type does not exist yet. The element being processed at the time of an unhandled exception.

Returns the layout slot, or bounding box, that contains the specified element.

The element for which to return the layout slot. The area assigned to the element for layout.

Represents the visual elements of a ListViewItem. When developing for Windows 10, use ListViewItemPresenter instead of GridViewItemPresenter in your item container style, both for ListView and for GridView. If you edit a copy of the default item container styles then you will get the correct type.

Initializes a new instance of the ListViewItemPresenter class.

In a ListView in multiple selection mode, gets or sets the brush used to render an item's check box border. In a GridView, the check box background is set rather than the border, and only for unselected items.

The brush used to render the check box border (ListView ) or background (GridView ).

Identifies the CheckBoxBrush dependency property.

The identifier for the CheckBoxBrush dependency property.

Gets or sets the brush used to render the check mark on a selected item.

The brush used to render the check mark on a selected item.

Identifies the CheckBrush dependency property.

The identifier for the CheckBrush dependency property.

Gets or sets the brush used to render the check mark hint. This property is ignored for a Windows 10 app.

The brush used to render the check mark hint.

Identifies the CheckHintBrush dependency property.

The identifier for the CheckHintBrush dependency property.

Gets or sets the style of checkbox shown for selecting an item.

A value of the enumeration that specifies the style of checkbox to show. The default is **Inline**.

Identifies the CheckMode dependency property.

The identifier for the CheckMode dependency property.

Gets or sets the brush used to render the check mark on an item while it's being selected using a swipe interaction. This property is ignored for a Windows 10 app.

The brush used to render the check mark on an item while it's being selected using a swipe interaction.

Identifies the CheckSelectingBrush dependency property.

The identifier for the CheckSelectingBrush dependency property.

Gets or sets an internal margin between presented content and its presenter.

A Thickness value.

Identifies the ContentMargin dependency property.

The identifier for the ContentMargin dependency property.

Gets or sets the opacity of an item that is disabled.

The opacity of an item that is disabled. The value should be between 0 and 1. 0 is no opacity (transparent), 1 is full opacity (renders normally). The effective default value at run-time comes from themes.

Identifies the DisabledOpacity dependency property.

The identifier for the DisabledOpacity dependency property.

Gets or sets the brush used to render the background of an item that's being dragged.

The brush used to render the background of an item that's being dragged.

Identifies the DragBackground dependency property.

The identifier for the DragBackground dependency property.

Gets or sets the brush used to render the foreground of an item that's being dragged.

The brush used to render the foreground of an item that's being dragged.

Identifies the DragForeground dependency property.

The identifier for the DragForeground dependency property.

Gets or sets the opacity of an item that's being dragged.

The opacity of an item that's being dragged. The value should be between 0 and 1. 0 is no opacity (transparent), 1 is full opacity (renders normally). The effective default value at run-time comes from themes.

Identifies the DragOpacity dependency property.

The identifier for the DragOpacity dependency property.

Gets or sets the brush used to render the border of an item that has focus. Also see FocusSecondaryBorderBrush.

The brush used to render the border of an item that has focus.

Identifies the FocusBorderBrush dependency property.

The identifier for the FocusBorderBrush dependency property.

Gets or sets the brush used to render the second color of the border around an item that has focus. Focus is rendered as a composition of two brushes. This property is used together the FocusBorderBrush to specify these two brushes.

The brush used to render the second color of the border around an item that has focus.

Identifies the FocusSecondaryBorderBrush dependency property.

The identifier for the FocusSecondaryBorderBrush dependency property.

Gets or sets the horizontal alignment of the content being presented.

A value of the enumeration.

Identifies the ListViewItemPresenterHorizontalContentAlignment dependency property.

The identifier for the ListViewItemPresenterHorizontalContentAlignment dependency property.

Gets or sets the padding around the presenter.

A Thickness value.

Identifies the ListViewItemPresenterPadding dependency property.

The identifier for the ListViewItemPresenterPadding dependency property.

Gets or sets the vertical alignment of the content being presented.

A value of the enumeration.

Identifies the ListViewItemPresenterVerticalContentAlignment dependency property.

The identifier for the ListViewItemPresenterVerticalContentAlignment dependency property.

Gets or sets the brush used to render the placeholder background for an item.

The brush used to render the placeholder background for an item.

Identifies the PlaceholderBackground dependency property.

The identifier for the PlaceholderBackground dependency property.

Gets or sets the brush used to render the background of an item that has the pointer over it.

The brush used to render the background of an item that has the pointer over it.

Gets or sets the margin of the background displayed for pointer-over input actions in the ListView item cell, versus the cell. This property is ignored for a Windows 10 app.

A Thickness value.

Identifies the PointerOverBackgroundMargin dependency property.

The identifier for the PointerOverBackgroundMargin dependency property.

Identifies the PointerOverBackground dependency property.

The identifier for the PointerOverBackground dependency property.

Gets or sets the brush used to render the foreground when the pointer is over the item.

The brush used to render the foreground when the pointer is over the item.

Identifies the PointerOverForeground dependency property.

The identifier for the PointerOverForeground dependency property.

In a ListView, gets or sets the brush used to render the background of an unselected item while the user is pressing it. In a GridView, the item's border is set rather than the background.

The brush used to render an unselected item's background (ListView ) or border (GridView ) while pressed.

Identifies the PressedBackground dependency property.

The identifier for the PressedBackground dependency property.

Gets or sets the amount that the reorder hint is offset. This property is ignored for a Windows 10 app.

The amount that the reorder hint is offset, in pixels. The effective default value at run-time comes from themes.

Identifies the ReorderHintOffset dependency property.

The identifier for the ReorderHintOffset dependency property.

Gets or sets the brush used to render the background of the reveal effect.

The brush used to render the background of the reveal effect.

Identifies the RevealBackground dependency property.

The identifier for the RevealBackground dependency property.

Gets or sets a value that indicates whether the reveal backgound is shown on top of the content.

**true** if the reveal backgound is shown on top of the content; otherwise, **false**.

Identifies the RevealBackgroundShowsAboveContent dependency property.

The identifier for the RevealBackgroundShowsAboveContent dependency property.

Gets or sets the brush used to render the border of the reveal effect.

The brush used to render the border of the reveal effect.

Identifies the RevealBorderBrush dependency property.

The identifier for the RevealBorderBrush dependency property.

Gets or sets the thickness of the border of the reveal effect.

The thickness of the border of the reveal effect.

Identifies the RevealBorderThickness dependency property.

The identifier for the RevealBorderThickness dependency property.

Gets or sets the brush used to render the background of an item that's selected.

The brush used to render the background of an item that's selected.

Identifies the SelectedBackground dependency property.

The identifier for the SelectedBackground dependency property.

Gets or sets the thickness of the border around an item that's selected. This property is ignored for a Windows 10 app.

The thickness of the border around an item that's selected, as a Thickness value.

Identifies the SelectedBorderThickness dependency property.

The identifier for the SelectedBorderThickness dependency property.

Gets or sets the brush used to render the foreground of an item that's selected.

The brush used to render the foreground of an item that's selected.

Identifies the SelectedForeground dependency property.

The identifier for the SelectedForeground dependency property.

Gets or sets the brush used to render the background of an item that's selected and has the pointer over it.

The brush used to render the background of an item that's selected and has the pointer over it.

Identifies the SelectedPointerOverBackground dependency property.

The identifier for the SelectedPointerOverBackground dependency property.

Gets or sets the brush used to render the border of an item that's selected and has the pointer over it. This property is ignored for a Windows 10 app.

The brush used to render the border of an item that's selected and has the pointer over it.

Identifies the SelectedPointerOverBorderBrush dependency property.

The identifier for the SelectedPointerOverBorderBrush dependency property.

In a ListView, gets or sets the brush used to render the background of a selected item while the user is pressing it. In a GridView, the item's border is set rather than the background.

The brush used to render a selected item's background (ListView ) or border (GridView ) while pressed.

Identifies the SelectedPressedBackground dependency property.

The identifier for the SelectedPressedBackground dependency property.

Gets or sets a value that indicates whether the check mark is shown when the item is selected.

**true** to show the selection check mark; otherwise, **false**. The default is **true**.

Identifies the SelectionCheckMarkVisualEnabled dependency property.

The identifier for the SelectionCheckMarkVisualEnabled dependency property.

Defines constants that specify the style of checkbox shown to select an item.

The checkbox in shown inline with the content of the list item.

The checkbox is shown over the content of the list item.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ListViewItem. Not intended for general use.

Gets the number of items for a drag payload that contains this item as an origin.

The number of items for a drag payload.

An infinitely scrolling selection control.

Gets or sets the height of a LoopingSelectorItem that is contained in a LoopingSelector.

The height of the layout area for the LoopingSelectorItem that is contained in the LoopingSelector.

Identifies the ItemHeight dependency property.

The identifier for the ItemHeight dependency property.

Gets a list of the LoopingSelectorItem objects.

The list of LoopingSelectorItem objects.

Identifies the Items dependency property.

The identifier for the Items dependency property.

Gets or sets the DataTemplate used to display each LoopingSelectorItem.

The template that specifies the visualization of the LoopingSelectorItem items.

Identifies the ItemTemplate dependency property.

The identifier for the ItemTemplate dependency property.

Gets or sets the width of a LoopingSelectorItem that is contained in a LoopingSelector.

The width of the layout area for the LoopingSelectorItem that is contained in the LoopingSelector.

Identifies the ItemWidth dependency property.

The identifier for the ItemWidth dependency property.

Gets or sets the index of the LoopingSelectorItem that is displayed in the LoopingSelector.

The index of the LoopingSelectorItem that is visible in the LoopingSelector.

Identifies the SelectedIndex dependency property.

The identifier for the SelectedIndex dependency property.

Gets or sets the LoopingSelectorItem that is displayed in the LoopingSelector.

The LoopingSelectorItem that is visible in the LoopingSelector.

Identifies the SelectedItem dependency property.

The identifier for the SelectedItem dependency property.

Gets or sets a value that determines whether the LoopingSelector loops indefinitely.

**True** if the LoopingSelector loops through all LoopingSelectorItem items indefinitely; otherwise, **false**.

Identifies the ShouldLoop dependency property.

The identifier for the ShouldLoop dependency property.

Occurs when the currently selected item changes.

An item that is contained in a LoopingSelector control.

A panel for positioning and arranging child LoopingSelector elements.

Gets a value that determines whether the horizontal snap points for the LoopingSelectorPanel are equidistant from each other.

**True** if the horizontal snap points are equidistant from each other; otherwise, **false**.

Gets a value that determines whether the vertical snap points for the LoopingSelectorPanel are equidistant from each other.

**True** if the vertical snap points are regular equidistant from each other; otherwise, **false**.

Occurs when the horizontal snap points change.

Occurs when the vertical snap points change.

Returns a read-only collection of numbers that represent the irregular snap points for the specified orientation.

The orientation of the requested snap points. The alignment used by the caller when applying the requested snap points. A read-only collection of numbers that represent the irregular snap points for the specified orientation, or an empty collection when no irregular snap points are present.

Returns a read-only collection of numbers that represent the regular snap points for the specified orientation.

The orientation of the requested snap points. The alignment used by the caller when applying the requested snap points. The offset of the first snap point. A read-only collection of numbers that represent the regular snap points for the specified orientation, or an empty collection when no regular snap points are present.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a MenuFlyoutItem control. Not intended for general use.

Gets the minimum width allocated for the accelerator key tip of an MenuFlyout.

A number that specifies the minimum width allocated for the accelerator key tip of an MenuFlyout.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a MenuFlyoutPresenter control. Not intended for general use.

Gets the minimum width of flyout content.

The minimum width of flyout content.

Represents the visual elements of a NavigationViewItem.

Initializes a new instance of the NavigationViewItemPresenter class.

Gets or sets the icon in a NavigationView item.

The NavigationView item's icon.

Identifies the Icon dependency property.

The identifier for the Icon dependency property.

Adds infrastructure (provides base class) for virtualizing layout containers that support spatial cues, such as VirtualizingStackPanel and WrapGrid.

Gets a value that indicates whether the horizontal snap points for the OrientedVirtualizingPanel are equidistant from each other.

**true** if the horizontal snap points for the OrientedVirtualizingPanel are equidistant from each other; otherwise, **false**.

Gets a value that indicates whether the vertical snap points for the OrientedVirtualizingPanel are equidistant from each other.

**true** if the vertical snap points for the OrientedVirtualizingPanel are equidistant from each other; otherwise, **false**.

Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the horizontal dimension.

**true** to support a potentially infinite horizontal layout dimension. **false** to restrict to available size.

Gets or sets a value that determines how the OrientedVirtualizingPanel measures space for child elements for possible scrolling in the vertical dimension.

**true** to support a potentially infinite vertical layout dimension. **false** to restrict to available size.

Gets the vertical size of the panel extent.

A value in pixels.

Gets the horizontal size of the panel extent.

A value in pixels.

Gets the horizontal offset of the scrolled content.

A value in pixels.

Gets or sets a reference to a ScrollViewer that is the scroll host or scroll owner for scrolling behavior of the OrientedVirtualizingPanel.

The scroll host or scroll owner for scrolling behavior.

Gets the vertical offset of the scrolled content.

A value in pixels.

Gets the vertical size of the viewport or content area.

A value in pixels.

Gets the horizontal size of the viewport or content area.

A value in pixels.

Fires when the measurements for horizontal snap points change.

Fires when the measurements for vertical snap points change.

Returns the index values of the items that the specified point is between.

The point for which to get insertion indexes. The index of the item before the specified point. The index of the item after the specified point.

Returns the set of distances between irregular snap points for a specified orientation and alignment.

The orientation for the desired snap point set. The alignment to use when applying the snap points. The read-only collection of snap point distances. Returns an empty collection when no snap points are present.

Gets the distance between regular snap points for a specified orientation and alignment.

The orientation for the desired snap point set. The alignment to use when applying the snap points. Out parameter. The offset of the first snap point. The distance between the equidistant snap points. Returns 0 when no snap points are present.

Scrolls content by one line toward the bottom.

Scrolls content by one line toward the left.

Scrolls content by one line toward the right.

Scrolls content by one line toward the top.

Changes existing offsets in order to make the provided element visible in the viewport, and returns a Rect measurement of the area.

The element to make visible. A rectangle representing the element's coordinate space. A rectangle representing the input *rectangle*Rect transformed using the OrientedVirtualizingPanel coordinate space after scrolling happens.

Scrolls content by one mouse-wheel click toward the bottom.

Scrolls content by one mouse-wheel click toward the left.

Scrolls content by one mouse-wheel click toward the right.

Scrolls content by one mouse-wheel click toward the top.

Scrolls content by one page toward the bottom.

Scrolls content by one page toward the left.

Scrolls content by one page toward the right.

Scrolls content by one page toward the top.

Changes the horizontal offset of content within the OrientedVirtualizingPanel viewport.

The horizontal offset to set, in pixels.

Changes the vertical offset of content within the OrientedVirtualizingPanel viewport.

The offset to set, in pixels.

Represents a base class for picker controls.

Provides base-class initialization behavior for classes that are derived from the PickerFlyoutBase class.

Gets the identifier for the attached title property.

The identifier for the attached title property.

Gets the title displayed on the picker control.

The dependency object for which to get the title. The title displayed on the picker control.

Notifies PickerFlyoutBase subclasses when a user has confirmed a selection.

Sets the title displayed on a picker control.

The dependency object for which to set the title. The title you want to display.

Gets or sets whether confirmation buttons should be shown in the picker. Note: This method has no base class implementation and must be overridden in a derived class.

True if confirmation buttons should be shown in the picker; Otherwise, false.

Represents a header item in the specialized pivot header items control.

Initializes a new instance of the PivotHeaderItem control.

Displays the header text of the items in a Pivot control.

Initializes a new instance of the PivotHeaderPanel class.

Displays the items in a Pivot control.

Initializes a new instance of the PivotPanel class.

This property is reserved for internal use and is not intended to be used in your code.

Reserved.

This property is reserved for internal use and is not intended to be used in your code.

Reserved.

This property is reserved for internal use and is not intended to be used in your code.

This property is reserved for internal use and is not intended to be used in your code.

This property is reserved for internal use and is not intended to be used in your code.

Reserved. Reserved. Reserved.

This property is reserved for internal use and is not intended to be used in your code.

Reserved. Reserved. Reserved. Reserved.

Defines constants that specify the preferred location for positioning a ToolTip relative to a visual element.

The preferred location of the ToolTip is below the target element when element receives keyboard focus, at the bottom of the mouse pointer when element is hovered over with pointer.

The preferred location of the ToolTip is to the left of the target element when element receives keyboard focus, to the left of the mouse pointer when element is hovered over with pointer.

The preferred location of the ToolTip is with the top-left corner of the tooltip positioned at the mouse pointer location when hovered over with mouse, above the target element when focused with keyboard.

The preferred location of the ToolTip is to the right of the target element when element receives keyboard focus, to the right of the mouse pointer when element is hovered over with pointer.

The preferred location of the ToolTip is above the target element when element receives keyboard focus, at the top of the mouse pointer when element is hovered over with pointer.

Displays content on top of existing content, within the bounds of the application window.

Initializes a new instance of the Popup class.

Gets or sets the content to be hosted in the popup.

The content to be hosted in the popup.

Gets the identifier for the Child dependency property.

The identifier for the Child dependency property.

Gets or sets the collection of Transition style elements that apply to child content of a Popup.

The strongly typed collection of Transition style elements.

Identifies the ChildTransitions dependency property.

The identifier for the ChildTransitions dependency property.

Gets or sets the distance between the left side of the application window and the left side of the popup.

A measurement in pixels.

Gets the identifier for the HorizontalOffset dependency property.

The identifier for the HorizontalOffset dependency property.

Gets a value that indicates whether the popup is shown within the bounds of the XAML root.

**true** if the popup is shown within the bounds of the XAML root; otherwise, **false**.

Gets or sets a value that determines how the Popup can be dismissed.

**true** if *light dismiss* is enabled for this control; otherwise, **false**.

Identifies the IsLightDismissEnabled dependency property.

The identifier for the IsLightDismissEnabled dependency property.

Gets or sets whether the popup is currently displayed on the screen.

**true** if the popup is currently displayed; otherwise, **false**. The default is **false**.

Gets the identifier for the IsOpen dependency property.

The identifier for the IsOpen dependency property.

Gets or sets a value that specifies whether the area outside of a *light-dismiss* UI is darkened.

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is **Auto**.

Identifies the LightDismissOverlayMode dependency property.

The identifier for the LightDismissOverlayMode dependency property.

Gets or sets a value that indicates whether the popup should be shown within the bounds of the XAML root.

**true** if the popup should be shown within the bounds of the XAML root; otherwise, **false**. The default is **true**.

Identifies the ShouldConstrainToRootBounds dependency property.

The identifier for the ShouldConstrainToRootBounds dependency property.

Gets or sets the distance between the top of the application window and the top of the popup.

A measurement in pixels.

Gets the identifier for the VerticalOffset dependency property.

The identifier for the VerticalOffset dependency property.

Fires when the IsOpen property is set to false.

Fires when the IsOpen property is set to true.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ProgressBar control. Not intended for general use.

Gets the target "To" point of the container animation that animates the ProgressBar.

A double that represents the orientation-specific x- or y-value that is the target "To" point of the animation.

Gets the "From" point of the container animation that animates the ProgressBar.

A double that represents the orientation-specific x- or y-value that is the"From" point of the animation.

Gets the "To" point of the "Ellipse" animation that animates the ProgressBar.

The "To" point of the "Ellipse" animation that animates the ProgressBar. This is internally calculated as 2/3 of the ActualWidth of the control.

Gets the stopped point of the "Ellipse" animation that animates the ProgressBar.

The stopped point of the Ellipse animation that animates the ProgressBar. This is internally calculated as 1/3 of the ActualWidth of the control.

Gets the template-defined diameter of the "Ellipse" element that is animated in a templated ProgressBar.

The "Ellipse" element width in pixels.

Gets the template-defined offset position of the "Ellipse" element that is animated in a templated ProgressBar.

The offset in pixels.

Gets the indicator length delta, which is useful for repositioning transitions.

The delta in pixels.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ProgressRing control. Not intended for general use.

Gets the template-defined diameter of the "Ellipse" element that is animated in a templated ProgressRing.

The "Ellipse" width in pixels.

Gets the template-defined offset position of the "Ellipse" element that is animated in a templated ProgressRing.

The offset in pixels.

Gets the maximum bounding size of the progress ring as rendered.

The maximum bounding size of the progress ring as rendered, in pixels.

Represents an element that has a value within a specific range, such as the ProgressBar, ScrollBar, and Slider controls.

Provides base class initialization behavior for RangeBase -derived classes.

Gets or sets a value to be added to or subtracted from the Value of a RangeBase control.

Value to add to or subtract from the Value of the RangeBase element. The default is 1.

Identifies the LargeChange dependency property.

The identifier for the LargeChange dependency property.

Gets or sets the highest possible Value of the range element.

The highest possible Value of the range element. The default is 1.

Identifies the Maximum dependency property.

The identifier for the Maximum dependency property.

Gets or sets the Minimum possible Value of the range element.

Minimum possible Value of the range element. The default is 0.

Identifies the Minimum dependency property.

The identifier for the Minimum dependency property.

Gets or sets a Value to be added to or subtracted from the Value of a RangeBase control.

Value to add to or subtract from the Value of the RangeBase element. The default is 0.1.

Identifies the SmallChange dependency property.

The identifier for the SmallChange dependency property.

Gets or sets the current setting of the range control, which may be coerced.

The current setting of the range control, which may be coerced. The default is 0.

Identifies the Value dependency property.

The identifier for the Value dependency property.

Occurs when the range value changes.

Called when the Maximum property changes.

Old value of the Maximum property. New value of the Maximum property.

Called when the Minimum property changes.

Old value of the Minimum property. New value of the Minimum property.

Fires the ValueChanged routed event.

Old value of the Value property. New value of the Value property.

Provides data about a change in range value for the ValueChanged event.

Gets the new value of a range value property.

The new value.

Gets the previous value of a range value property.

The previous value.

Represents the method that will handle a ValueChanged event.

The object where the event handler is attached. The event data.

Represents a control that raises its Click event repeatedly when it is pressed and held.

Initializes a new instance of the RepeatButton class.

Gets or sets the time, in milliseconds, that the RepeatButton waits when it is pressed before it starts repeating the click action.

The time, in milliseconds, that the RepeatButton waits when it is pressed before it starts repeating the click action. The default is 250.

Identifies the Delay dependency property.

The identifier for the Delay dependency property.

Gets or sets the time, in milliseconds, between repetitions of the click action, as soon as repeating starts.

The time, in milliseconds, between repetitions of the click action, as soon as repeating starts. The default is 250.

Identifies the Interval dependency property.

The identifier for the Interval dependency property.

Represents a control that provides a scroll bar that has a sliding Thumb whose position corresponds to a value.

Initializes a new instance of the ScrollBar class.

Gets or sets a value that results in different input indicator modes for the ScrollBar.

A value of the enumeration. The default is **None**.

Identifies the IndicatorMode dependency property.

The identifier for the IndicatorMode dependency property.

Gets or sets a value that indicates whether the ScrollBar is displayed horizontally or vertically.

An Orientation enumeration value that defines whether the ScrollBar is displayed horizontally or vertically. The default is **Horizontal**. Specific control templates might change this value, which would cause the templated value to be the apparent runtime default.

Identifies the Orientation dependency property.

The identifier for the Orientation dependency property.

Gets or sets the amount of the scrollable content that is currently visible.

The amount of the scrollable content that is currently visible. The default is 0.

Identifies the ViewportSize dependency property.

The identifier for the ViewportSize dependency property.

Occurs one or more times as content scrolls in a ScrollBar when the user moves the Thumb by using the mouse.

Provides data for the Scroll event.

Initializes a new instance of the ScrollEventArgs class.

Gets the new Value of the ScrollBar.

The Value of the ScrollBar after the event.

Gets a ScrollEventType describing the event.

A ScrollEventType describing the event.

Represents the method that will handle the Scroll event of a ScrollBar.

The source of the event. A ScrollEventArgs that contains the event data.

Defines constants that specify the type of Scroll event that occurred.

The Thumb was dragged to a new position and is now no longer being dragged by the user.

The Thumb moved to the Minimum position of the ScrollBar.

The Thumb moved a distance specified by the value of LargeChange. The Thumb moved to the left for a horizontal ScrollBar or upward for a vertical ScrollBar.

The Thumb moved a distance specified by the value of LargeChange. The Thumb moved to the right for a horizontal ScrollBar or downward for a vertical ScrollBar.

The Thumb moved to the Maximum position of the ScrollBar.

The Thumb moved a distance specified by the value of SmallChange. The Thumb moved to the left for a horizontal ScrollBar or upward for a vertical ScrollBar.

The Thumb moved a distance specified by the value of SmallChange. The Thumb moved to the right for a horizontal ScrollBar or downward for a vertical ScrollBar.

The Thumb moved to a new position because the user selected **Scroll Here** in the shortcut menu of the ScrollBar.

The Thumb was dragged and caused a PointerMoved event. A Scroll event of this ScrollEventType may occur more than one time when the Thumb is dragged in the ScrollBar.

Defines constants that specify input-specific transition animations that are part of the default template for ScrollBar.

Use input-specific transitions that are appropriate for mouse input.

Do not use input-specific transitions.

Use input-specific transitions that are appropriate for touch input.

Represents a control that enables a user to select an item from a collection of items.

Gets or sets a value that indicates whether a Selector should keep the SelectedItem synchronized with the current item in the Items property.

**true** if the SelectedItem is always synchronized with the current item in the ItemCollection; **false** if the SelectedItem is never synchronized with the current item; **null** if the SelectedItem is synchronized with the current item only if the Selector uses an ICollectionView. The default value is **null**/indeterminate.

Identifies the IsSynchronizedWithCurrentItem dependency property.

The identifier for the IsSynchronizedWithCurrentItem dependency property.

Gets or sets the index of the selected item.

The index of the selected item. The default is -1, which indicates that no item is selected.

Identifies the SelectedIndex dependency property.

The identifier for the SelectedIndex dependency property.

Gets or sets the selected item.

The selected item. The default is null.

Identifies the SelectedItem dependency property.

The identifier for the SelectedItem dependency property.

Gets or sets the value of the selected item, obtained by using the SelectedValuePath.

The value of the selected item, obtained by using the SelectedValuePath, or null if no item is selected. The default value is null.

Gets or sets the property path that is used to get the SelectedValue property of the SelectedItem property.

The property path that is used to get the SelectedValue property of the SelectedItem property. The default is String.Empty.

Gets the identifier for the SelectedValuePath dependency property.

The identifier for the SelectedValuePath dependency property.

Gets the identifier for the SelectedValue dependency property.

The identifier for the SelectedValue dependency property.

Occurs when the currently selected item changes.

Gets a value that indicates whether the specified Selector has the focus.

The Selector to evaluate. **true** to indicate that the Selector has the focus; otherwise, **false**.

Provides a base class for item types in a selection control.

Provides base class initialization behavior for SelectorItem -derived classes.

Gets or sets a value that indicates whether the item is selected in a selector.

**true** if the item is selected; otherwise, **false**.

Identifies the IsSelected dependency property.

The identifier for the IsSelected dependency property.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a SettingsFlyout control. Not intended for general use.

Gets the brush that fills the border area of the SettingsFlyout.

The brush that fills the border area of the SettingsFlyout.

Gets the thickness of the SettingsFlyout border.

The thickness of the SettingsFlyout border.

Gets the collection of content transitions used by the SettingsFlyout.

The collection of content transitions used by the SettingsFlyout.

Gets the brush that fills the background of the SettingsFlyout header area.

The brush that fills the background of the SettingsFlyout header area.

Gets the brush that renders the header text of the SettingsFlyout.

The brush that renders the header text of the SettingsFlyout.

Gets the source image for the SettingsFlyout icon.

The source image for the SettingsFlyout icon.

Defines constants that specify how a Slider or related range control class conforms the indicator position to its steps or tick marks.

Conform the indicator to the step values.

Conform the indicator to the tick marks.

Defines constants that specify options for snap point alignment relative to an edge. Which edge depends on the orientation of the object where the alignment is applied.

Use snap points that are centered in the orientation.

Use snap points grouped farther from the orientation edge.

Use snap points grouped closer to the orientation edge.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a SplitView. Not intended for general use.

Gets the CompactPaneLength value as a GridLength.

The CompactPaneLength value as a GridLength.

Gets the negative of the OpenPaneLength value.

The negative of the OpenPaneLength value.

Gets the negative of the value calculated by subtracting the CompactPaneLength value from the OpenPaneLength value.

The negative of the OpenPaneLength value minus the CompactPaneLength value.

Gets the OpenPaneLength value as a GridLength.

The OpenPaneLength value as a GridLength.

Gets the OpenPaneLength value.

The OpenPaneLength value.

Gets a value calculated by subtracting the CompactPaneLength value from the OpenPaneLength value.

The value calculated by subtracting the CompactPaneLength value from the OpenPaneLength value.

Represents a control that can be dragged by the user.

Initializes a new instance of the Thumb class.

Gets whether the Thumb control has focus and mouse capture.

**true** if the Thumb control has focus and mouse capture; otherwise, **false**. The default is **false**.

Identifies the IsDragging dependency property.

The identifier for the IsDragging dependency property.

Fires when the Thumb control loses mouse capture.

Fires one or more times as the mouse pointer is moved when a Thumb control has logical focus and mouse capture.

Fires when a Thumb control receives logical focus and mouse capture.

Cancels a drag operation for the Thumb.

Represents a tick mark on a Slider control. Not intended for general use.

Initializes a new instance of the TickBar class.

Gets or sets the Brush that draws on the background area of the TickBar.

The Brush that draws on the background area of the TickBar.

Identifies the Fill dependency property.

The identifier for the Fill dependency property.

Defines constants that specify the position of tick marks in a Slider in relation to the track that the control implements.

Tick marks appear below the track for a horizontal Slider, or to the right of the track for a vertical Slider.

Tick marks appear directly on the track.

No tick marks appear.

Tick marks appear on both sides of either a horizontal or vertical track.

Tick marks appear above the track for a horizontal Slider, or to the left of the track for a vertical Slider.

Represents a control that a user can select (check) or clear (uncheck). Base class for controls that can switch states, such as CheckBox and RadioButton.

Initializes a new instance of the ToggleButton class.

Gets or sets whether the ToggleButton is checked.

**true** if the ToggleButton is checked; **false** if the ToggleButton is unchecked; otherwise **null**. The default is **false**.

Identifies the IsChecked dependency property.

The identifier for the IsChecked dependency property.

Gets or sets a value that indicates whether the control supports three states.

**True** if the control supports three states; otherwise, **false**. The default is **false**.

Identifies the IsThreeState dependency property.

The identifier for the IsThreeState dependency property.

Fires when a ToggleButton is checked.

Fires when the state of a ToggleButton is switched to the indeterminate state.

Occurs when a ToggleButton is unchecked.

Called when the ToggleButton receives toggle stimulus.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ToggleSwitch control. Not intended for general use.

Gets the calculated value of the offset for the "curtain" element of the ToggleSwitch, calculated for an "Off" action and current switch position.

A value in pixels.

Gets the calculated value of the offset for the "curtain" element of the ToggleSwitch, calculated for an "On" action and current switch position.

A value in pixels.

Gets the calculated value of the offset for the "curtain" element of the ToggleSwitch, in "Off" to "On" direction.

A value in pixels.

Gets the calculated value of the offset for the "curtain" element of the ToggleSwitch, in "On" to "Off" direction.

A value in pixels.

Gets the calculated value of the offset for the "knob" element of the ToggleSwitch, calculated for an "Off" action and current switch position.

A value in pixels.

Gets the calculated value of the offset for the "knob" element of the ToggleSwitch, calculated for an "On" action and current switch position.

A value in pixels.

Gets the calculated value of the offset for the "knob" element of the ToggleSwitch, in "Off" to "On" direction.

A value in pixels.

Gets the calculated value of the offset for the "knob" element of the ToggleSwitch, in "On" to "Off" direction.

A value in pixels.

Provides calculated values that can be referenced as **TemplatedParent** sources when defining templates for a ToolTip control. Not intended for general use.

Gets the offset that is appropriate as a value for **FromHorizontalOffset** in theme animations.

A value in pixels.

Gets the offset that is appropriate as a value for **FromVerticalOffset** in theme animations.

A value in pixels.

Specifies that a type defined in C++ can be used for binding.

Initializes a new instance of the BindableAttribute class.

Defines a binding that connects the properties of binding targets and data sources.

Initializes a new instance of the Binding class.

Gets or sets the converter object that is called by the binding engine to modify the data as it is passed between the source and target, or vice versa.

The IValueConverter object that modifies the data.

Gets or sets a value that names the language to pass to any converter specified by the Converter property.

A string that names a language. Interpretation of this value is ultimately up to the converter logic.

Gets or sets a parameter that can be used in the Converter logic.

A parameter to be passed to the Converter. This can be used in the conversion logic. The default is **null**.

Gets or sets the name of the element to use as the binding source for the Binding.

The value of the Name property or x:Name attribute for the element you want to use as the binding source. The default is an empty string.

Gets or sets the value to use when the binding is unable to return a value.

The value to use when the binding is unable to return a value.

Gets or sets a value that indicates the direction of the data flow in the binding.

One of the BindingMode values. The default is **OneWay**: the source updates the target, but changes to the target value do not update the source.

Gets or sets the path to the binding source property.

The property path for the source of the binding.

Gets or sets the binding source by specifying its location relative to the position of the binding target. This is most often used in bindings within XAML control templates.

The relative location of the binding source to use. The default is **null**.

Gets or sets the data source for the binding.

The source object that contains the data for the binding.

Gets or sets the value that is used in the target when the value of the source is **null**.

The value that is used in the binding target when the value of the source is **null**.

Gets or sets a value that determines the timing of binding source updates for two-way bindings.

One of the UpdateSourceTrigger values. The default is **Default**, which evaluates as a **PropertyChanged** update behavior.

Provides a base class for the Binding class.

Initializes a new instance of the BindingBase class.

Contains information about a single instance of a Binding.

Gets the binding source object that this BindingExpression uses.

The binding source object that this BindingExpression uses.

Gets the Binding object of this BindingExpression.

The Binding object of the current binding expression.

Sends the current binding target value to the binding source property in **TwoWay** bindings.

Represents the base class for BindingExpression.

Describes how the data propagates in a binding.

Updates the target property when the binding is created.

Updates the target property when the binding is created. Changes to the source object can also propagate to the target.

Updates either the target or the source object when either changes. When the binding is created, the target property is updated from the source.

Provides the static SetBinding method.

Associates a Binding with a target property on a target object. This method is the code equivalent to using a {Binding} markup extension in XAML markup.

The object that should be the target of the evaluated binding. The property on the target to bind, specified by its identifier. These identifiers are usually available as static read-only properties on the type that defines the *target* object, or one of its base types. You can also bind to attached properties, but see Remarks. The binding to assign to the target property. This Binding should be initialized: important Binding properties such as Path should already be set before passing it as the parameter.

Provides a data source that adds grouping and current-item support to collection classes.

Initializes a new instance of the CollectionViewSource class.

Gets or sets a value that indicates whether source data is grouped.

**true** if data is grouped. **false** if data is not grouped.

Identifies the IsSourceGrouped dependency property.

The identifier for the IsSourceGrouped dependency property.

Gets or sets the property path to follow from the top level item to find groups within the CollectionViewSource.

The property path to follow from the top level item to find groups. The default is a PropertyPath created from an empty string. This path implies that the object itself is the collection.

Identifies the ItemsPath dependency property.

The identifier for the ItemsPath dependency property.

Gets or sets the collection object from which to create this view.

The collection to create the view from.

Identifies the Source dependency property.

The identifier for the Source dependency property.

Gets the view object that is currently associated with this instance of CollectionViewSource.

The view object that is currently associated with this instance of CollectionViewSource.

Identifies the View dependency property.

The identifier for the View dependency property.

Provides data for the CurrentChanging event.

Initializes a new instance of the CurrentChangingEventArgs class.

Initializes a new instance of the CurrentChangingEventArgs class.

**true** to disable the ability to cancel a CurrentItem change; **false** to enable cancellation.

Gets or sets a value that indicates whether the CurrentItem change should be canceled.

**true** if the event should be canceled; otherwise, **false**. The default is **false**.

Gets a value that indicates whether the CurrentItem change can be canceled.

**true** if the event can be canceled; **false** if the event cannot be canceled.

Represents a method that can handle the CurrentChanging event of an ICollectionView implementation.

The source of the event. The event data.

Enables collections to support current record management, grouping, and incremental loading (data virtualization).

Returns any collection groups that are associated with the view.

A vector collection of possible views.

Gets the current item in the view.

The current item in the view or null if there is no current item.

Gets the ordinal position of the CurrentItem within the view.

The ordinal position of the CurrentItem within the view.

Gets a sentinel value that supports incremental loading implementations. See also LoadMoreItemsAsync.

**true** if additional unloaded items remain in the view; otherwise, **false**.

Gets a value that indicates whether the CurrentItem of the view is beyond the end of the collection.

**true** if the CurrentItem of the view is beyond the end of the collection; otherwise, **false**.

Gets a value that indicates whether the CurrentItem of the view is beyond the beginning of the collection.

**true** if the CurrentItem of the view is beyond the beginning of the collection; otherwise, **false**.

When implementing this interface, fire this event after the current item has been changed.

When implementing this interface, fire this event before changing the current item. The event handler can cancel this event.

Initializes incremental loading from the view.

The number of items to load. The wrapped results of the load operation.

Sets the specified item to be the CurrentItem in the view.

The item to set as the CurrentItem. **true** if the resulting CurrentItem is within the view; otherwise, **false**.

Sets the first item in the view as the CurrentItem.

**true** if the resulting CurrentItem is an item within the view; otherwise, **false**.

Sets the last item in the view as the CurrentItem.

**true** if the resulting CurrentItem is an item within the view; otherwise, **false**.

Sets the item after the CurrentItem in the view as the CurrentItem.

**true** if the resulting CurrentItem is an item within the view; otherwise, **false**.

Sets the item at the specified index to be the CurrentItem in the view.

The index of the item to move to. **true** if the resulting CurrentItem is an item within the view; otherwise, **false**.

Sets the item before the CurrentItem in the view as the CurrentItem.

**true** if the resulting CurrentItem is an item within the view; otherwise, **false**.

Supports creation of the relevant ICollectionView implementation.

Creates an ICollectionView instance using default settings.

The default view.

Represents any grouped items within a view.

Gets or sets the grouping context used for grouping the data, which sets the data context for the default HeaderTemplate.

The grouping context used for grouping the data.

Gets the collection of grouped items that this ICollectionViewGroup implementation represents.

A collection of items for the group.

Implements custom property definition support for data binding sources that are implemented using COM.

Gets a value that determines whether the custom property supports read access.

**true** if the property value can be read as a data source. **false** if the property cannot be a data source value.

Gets a value that determines whether the custom property supports write access.

**true** if the value can be written to through a data source relationship in a two-way binding. **false** if the property cannot be written to.

Gets the path-relevant name of the property.

The name of the property as it would be specified in a binding expression.

Gets the underlying type of the custom property.

The underlying type, with relevant information as the values of the TypeName structure. TypeName provides the infrastructure such that property backing does not have to resemble common language runtime (CLR) and **System.Type** definitions.

Gets the value at an index location, for cases where the custom property has indexer support.

The owning instance. The index to get. The retrieved value at the index.

Gets the value of the custom property from a particular instance.

The owning instance. The retrieved value.

Sets the value at an index location, for cases where the custom property has indexer support.

The owner instance. The value to set. The index location to set to.

Sets the custom property value on a specified instance.

The owner instance. The value to set.

Provides lookup service for ICustomProperty support. This interface is implemented by objects so that their custom defined properties can be used as run-time binding sources.

Gets the underlying type of the custom property.

The underlying type, with relevant information as the values of the TypeName structure. TypeName provides the infrastructure such that property backing does not have to take a dependency on the common language runtime (CLR) and **System.Type**.

Gets a custom property's ICustomProperty support object by specifying a property name.

The name of the property to get the support object for. The returned support object for the custom property, or **nullptr**.

Gets a custom property's ICustomProperty support object by specifying a property name and the type of the indexed collection.

The name of the property to get the support object for. The type of the indexed collection, specified as a TypeName wrapper. The returned support object for the custom property, or **nullptr**.

Provides support for "GetStringFromObject" and/or "ToString" logic on the assumption that the implementation supports System.Object. This logic might be accessed by features or services such as generating UI Automation values based on data content.

The provided string.

Provides info about a range of items in the data source.

Updates the ranges of items in the data source that are visible in the list control and that are tracked in the instance of the object that implements the IItemsRangeInfo interface.

The updated range of items in the data source that are visible in the list control. The updated collection of ranges of items in the data source that are tracked in the instance of the object that implements the IItemsRangeInfo interface.

Notifies clients that a property value has changed.

Occurs when a property value changes.

Manages whether items and ranges of items in the data source are selected in the list control.

Marks the items in the data source specified by *itemIndexRange* as not selected in the list control.

A range of items in the data source.

Returns the collection of ranges of items in the data source that are selected in the list control.

A collection of ranges of items in the data source that are selected in the list control..

Provides info about whether the item in the data source at the specified *index* is selected in the list control.

The index of an item in the data source. **true** if the item in the data source at the specified *index* is selected in the list control; otherwise, **false**.

Marks the items in the data source specified by *itemIndexRange* as selected in the list control.

A range of items in the data source.

Specifies a calling contract for collection views that support incremental loading.

Gets a sentinel value that supports incremental loading implementations.

**true** if additional unloaded items remain in the view; otherwise, **false**.

Initializes incremental loading from the view.

The number of items to load. The wrapped results of the load operation.

Provides info about a range of items in the data source.

Initializes an instance of the ItemIndexRange class.

The index of the first item in the instance of the ItemIndexRange class. The number of items in the instance of the ItemIndexRange class.

Gets the index of the first item in the instance of the ItemIndexRange class.

The index of the first item in the instance of the ItemIndexRange class.

Gets the index of the last item in the instance of the ItemIndexRange class.

The index of the last item in the instance of the ItemIndexRange class.

Gets the number of items in the instance of the ItemIndexRange class.

The number of items in the instance of the ItemIndexRange class.

Exposes methods that allow the data to be modified as it passes through the binding engine.

Modifies the source data before passing it to the target for display in the UI.

The source data being passed to the target. The type of the target property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). An optional parameter to be used in the converter logic. The language of the conversion. The value to be passed to the target dependency property.

Modifies the target data before passing it to the source object. This method is called only in **TwoWay** bindings.

The target data being passed to the source. The type of the target property, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). An optional parameter to be used in the converter logic. The language of the conversion. The value to be passed to the source object.

Wraps the asynchronous results of a LoadMoreItemsAsync call.

The number of items that were actually loaded.

Provides data for the PropertyChanged event.

Initializes a new instance of the PropertyChangedEventArgs class.

The short name of the property that changed.

Gets the name of the property that changed.

The name of the property that changed.

Represents the method that will handle the PropertyChanged event. When programming with Microsoft .NET this delegate is hidden, use the System.ComponentModel.PropertyChangedEventHandler delegate.

The source of the event. Event data.

Implements a markup extension that describes the location of the binding source relative to the position of the binding target.

Initializes a new instance of the RelativeSource class by using default relative source mode.

Gets or sets a value that describes the location of the binding source relative to the position of the binding target.

A value of the enumeration.

Defines constants that describe the location of the binding source relative to the position of the binding target.

Don't use this value of RelativeSourceMode; always use either **Self** or **TemplatedParent**.

Refers to the element on which you are setting the binding and allows you to bind one property of that element to another property on the same element.

Refers to the element to which the template (in which the data-bound element exists) is applied. This is similar to setting a TemplateBinding Markup Extension and is only applicable if the Binding is within a template.

Defines constants that indicate when a binding source is updated by its binding target in two-way binding.

Use default behavior from the dependency property that uses the binding. In Windows Runtime, this evaluates the same as a value with **PropertyChanged**.

The binding source is updated only when you call the BindingExpression.UpdateSource method.

The binding source is updated whenever the binding target element loses focus.

The binding source is updated whenever the binding target value changes. This is detected automatically by the binding system.

An abstract class that provides a base for all block-level content elements.

Provides base class initialization behavior for Block derived classes.

Gets or sets a value that indicates how text is aligned in the Block.

One of the TextAlignment enumeration values that specifies how text is aligned. The default is **Left**.

Identifies the HorizontalTextAlignment dependency property.

The identifier for the HorizontalTextAlignment dependency property.

Gets or sets the height of each line of content.

The pixel height of each line as modified by LineStackingStrategy. A value of 0 indicates that the line height is determined automatically from the current font characteristics. The default is 0.

Identifies the LineHeight dependency property.

The identifier for the LineHeight dependency property.

Gets or sets a value that indicates how a line box is determined for each line of text in the Block.

A value that indicates how a line box is determined for each line of text in the Block. The default is **MaxHeight**.

Identifies the LineStackingStrategy dependency property.

The identifier for the LineStackingStrategy dependency property.

Gets or sets the amount of space around a Block element.

The amount of space around a Block element.

Identifies the Margin dependency property.

The identifier for the Margin dependency property.

Gets or sets the horizontal alignment of the text content.

The horizontal alignment of the text content. The default is **Left**.

Identifies the TextAlignment dependency property.

The identifier for the TextAlignment dependency property.

Represents a collection of Block elements.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Block value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Block value specified.

The index at which to set the value. The value to set.

Provides an inline-level content element that causes content to render with a bold font weight.

Initializes a new instance of the Bold class.

Defines a ContentLink that contains a contact.

Initializes a new instance of the ContactContentLinkProvider class.

Provides an inline-level content element that provides facilities for hosting links to contextual information.

Initializes a new instance of the ContentLink class.

Gets or sets a brush that provides the background color of the link.

The brush that provides the background color of the link.

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets the type of cursor to show when the pointer is over the link.

The type of cursor to show when the pointer is over the link.

Identifies the Cursor dependency property.

The identifier for the Cursor dependency property.

Gets or sets a value that specifies the control's preference for whether it plays sounds.

An enumeration value that specifies the control's preference for whether it plays sounds. The default is **Default**.

Identifies the ElementSoundMode dependency property.

The identifier for the ElementSoundMode dependency property.

Gets a value that specifies whether this link has focus, and the mode by which focus was obtained.

A value of the enumeration. A value of **Unfocused** indicates that the link does not have focus.

Identifies the FocusState dependency property.

The identifier for the FocusState dependency property.

Gets or sets the information that the ContentLink contains.

The information that the ContentLink contains.

Gets or sets a value that indicates whether the link is included in tab navigation.

**true** if the control is included in tab navigation; otherwise, **false**. The default is **true**.

Identifies the IsTabStop dependency property.

The identifier for the IsTabStop dependency property.

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.

A value that determines the order of logical navigation for a device. The default value is MaxValue.

Identifies the TabIndex dependency property.

The identifier for the TabIndex dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) down.

The object that gets focus when a user presses the Directional Pad (DPAD) down.

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusDownNavigationStrategy dependency property.

The identifier for the XYFocusDownNavigationStrategy dependency property.

Identifies the XYFocusDown dependency property.

The identifier for the XYFocusDown dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) left.

The object that gets focus when a user presses the Directional Pad (DPAD) left.

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusLeftNavigationStrategy dependency property.

The identifier for the XYFocusLeftNavigationStrategy dependency property.

Identifies the XYFocusLeft dependency property.

The identifier for the XYFocusLeft dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) right.

The object that gets focus when a user presses the Directional Pad (DPAD) right.

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusRightNavigationStrategy dependency property.

The identifier for the XYFocusRightNavigationStrategy dependency property.

Identifies the XYFocusRight dependency property.

The identifier for the XYFocusRight dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) up.

The object that gets focus when a user presses the Directional Pad (DPAD) up.

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusUpNavigationStrategy dependency property.

The identifier for the XYFocusUpNavigationStrategy dependency property.

Identifies the XYFocusUp dependency property.

The identifier for the XYFocusUp dependency property.

Occurs when a link receives focus.

Occurs when user interaction activates the link.

Occurs when a link loses focus.

Attempts to set the focus on the link.

Specifies how focus was set, as a value of the enumeration. **true** if focus was set to the link, or focus was already on the link. **false** if the link is not focusable.

Provides event data for the ContentLink.Invoked event.

Gets the ContentLinkInfo object that contains the data for the invoked link.

The ContentLinkInfo object that contains the data for the invoked link.

Gets or sets a value that marks the event as handled.

**true** to mark the event as handled; otherwise, **false**.

Defines the type of ContentLink used in a text control.

Provides base-class initialization behavior for ContentLinkProvider derived class.

Represents a collection of ContentLinkProvider objects that can be individually accessed by index.

Initializes a new instance of the ContentLinkProviderCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The ContentLinkProvider at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the ContentLinkProvider value specified.

The index at which to set the value. The value to set.

Provides a visual representation of letters, characters, or symbols, in a specific font and style.

Initializes a new instance of the Glyphs class.

Gets or sets the index of the palette to use for the color font.

The index of the palette to use for the color font.

Identifies the ColorFontPaletteIndex dependency property.

The identifier for the ColorFontPaletteIndex dependency property.

Gets or sets the Brush that is used to render the glyphs.

The brush to use to render the glyphs. The default is **null**, which is evaluated as Transparent for rendering.

Identifies the Fill dependency property.

The identifier for the Fill dependency property.

Gets or sets the em size used for rendering the glyphs.

The em size used for rendering. The default is 0.

Identifies the FontRenderingEmSize dependency property.

The identifier for the FontRenderingEmSize dependency property.

Gets or sets the location of the font used for rendering the glyphs.

An object describing the Uniform Resource Identifier (URI) source of the font. The default is null.

Identifies the FontUri dependency property.

The identifier for the FontUri dependency property.

Gets or sets a collection of glyph specifications that represents the Glyphs object.

A collection of glyph specifications that represents the Glyphs object.

Identifies the Indices dependency property.

The identifier for the Indices dependency property.

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

**true** if color glyphs show in color; otherwise, **false**. The default is **true**.

Identifies the IsColorFontEnabled dependency property.

The identifier for the IsColorFontEnabled dependency property.

Gets or sets the x origin for the glyphs.

The x origin of the Glyphs, in pixels. The default is 0.

Identifies the OriginX dependency property.

The identifier for the OriginX dependency property.

Gets or sets the y origin for the glyphs.

The y origin of the Glyphs, in pixels. The default is 0.

Identifies the OriginY dependency property.

The identifier for the OriginY dependency property.

Gets or sets the style simulations applied to the glyphs.

One of the enumeration values that specifies the style simulations to apply to the glyphs. The default is "None".

Identifies the StyleSimulations dependency property.

The identifier for the StyleSimulations dependency property.

Gets or sets the Unicode string to render in glyphs.

A Unicode string with XAML-compatible encoding. The default is an empty string.

Identifies the UnicodeString dependency property.

The identifier for the UnicodeString dependency property.

Provides an inline-level content element that provides facilities for hosting hyperlinks.

Initializes a new instance of the Hyperlink class.

Gets or sets a value that specifies the control's preference for whether it plays sounds.

An enumeration value that specifies the control's preference for whether it plays sounds. The default is **Default**.

Identifies the ElementSoundMode dependency property.

The identifier for the ElementSoundMode dependency property.

Gets a value that specifies whether this hyperlink has focus, and the mode by which focus was obtained.

A value of the enumeration. A value of **Unfocused** indicates that the hyperlink does not have focus.

Identifies the FocusState dependency property.

The identifier for the FocusState dependency property.

Gets or sets a value that indicates whether the hyperlink is included in tab navigation.

**true** if the control is included in tab navigation; otherwise, **false**. The default is **true**.

Identifies the IsTabStop dependency property.

The identifier for the IsTabStop dependency property.

Gets or sets the Uniform Resource Identifier (URI) to navigate to when the Hyperlink is activated.

The Uniform Resource Identifier (URI) to navigate to when the Hyperlink is activated. The default is **null**.

Identifies the NavigateUri dependency property.

The identifier for the NavigateUri dependency property.

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.

A value that determines the order of logical navigation for a device. The default value is MaxValue.

Identifies the TabIndex dependency property.

The identifier for the TabIndex dependency property.

Gets or sets a value that indicates what kind of underline is shown under the hyperlink.

An enumeration value that specifies what kind of underline is shown. The default is **Single**.

Identifies the UnderlineStyle dependency property.

The identifier for the UnderlineStyle dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) down.

The object that gets focus when a user presses the Directional Pad (DPAD).

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusDownNavigationStrategy dependency property.

The identifier for the XYFocusDownNavigationStrategy dependency property.

Identifies the XYFocusDown dependency property.

The identifier for the XYFocusDown dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) left.

The object that gets focus when a user presses the Directional Pad (DPAD).

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusLeftNavigationStrategy dependency property.

The identifier for the XYFocusLeftNavigationStrategy dependency property.

Identifies the XYFocusLeft dependency property.

The identifier for the XYFocusLeft dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) right.

The object that gets focus when a user presses the Directional Pad (DPAD).

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusRightNavigationStrategy dependency property.

The identifier for the XYFocusRightNavigationStrategy dependency property.

Identifies the XYFocusRight dependency property.

The identifier for the XYFocusRight dependency property.

Gets or sets the object that gets focus when a user presses the Directional Pad (DPAD) up.

The object that gets focus when a user presses the Directional Pad (DPAD).

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

A value of the enumeration. The default is **Auto**.

Identifies the XYFocusUpNavigationStrategy dependency property.

The identifier for the XYFocusUpNavigationStrategy dependency property.

Identifies the XYFocusUp dependency property.

The identifier for the XYFocusUp dependency property.

Occurs when the Hyperlink is clicked.

Occurs when a **Hyperlink** receives focus.

Occurs when a **Hyperlink** loses focus.

Attempts to set the focus on the hyperlink.

Specifies how focus was set, as a value of the enumeration. **true** if focus was set to the hyperlink, or focus was already on the hyperlink. **false** if the hyperlink is not focusable.

Provides data for the Hyperlink.Click event.

Provides a base class for inline text elements, such as Span and Run.

Provides base class initialization behavior for Inline derived classes.

Represents a collection of Inline elements.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Inline value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Inline value specified.

The index at which to set the value. The value to set.

Provides an inline content element that enables UIElement types to be embedded in the content of a RichTextBlock.

Initializes a new instance of the InlineUIContainer class.

Gets or sets the UIElement hosted by the InlineUIContainer.

The UIElement hosted by the InlineUIContainer.

Provides an inline-level flow content element that causes content to render with an italic font style.

Initializes a new instance of the Italic class.

Represents an inline element that causes a new line to begin in content when rendered in a text container.

Initializes a new instance of the LineBreak class.

Specifies a logical direction in which to perform certain text operations, such as inserting, retrieving, or navigating through text relative to a specified position (a TextPointer ).

Backward, or from right to left.

Forward, or from left to right.

Provides a block-level content element that is used to group content into a paragraph.

Initializes a new instance of the Paragraph class.

Gets an InlineCollection containing the top-level Inline elements that include the contents of the Paragraph.

An InlineCollection containing the Inline elements that include the contents of the Paragraph.

Gets or sets the indentation of the first line of text in a paragraph, in pixels.

The offset amount, in pixels, of the first line of text in a paragraph.

Identifies the TextIndent dependency property.

The identifier for the TextIndent dependency property.

Defines a ContentLink that contains a place.

Initializes a new instance of the PlaceContentLinkProvider class.

Represents a discrete section of formatted or unformatted text.

Initializes a new instance of the Run class.

Gets or sets the direction that text and other user interface elements flow within the Run element that controls their layout.

The direction that text and other user interface (UI) elements flow within the Run element. The default value is **LeftToRight**.

Identifies the FlowDirection  dependency property.

The identifier of the FlowDirection  dependency property.

Gets or sets the text contents of the Run.

A string that specifies the text contents of the Run. The default is String.Empty.

Groups other Inline content elements. Parent class for Bold, Hyperlink, Italic and Underline.

Initializes a new instance of the Span class.

Gets an InlineCollection containing the top-level inline elements that include the contents of Span.

An InlineCollection containing the inline elements that include the contents of the Span. This property has no default value.

An abstract class used as the base class for the also-abstract Block and Inline classes. TextElement supports common API for classes involved in the XAML text object model, such as properties that control text size, font families and so on.

Gets or sets the access key for this element.

The access key for this element.

Identifies the AccessKey dependency property.

The identifier for the AccessKey dependency property.

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

The element that defines the access key scope.

Identifies the **AccessKeyScopeOwner** dependency property.

The identifier for the **AccessKeyScopeOwner** dependency property.

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

**true** if the element gets focus when a user interacts with it; otherwise, **false**.

Identifies the AllowFocusOnInteraction dependency property.

The identifier for the AllowFocusOnInteraction dependency property.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Identifies the CharacterSpacing dependency property.

The identifier for the CharacterSpacing dependency property.

Gets a TextPointer that represents the end of the content in the element.

A TextPointer that represents the end of the content in the TextElement.

Gets a TextPointer that represents the start of content in the element.

A TextPointer that represents the start of the content in the TextElement.

Gets a TextPointer that represents the position just after the end of the element.

A TextPointer that represents the position just after the end of the TextElement.

Gets a TextPointer that represents the position just before the start of the element.

A TextPointer that represents the position just before the start of the TextElement.

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

**true** to dismiss the access key display when an access key is invoked; otherwise, **false**.

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

The identifier for the ExitDisplayModeOnAccessKeyInvoked dependency property.

Gets or sets the preferred top-level font family for the content of the element.

The preferred font family, or a primary preferred font family with one or more fallback font families. See FontFamily for default information.

Identifies the FontFamily dependency property.

The identifier for the FontFamily dependency property.

Gets or sets the font size for the content of the element.

The desired font size in pixels. The default is 11 pixels.

Identifies the FontSize dependency property.

Identifier for the FontSize dependency property.

Gets or sets the glyph width of the font in a family to select.

One of the FontStretch constant names, specifying the desired font stretch. The default is **Normal**.

Identifies the FontStretch dependency property.

Identifier for the FontStretch dependency property.

Gets or sets the font style for the content in this element.

One of the FontStyle constant names, specifying the font style. The default is **Normal**.

Identifies the FontStyle dependency property.

Identifier for the FontStyle dependency property.

Gets or sets the top-level font weight to select from the font family for the content in this element.

One of the FontWeights property values, specifying the font weight. The default is Normal.

Identifies the FontWeight dependency property.

Identifier for the FontWeight dependency property.

Gets or sets the Brush to apply to the content in this element.

The brush that is applied to the text content. The default is a SolidColorBrush with Color value Black.

Identifies the Foreground dependency property.

Identifier for the Foreground dependency property.

Gets or sets a value that indicates whether an element defines its own access key scope.

**true** if an element defines its own scope; otherwise, **false**.

Identifies the **IsAccessKeyScope** dependency property.

The identifier for the **IsAccessKeyScope** dependency property.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

**true** if automatic text enlargement is enabled; otherwise, **false**.

Identifies the IsTextScaleFactorEnabled  dependency property.

The identifier for the IsTextScaleFactorEnabled dependency property.

Gets or sets a value that indicates how far left or right the keytip is placed in relation to the text element.

The number of pixels to move the KeyTip. Positive values move it right. Negative values move it left.

Identifies the **KeyTipHorizontalOffset** dependency property.

The identifier for the **KeyTipHorizontalOffset** dependency property.

Gets or sets a value that indicates where the KeyTip is placed in relation to the text element.

A value of the enumeration. The default is **Auto**.

Identifies the **KeyTipPlacementMode** dependency property.

The identifier for the **KeyTipPlacementMode** dependency property.

Gets or sets a value that indicates how far up or down the keytip is placed in relation to the text element.

The number of pixels to move the KeyTip. Positive values move it down. Negative values move it up.

Identifies the **KeyTipVerticalOffset** dependency property.

The identifier for the **KeyTipVerticalOffset** dependency property.

Gets or sets localization/globalization language information that applies to a TextElement.

A string specifying language and culture that follows the RFC 3066 / ISO 639-1 standards. For example, U.S. English is "en-US".

Identifies the Language dependency property.

The identifier for the Language dependency property.

Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML.

The unique identifier for the object. This property is read-only for code, but write-only for XAML, due to special parser handling of XAML properties named "Name".

Gets or sets a value that indicates what decorations are applied to the text.

A value of the enumeration. The default is **None**.

Identifies the **TextDecorations** dependency property.

The identifier for the **TextDecorations** dependency property.

Gets or sets the XamlRoot in which this element is being viewed.

The XamlRoot in which this element is being viewed. The default is **null**.

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked.

Retrieves an object in the object model / runtime object graph by referencing the object's **x:Name** or **Name** attribute value.

The name of the object to retrieve. The object that has the specified name, or null if no object is retrieved.

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or child property.

Represents an object that highlights one or more ranges of text.

Initializes a new instance of the TextHighlighter class.

Gets or sets the brush used to highlight the text.

The brush used to highlight the text.

Identifies the Background dependency property.

The identifier for the Background dependency property.

Gets or sets the brush used to color highlighted text.

The brush used to color highlighted text.

Identifies the Foreground dependency property.

The identifier for the Foreground dependency property.

Gets the text ranges to highlight.

The collection of text ranges to highlight.

The base class for TextHighlighter.

Represents a position within a text element.

Gets the logical direction associated with the current position, which is used to disambiguate content associated with the current position.

The LogicalDirection value that is associated with the current position.

Gets the character index of a TextPointer within its container.

The character index of a TextPointer within its container.

Gets the logical parent that contains the current position.

The logical parent that contains the current position. Can return the RichEditBox when at the top of the content stack.

Gets the user interface (UI) element that "owns" this TextPointer.

The UI element that "owns" this TextPointer.

Returns a bounding box for content that borders the current TextPointer in the specified logical direction.

One of the LogicalDirection values that specifies the logical direction in which to find a content bounding box. A Rect for content that borders the current TextPointer in the specified direction, or a Rect that evaluates as Empty if current and valid layout information is unavailable.

Returns a TextPointer to the position indicated by the specified offset, in symbols, from the beginning of the current TextPointer and in the specified direction.

An offset, in symbols, for which to calculate and return the position. If the offset is negative, the returned TextPointer precedes the current TextPointer; otherwise, it follows. One of the LogicalDirection values that specifies the logical direction of the returned TextPointer. A TextPointer to the position indicated by the specified offset and in the direction specified by the direction parameter, or null if the offset extends past the end of the content.

Represents a selection of text content.

The length of the current selection, in Unicode characters.

The position that marks the beginning of the current selection, measured in Unicode characters from the beginning of the text.

Provides access to a set of Microsoft OpenType typography properties. These properties are implemented as XAML attached properties such that they can be set from text object model properties as well as from specific text controls.

Identifies the AnnotationAlternates attached property.

The identifier for the AnnotationAlternates attached property.

Identifies the CapitalSpacing attached property.

The identifier for the CapitalSpacing attached property.

Identifies the Capitals attached property.

The identifier for the Capitals attached property.

Identifies the CaseSensitiveForms attached property.

The identifier for the CaseSensitiveForms attached property.

Identifies the ContextualAlternates attached property.

The identifier for the ContextualAlternates attached property.

Identifies the ContextualLigatures attached property.

The identifier for the ContextualLigatures attached property.

Identifies the ContextualSwashes attached property.

The identifier for the ContextualSwashes attached property.

Identifies the DiscretionaryLigatures attached property.

The identifier for the DiscretionaryLigatures attached property.

Identifies the EastAsianExpertForms attached property.

The identifier for the EastAsianExpertForms attached property.

Identifies the EastAsianLanguage attached property.

The identifier for the EastAsianLanguage attached property.

Identifies the EastAsianWidths attached property.

The identifier for the EastAsianWidths attached property.

Identifies the Fraction attached property.

The identifier for the Fraction attached property.

Identifies the HistoricalForms attached property.

The identifier for the HistoricalForms attached property.

Identifies the HistoricalLigatures attached property.

The identifier for the HistoricalLigatures attached property.

Identifies the Kerning attached property.

The identifier for the Kerning attached property.

Identifies the MathematicalGreek attached property.

The identifier for the MathematicalGreek attached property.

Identifies the NumeralAlignment attached property.

The identifier for the NumeralAlignment attached property.

Identifies the NumeralStyle attached property.

The identifier for the NumeralStyle attached property.

Identifies the SlashedZero attached property.

The identifier for the SlashedZero attached property.

Identifies the StandardLigatures attached property.

The identifier for the StandardLigatures attached property.

Identifies the StandardSwashes attached property.

The identifier for the StandardSwashes attached property.

Identifies the StylisticAlternates attached property.

The identifier for the StylisticAlternates attached property.

Identifies the StylisticSet10 attached property.

The identifier for the StylisticSet10 attached property.

Identifies the StylisticSet11 attached property.

The identifier for the StylisticSet11 attached property.

Identifies the StylisticSet12 attached property.

The identifier for the StylisticSet12 attached property.

Identifies the StylisticSet13 attached property.

The identifier for the StylisticSet13 attached property.

Identifies the StylisticSet14 attached property.

The identifier for the StylisticSet14 attached property.

Identifies the StylisticSet15 attached property.

The identifier for the StylisticSet15 attached property.

Identifies the StylisticSet16 attached property.

The identifier for the StylisticSet16 attached property.

Identifies the StylisticSet17 attached property.

The identifier for the StylisticSet17 attached property.

Identifies the StylisticSet18 attached property.

The identifier for the StylisticSet18 attached property.

Identifies the StylisticSet19 attached property.

The identifier for the StylisticSet19 attached property.

Identifies the StylisticSet1 attached property.

The identifier for the StylisticSet1 attached property.

Identifies the StylisticSet20 attached property.

The identifier for the StylisticSet20 attached property.

Identifies the StylisticSet2 attached property.

The identifier for the StylisticSet2 attached property.

Identifies the StylisticSet3 attached property.

The identifier for the StylisticSet3 attached property.

Identifies the StylisticSet4 attached property.

The identifier for the StylisticSet4 attached property.

Identifies the StylisticSet5 attached property.

The identifier for the StylisticSet5 attached property.

Identifies the StylisticSet6 attached property.

The identifier for the StylisticSet6 attached property.

Identifies the StylisticSet7 attached property.

The identifier for the StylisticSet7 attached property.

Identifies the StylisticSet8 attached property.

The identifier for the StylisticSet8 attached property.

Identifies the StylisticSet9 attached property.

The identifier for the StylisticSet9 attached property.

Identifies the Variants attached property.

The identifier for the Variants attached property.

Returns the value of the AnnotationAlternates attached property for a specified dependency object.

The dependency object for which to retrieve the value of the AnnotationAlternates property. The current value of the AnnotationAlternates attached property on the specified dependency object.

Returns the value of the Capitals attached property for a specified dependency object.

The dependency object for which to retrieve the value of the Capitals property. The current value of the Capitals attached property on the specified dependency object.

Returns the value of the CapitalSpacing attached property for a specified dependency object.

The dependency object for which to retrieve the value of the CapitalSpacing property. The current value of the CapitalSpacing attached property on the specified dependency object.

Returns the value of the CaseSensitiveForms attached property for a specified dependency object.

The dependency object for which to retrieve the value of the CaseSensitiveForms property. The current value of the CaseSensitiveForms attached property on the specified dependency object.

Returns the value of the ContextualAlternates attached property for a specified dependency object.

The dependency object for which to retrieve the value of the ContextualAlternates property. The current value of the ContextualAlternates attached property on the specified dependency object.

Returns the value of the ContextualLigatures attached property for a specified dependency object.

The dependency object for which to retrieve the value of the ContextualLigatures property. The current value of the ContextualLigatures attached property on the specified dependency object.

Returns the value of the ContextualSwashes attached property for a specified dependency object.

The dependency object for which to retrieve the value of the ContextualSwashes property. The current value of the ContextualSwashes attached property on the specified dependency object.

Returns the value of the DiscretionaryLigatures attached property for a specified dependency object.

The dependency object for which to retrieve the value of the DiscretionaryLigatures property. The current value of the DiscretionaryLigatures attached property on the specified dependency object.

Returns the value of the EastAsianExpertForms attached property for a specified dependency object.

The dependency object for which to retrieve the value of the EastAsianExpertForms property. The current value of the EastAsianExpertForms attached property on the specified dependency object.

Returns the value of the EastAsianLanguage attached property for a specified dependency object.

The dependency object for which to retrieve the value of the EastAsianLanguage property. The current value of the EastAsianLanguage attached property on the specified dependency object.

Returns the value of the EastAsianWidths attached property for a specified dependency object.

The dependency object for which to retrieve the value of the EastAsianWidths property. The current value of the EastAsianWidths attached property on the specified dependency object.

Returns the value of the Fraction attached property for a specified dependency object.

The dependency object for which to retrieve the value of the Fraction property. The current value of the Fraction attached property on the specified dependency object.

Returns the value of the HistoricalForms attached property for a specified dependency object.

The dependency object for which to retrieve the value of the HistoricalForms property. The current value of the HistoricalForms attached property on the specified dependency object.

Returns the value of the HistoricalLigatures attached property for a specified dependency object.

The dependency object for which to retrieve the value of the HistoricalLigatures property. The current value of the HistoricalLigatures attached property on the specified dependency object.

Returns the value of the Kerning attached property for a specified dependency object.

The dependency object for which to retrieve the value of the Kerning property. The current value of the Kerning attached property on the specified dependency object.

Returns the value of the MathematicalGreek attached property for a specified dependency object.

The dependency object for which to retrieve the value of the MathematicalGreek property. The current value of the MathematicalGreek attached property on the specified dependency object.

Returns the value of the NumeralAlignment attached property for a specified dependency object.

The dependency object for which to retrieve the value of the NumeralAlignment property. The current value of the NumeralAlignment attached property on the specified dependency object.

Returns the value of the NumeralStyle attached property for a specified dependency object.

The dependency object for which to retrieve the value of the NumeralStyle property. The current value of the NumeralStyle attached property on the specified dependency object.

Returns the value of the SlashedZero attached property for a specified dependency object.

The dependency object for which to retrieve the value of the SlashedZero property. The current value of the SlashedZero attached property on the specified dependency object.

Returns the value of the StandardLigatures attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StandardLigatures property. The current value of the StandardLigatures attached property on the specified dependency object.

Returns the value of the StandardSwashes attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StandardSwashes property. The current value of the StandardSwashes attached property on the specified dependency object.

Returns the value of the StylisticAlternates attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticAlternates property. The current value of the StylisticAlternates attached property on the specified dependency object.

Returns the value of the StylisticSet1 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet1 property. The current value of the StylisticSet1 attached property on the specified dependency object.

Returns the value of the StylisticSet10 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet10 property. The current value of the StylisticSet10 attached property on the specified dependency object.

Returns the value of the StylisticSet11 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet11 property. The current value of the StylisticSet11 attached property on the specified dependency object.

Returns the value of the StylisticSet12 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet12 property. The current value of the StylisticSet12 attached property on the specified dependency object.

Returns the value of the StylisticSet13 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet13 property. The current value of the StylisticSet13 attached property on the specified dependency object.

Returns the value of the StylisticSet14 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet14 property. The current value of the StylisticSet14 attached property on the specified dependency object.

Returns the value of the StylisticSet15 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet15 property. The current value of the StylisticSet15 attached property on the specified dependency object.

Returns the value of the StylisticSet16 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet16 property. The current value of the StylisticSet16 attached property on the specified dependency object.

Returns the value of the StylisticSet17 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet17 property. The current value of the StylisticSet17 attached property on the specified dependency object.

Returns the value of the StylisticSet18 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet18 property. The current value of the StylisticSet18 attached property on the specified dependency object.

Returns the value of the StylisticSet19 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet19 property. The current value of the StylisticSet19 attached property on the specified dependency object.

Returns the value of the StylisticSet2 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet2 property. The current value of the StylisticSet2 attached property on the specified dependency object.

Returns the value of the StylisticSet20 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet20 property. The current value of the StylisticSet20 attached property on the specified dependency object.

Returns the value of the StylisticSet3 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet3 property. The current value of the StylisticSet3 attached property on the specified dependency object.

Returns the value of the StylisticSet4 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet4 property. The current value of the StylisticSet4 attached property on the specified dependency object.

Returns the value of the StylisticSet5 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet5 property. The current value of the StylisticSet5 attached property on the specified dependency object.

Returns the value of the StylisticSet6 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet6 property. The current value of the StylisticSet6 attached property on the specified dependency object.

Returns the value of the StylisticSet7 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet7 property. The current value of the StylisticSet7 attached property on the specified dependency object.

Returns the value of the StylisticSet8 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet8 property. The current value of the StylisticSet8 attached property on the specified dependency object.

Returns the value of the StylisticSet9 attached property for a specified dependency object.

The dependency object for which to retrieve the value of the StylisticSet9 property. The current value of the StylisticSet9 attached property on the specified dependency object.

Returns the value of the Variants attached property for a specified dependency object.

The dependency object for which to retrieve the value of the Variants property. The current value of the Variants attached property on the specified dependency object.

Sets the value of the AnnotationAlternates attached property for a specified dependency object.

The dependency object for which to set the value of the AnnotationAlternates property. The new value to set the property to.

Sets the value of the Capitals attached property for a specified dependency object.

The dependency object for which to set the value of the Capitals property. The new value to set the property to.

Sets the value of the CapitalSpacing attached property for a specified dependency object.

The dependency object for which to set the value of the CapitalSpacing property. The new value to set the property to.

Sets the value of the CaseSensitiveForms attached property for a specified dependency object.

The dependency object for which to set the value of the CaseSensitiveForms property. The new value to set the property to.

Sets the value of the ContextualAlternates attached property for a specified dependency object.

The dependency object for which to set the value of the ContextualAlternates property. The new value to set the property to.

Sets the value of the ContextualLigatures attached property for a specified dependency object.

The dependency object for which to set the value of the ContextualLigatures property. The new value to set the property to.

Sets the value of the ContextualSwashes attached property for a specified dependency object.

The dependency object for which to set the value of the ContextualSwashes property. The new value to set the property to.

Sets the value of the DiscretionaryLigatures attached property for a specified dependency object.

The dependency object for which to set the value of the DiscretionaryLigatures property. The new value to set the property to.

Sets the value of the EastAsianExpertForms attached property for a specified dependency object.

The dependency object for which to set the value of the EastAsianExpertForms property. The new value to set the property to.

Sets the value of the EastAsianLanguage attached property for a specified dependency object.

The dependency object for which to set the value of the EastAsianLanguage property. The new value to set the property to.

Sets the value of the EastAsianWidths attached property for a specified dependency object.

The dependency object for which to set the value of the EastAsianWidths property. The new value to set the property to.

Sets the value of the Fraction attached property for a specified dependency object.

The dependency object for which to set the value of the Fraction property. The new value to set the property to.

Sets the value of the HistoricalForms attached property for a specified dependency object.

The dependency object for which to set the value of the HistoricalForms property. The new value to set the property to.

Sets the value of the HistoricalLigatures attached property for a specified dependency object.

The dependency object for which to set the value of the HistoricalLigatures property. The new value to set the property to.

Sets the value of the Kerning attached property for a specified dependency object.

The dependency object for which to set the value of the Kerning property. The new value to set the property to.

Sets the value of the MathematicalGreek attached property for a specified dependency object.

The dependency object for which to set the value of the MathematicalGreek property. The new value to set the property to.

Sets the value of the NumeralAlignment attached property for a specified dependency object.

The dependency object for which to set the value of the NumeralAlignment property. The new value to set the property to.

Sets the value of the NumeralStyle attached property for a specified dependency object.

The dependency object for which to set the value of the NumeralStyle property. The new value to set the property to.

Sets the value of the SlashedZero attached property for a specified dependency object.

The dependency object for which to set the value of the SlashedZero property. The new value to set the property to.

Sets the value of the StandardLigatures attached property for a specified dependency object.

The dependency object for which to set the value of the StandardLigatures property. The new value to set the property to.

Sets the value of the StandardSwashes attached property for a specified dependency object.

The dependency object for which to set the value of the StandardSwashes property. The new value to set the property to.

Sets the value of the StylisticAlternates attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticAlternates property. The new value to set the property to.

Sets the value of the StylisticSet1 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet1 property. The new value to set the property to.

Sets the value of the StylisticSet10 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet10 property. The new value to set the property to.

Sets the value of the StylisticSet11 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet11 property. The new value to set the property to.

Sets the value of the StylisticSet12 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet12 property. The new value to set the property to.

Sets the value of the StylisticSet13 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet13 property. The new value to set the property to.

Sets the value of the StylisticSet14 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet14 property. The new value to set the property to.

Sets the value of the StylisticSet15 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet15 property. The new value to set the property to.

Sets the value of the StylisticSet16 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet16 property. The new value to set the property to.

Sets the value of the StylisticSet17 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet17 property. The new value to set the property to.

Sets the value of the StylisticSet18 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet18 property. The new value to set the property to.

Sets the value of the StylisticSet19 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet19 property. The new value to set the property to.

Sets the value of the StylisticSet2 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet2 property. The new value to set the property to.

Sets the value of the StylisticSet20 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet20 property. The new value to set the property to.

Sets the value of the StylisticSet3 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet3 property. The new value to set the property to.

Sets the value of the StylisticSet4 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet4 property. The new value to set the property to.

Sets the value of the StylisticSet5 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet5 property. The new value to set the property to.

Sets the value of the StylisticSet6 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet6 property. The new value to set the property to.

Sets the value of the StylisticSet7 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet7 property. The new value to set the property to.

Sets the value of the StylisticSet8 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet8 property. The new value to set the property to.

Sets the value of the StylisticSet9 attached property for a specified dependency object.

The dependency object for which to set the value of the StylisticSet9 property. The new value to set the property to.

Sets the value of the Variants attached property for a specified dependency object.

The dependency object for which to set the value of the Variants property. The new value to set the property to.

Provides an inline-level content element that causes content to render with an underlined text decoration.

Initializes a new instance of the Underline class.

Defines constants that specify the look of the underline used for an element.

The element is not underlined.

The element is underlined with a single, solid line.

Enables access to composition visual objects that back XAML elements in the XAML composition tree.

Retrieves the content root of an AppWindow.

The AppWindow to get the content from. The content root of the AppWindow.

Retrieves a Windows.UI.Composition.Visual object previously set by a call to SetElementChildVisual.

The element to retrieve the Visual for. A Windows.UI.Composition.Visual object previously set by a call to SetElementChildVisual.

Retrieves the Windows.UI.Composition.Visual object that backs a XAML element in the XAML composition tree.

The element to retrieve the Visual for. The Windows.UI.Composition.Visual object that backs the XAML element.

Retrieves the pointer position relative to a UIElement.

The element that the pointer position is relative to. The position properties of the pointer.

Retrieves the composition properties of a ScrollViewer element.

The ScrollViewer element to get the composition properties for. The composition properties of the specified ScrollViewer.

Sets a XAML UIElement as the content root of an AppWindow.

The AppWindow to set the content for. The content to set.

Sets a custom Windows.UI.Composition.Visual as the last child of the element’s visual tree.

The element to add the child Visual to. The Visual to add to the element's visual tree.

Associates the specified hide animation with a UIElement.

The UIElement to associate the animation with. The animation to play when the UIElement is hidden. A **Null** value prevents hide animations from playing for this element until the method is called again with an animation value.

Associates the specified show animation with a UIElement.

The UIElement to associate the animation with. The animation to play when the UIElement is shown. A **Null** value prevents show animations from playing for this element until the method is called again with an animation value.

Toggles the ability to set, animate, and use a render-time post-layout translate transform to position XAML elements on screen using Composition APIs.

The element on which to enable or disable translate transforms. **true** to enable translate transforms; **false** to disable translate transforms.

Provides event data for the AccessKeyDisplayDismissed event.

Initializes a new instance of the AccessKeyDisplayDismissedEventArgs class.

Provides event data for the AccessKeyDisplayRequested event.

Initializes a new instance of the AccessKeyDisplayRequestedEventArgs class.

Gets the keys that were pressed to start the access key sequence.

The keys that were pressed to start the access key sequence.

Provides event data for the AccessKeyInvoked event.

Initializes a new instance of the AccessKeyInvokedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

A helper class that enables access keys (mnemonics) for XAML user interfaces.

Gets or sets a value that specifies whether KeyTips are shown for access keys.

**true** to show KeyTips; otherwise, **false**. The default is **true**.

Gets a value that indicates whether the app has started an access key sequence.

**true** if an access key sequence has started; otherwise, **false**.

Occurs when the app enters or exits an access key sequence.

Causes the app to exit an access key sequence.

Provides event data for the CanExecuteRequested event.

Gets or sets a value indicating whether the ICommand that raised this event is able to execute.

**true** if the ICommand is able to execute; otherwise, **false**.

Gets the command parameter passed into the CanExecute method that raised this event.

Provides event data for the UIElement.CharacterReceived  routed event.

Gets the composed character associated with the UIElement.CharacterReceived event.

The composed character associated with the UIElement.CharacterReceived event.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the status of the physical key that raised the character-received event.

The status of the key that was pressed.

Provides event data for the ContextRequested event.

Initializes a new instance of the ContextRequestedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A Point that represents the current x- and y-coordinates of the mouse pointer position. If **null** was passed as *relativeTo*, this coordinate is for the overall window. If a *relativeTo* value other than **null** was passed, this coordinate is relative to the object referenced by *relativeTo*. **true** if the context request was initiated by a pointer device; otherwise, **false**.

Represents the method that will handle the DoubleTapped event.

The object where the event handler is attached. Event data for the event.

Provides event data for the DoubleTapped event.

Initializes a new instance of the DoubleTappedRoutedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the PointerDeviceType for the pointer device that initiated the associated input event.

The PointerDeviceType for this event occurrence.

Returns the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A Point that represents the current x- and y-coordinates of the mouse pointer position. If **null** was passed as *relativeTo*, this coordinate is for the overall window. If a *relativeTo* value other than **null** was passed, this coordinate is relative to the object referenced by *relativeTo*.

Provides event data for the ExecuteRequested event.

Gets the command parameter passed into the Execute method that raised this event.

Provides options to help identify the next element that can programmatically receive navigation focus.

Initializes a new instance of the FindNextElementOptions class.

Gets or sets a bounding rectangle where all overlapping navigation candidates are excluded from navigation focus.

The bounding rectangle.

Gets or sets a bounding rectangle used to identify the focus candidates most likely to receive navigation focus.

The bounding rectangle.

Gets or sets the object that must be the root from which to identify the next focus candidate to receive navigation focus.

The root object.

Gets or sets the focus navigation strategy used to identify the best candidate element to receive focus.

The focus navigation strategy.

Specifies the input device types from which input events are received.

Game controller/remote control input device.

Keyboard input device.

Mouse input device.

No input. Used only when the focus is moved programmatically.

Pen input device.

Touch input device.

A helper class that enables global management of focus actions and events across all elements in an application.

Occurs before an element actually receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when an element within a container element (a focus scope) receives focus. This event is raised asynchronously, so focus might move before bubbling is complete.

Occurs before focus moves from the current element with focus to the target element. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when an element within a container element (a focus scope) loses focus. This event is raised asynchronously, so focus might move again before bubbling is complete.

Retrieves the first element that can receive focus based on the specified scope.

The root object from which to search. If **null**, the search scope is the current window. The first focusable object.

Retrieves the last element that can receive focus based on the specified scope.

The root object from which to search. If **null**, the search scope is the current window. The last focusable object.

Retrieves the element that should receive focus based on the specified navigation direction.

The direction that focus moves from element to element within the app UI. The next object to receive focus.

Retrieves the element that should receive focus based on the specified navigation direction (cannot be used with tab navigation, see remarks).

The direction that focus moves from element to element within the app UI. The options to help identify the next element to receive focus with keyboard/controller/remote navigation. The next object to receive focus.

Retrieves the element that should receive focus based on the specified navigation direction.

The direction that focus moves from element to element within the application UI. **null** if focus cannot be set in the specified direction.

Retrieves the element that should receive focus based on the specified navigation direction and hint rectangle.

The direction that focus moves from element to element within the app UI. A bounding rectangle used to influence which element is most likely to be considered the next to receive focus. Examples where this can be useful include: **null** if focus cannot be set in the specified direction.

Retrieves the element in the UI that has focus.

The object that has focus. Typically, this is a Control class.

Retrieves the focused element within the Xaml island container.

The object that has focus. Typically, this is a Control class.

Asynchronously attempts to set focus on an element when the application is initialized.

The object on which to set focus. One of the values from the FocusState enumeration that specify how an elemnent can obtain focus. The FocusMovementResult that indicates whether focus was successfully set.

Attempts to change focus from the element with focus to the next focusable element in the specified direction.

The direction to traverse (in tab order). **true** if focus moved; otherwise, **false**.

Attempts to change focus from the element with focus to the next focusable element in the specified direction, using the specified navigation options.

The direction to traverse (in tab order). The options to help identify the next element to receive focus with keyboard/controller/remote navigation. **true** if focus moved; otherwise, **false**.

Asynchronously attempts to change focus from the current element with focus to the next focusable element in the specified direction.

The direction that focus moves from element to element within the app UI. The FocusMovementResult that indicates whether focus was successfully set.

Asynchronously attempts to change focus from the current element with focus to the next focusable element in the specified direction and subject to the specified navigation options.

The direction that focus moves from element to element within the app UI. The navigation options used to identify the focus candidate. The FocusMovementResult that indicates whether focus was successfully set.

Provides data for the GotFocus event.

Gets the unique ID generated when a focus movement event is initiated.

The unique ID, if any. Otherwise, **null**.

Gets the most recent focused element.

The most recent focused element.

Provides data for the LostFocus event.

Gets the unique ID generated when a focus movement event is initiated.

The unique ID, if any. Otherwise, **null**.

Gets the last focused element.

The last focused element.

Represents the status of a focus operation.

Gets a boolean value that indicates whether focus can be assigned to an object.

True, if focus can be assigned; otherwise, false.

Specifies the direction that you can programmatically move focus from one element to another element within the app UI.

An element below the element with focus.

An element to the left of the element with focus.

The next element in the tab order.

No change in focus.

The previous element in the tab order.

An element to the right of the element with focus.

An element above the element with focus.

Provides data for the FocusManager.GettingFocus and UIElement.GettingFocus events.

Gets or sets whether focus navigation should be canceled.

**true** if focus navigation should be canceled. Otherwise, **false**.

Gets the unique ID generated when a focus movement event is initiated.

The unique ID, if any. Otherwise, **null**.

Gets the direction that focus moved from element to element within the app UI.

The direction of focus movement.

Gets the input mode through which an element obtained focus.

How the element obtained focus.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the input device type from which input events are received.

The input device type.

Gets the most recent focused object.

The most recent focused object.

Gets the last focused object.

The last focused object.

Attempts to cancel the ongoing focus action.

True, if the focus action is canceled; otherwise, false.

Attempts to redirect focus to the specified element instead of the original targeted element.

The object on which to set focus. True, if the focus action is redirected; otherwise, false.

Represents the method that will handle the Holding event.

The object where the event handler is attached. Event data for the event.

Provides event data for the Holding event.

Initializes a new instance of the HoldingRoutedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the underlying HoldingState for the interaction

A value of the enumeration.

Gets the PointerDeviceType for the pointer device that initiated the associated input event.

The PointerDeviceType for this event occurrence.

Returns the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A Point that represents the current x- and y-coordinates of the mouse pointer position. If **null** was passed as *relativeTo*, this coordinate is for the overall window. If a *relativeTo* value other than **null** was passed, this coordinate is relative to the object referenced by *relativeTo*.

Defines the command behavior of an interactive UI element that performs an action when invoked, such as sending an email, deleting an item, or submitting a form.

Occurs whenever something happens that affects whether the command can execute.

Retrieves whether the command can execute in its current state.

Data used by the command. If the command does not require data, this object can be set to null. **true** if this command can be executed; otherwise, **false**.

Defines the method to be called when the command is invoked.

Data used by the command. If the command does not require data to be passed, this value can be null.

Controls the deceleration of a resizing manipulation during inertia.

Gets or sets the rate that resizing slows.

The rate that resizing slows.

Gets or sets the amount the element resizes at the end of inertia.

The amount the element resizes at the end of inertia.

Controls the deceleration of a rotation manipulation during inertia.

Gets or sets the rate the rotation slows in degrees per squared millisecond.

The rate the rotation slows in degrees per squared millisecond.

Gets or sets the rotation, in degrees, at the end of the inertial movement.

The rotation, in degrees, at the end of the inertial movement.

Controls deceleration on a translation manipulation during inertia.

Gets or sets the rate the linear movement slows in device-independent units (1/96th inch per unit) per squared millisecond.

The rate the linear movement slows in device-independent units (1/96th inch per unit) per squared millisecond.

Gets or sets the linear movement of the manipulation at the end of inertia.

The linear movement of the manipulation at the end of inertia.

Represents information related to the data provided by an input method.

Initializes a new instance of the InputScope class.

Gets a collection of valid InputScopeName items that are relevant to this InputScope.

A collection of valid InputScopeName items. Valid input scope names are specifed by the InputScopeNameValue enumeration.

Identifies a particular named input scope that is relevant to an overall InputScope.

Initializes a new instance of the InputScopeName class with no initial value.

Initializes a new instance of the InputScopeName class, using an input name based on the InputScopeNameValue enumeration.

An input name based on the InputScopeNameValue enumeration.

Gets or sets the specific input scope name value for this InputScopeName.

A value of the enumeration.

Specifies a particular named input mode (InputScopeName ) used to populate an InputScope.

Input scope is intended for alphanumeric full-width characters.

Input scope is intended for alphanumeric half-width characters.

Expected input is an alphanumeric PIN.

Input scope is intended for chat strings.

Expected input does not include emoji. Advises input processors to not show the emoji key.

Input scope is intended for Chinese full-width characters.

Input scope is intended for Chinese half-width characters.

Input scope is intended for working with a currency amount (no currency symbol).

Input scope is intended for working with amount and symbol of currency.

Input scope is intended for working with a numeric day of the month.

Input scope is intended for working with a numeric month of the year.

Input scope is intended for working with a numeric year.

No input scope is applied.

Input scope is intended for working with a collection of numbers.

Input scope is intended for working with an email, name, or address.

Input scope is intended for working with a Simple Mail Transport Protocol (SMTP) form e-mail address (accountnamehost).

Input scope is intended for spreadsheet formula strings.

Expected input is a mathematical formula. Advises input processors to show the number page.

Input scope is intended for Hangul full-width characters.

Input scope is intended for Hangul half-width characters.

Input scope is intended for Hanja characters.

Input scope is intended for Hiragana characters.

Input scope is intended for Katakana full-width characters.

Input scope is intended for Katakana half-width characters.

Input scope is intended for working with a map location.

Input scope is intended for working with a name or telephone number.

Input scope is intended for native script.

Input scope is intended for working with digits 0-9.

Input scope is intended for full-width number characters.

Expected input is a numeric password, or PIN.

Expected input is a numeric PIN.

Input scope is intended for working with an alphanumeric password, including other symbols, such as punctuation and mathematical symbols.

Input scope is intended for working with a complete personal name.

Input scope is intended for search strings.

Input scope is intended for search boxes where incremental results are displayed as the user types.

Input scope is intended for working with a numeric telephone area code.

Input scope is intended for working with a numeric telephone country code.

Input scope is intended for working with a local telephone number.

Input scope is intended for working with telephone numbers.

Input scope is intended for working with text.

Input scope is intended for working with a numeric hour of the day.

Input scope is intended for working with a numeric minute of the hour, or second of the minute.

Indicates a Uniform Resource Identifier (URI). This can include URL, File, or File Transfer Protocol (FTP) formats.

Represents a keyboard shortcut (or accelerator) that lets a user perform an action using the keyboard instead of navigating the app UI (directly or through access keys).

Initializes a new instance of the KeyboardAccelerator class.

Gets or sets whether a keyboard shortcut (accelerator) is available to the user.

**true** if the shortcut is available; otherwise, **false**.

Identifies the IsEnabled dependency property.

The identifier for the IsEnabled dependency property.

Gets or sets the virtual key (used in conjunction with one or more modifier keys) for a keyboard shortcut (accelerator).

The virtual key.

Identifies the Key dependency property.

The identifier for the Key dependency property.

Gets or sets the virtual key used to modify another keypress for a keyboard shortcut (accelerator).

The virtual key.

Identifies the Modifiers dependency property.

The identifier for the Modifiers dependency property.

Gets or sets the scope (or target) of the keyboard accelerator.

The default is null (global scope).

Identifies the ScopeOwner dependency property.

The identifier for the ScopeOwner dependency property.

Occurs when the key combination for this KeyboardAccelerator is pressed.

Provides event data for the Invoked event.

Gets the object associated with the keyboard shortcut (or accelerator).

A reference to the object associated with the keyboard shortcut (or accelerator).

Gets or sets a value that marks the event as handled.

**true** to mark the event handled; **false** to leave the event unhandled, which permits the event to potentially route further. The default is **false**.

Gets the keyboard shortcut (or accelerator) object associated with the Invoked event.

Defines constants that specify whether a keyboard shortcut (accelerator) is displayed.

The keyboard accelerator is displayed. Default.

The keyboard accelerator is not shown.

Specifies the tabbing behavior across tab stops for a tabbing sequence within a container.

Focus returns to the first or the last keyboard navigation stop inside of a container when the first or last keyboard navigation stop is reached.

Tab indexes are considered on the local subtree only inside this container.

The container and all of its child elements as a whole receive focus only once.

Represents the method that handles the KeyUp and KeyDown  events.

The object where the event handler is attached. The event data.

Provides event data for the KeyUp and KeyDown routed events.

Gets a unique ID for the input device that generated this key event.

A unique identifier for the input device associated with the key event, or an empty string for an unsupported device. The same device can be assigned a different ID each time it is connected.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled; **false** to leave the routed event unhandled, which permits the event to potentially route further. The default is **false**.

Gets the virtual key associated with the event.

A system value that indicates the code for the key referenced by the event.

Gets a structure value that reports various system-detected characteristics of the key press, including repeat count and menu status.

A structure value with flags that report status.

Gets the original, unmapped virtual key associated with the event.

A system value that indicates the code for the key referenced by the event.

Defines constants that specify where a Key Tip is placed in relation to a UIElement.

The placement of the Key Tip is determined by the system.

The Key Tip is placed below the element.

The Key Tip is centered on the element.

The Key Tip is not shown.

The Key Tip is placed left of the element.

The Key Tip is placed right of the element.

The Key Tip is placed above the element.

Provides data for the FocusManager.LosingFocus and UIElement.LosingFocus events.

Gets or sets whether focus navigation should be canceled.

**true** if focus navigation should be canceled. Otherwise, **false**.

Gets the unique ID generated when a focus movement event is initiated.

The unique ID, if any. Otherwise, **null**.

Gets the direction that focus moved from element to element within the app UI.

The direction of focus movement.

Gets the input mode through which an element obtained focus.

How the element obtained focus.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the input device type from which input events are received.

The input device type.

Gets the most recent focused object.

The most recent focused object.

Gets the last focused object.

The last focused object.

Attempts to cancel the ongoing focus action.

True, if the focus action is canceled; otherwise, false.

Attempts to redirect focus from the targeted element to the specified element.

The object on which to set focus. True, if the focus action is redirected; otherwise, false.

Represents the method that will handle ManipulationCompleted and related events.

The object where the handler is attached. Event data for the event.

Provides data for the ManipulationCompleted event.

Initializes a new instance of the ManipulationCompletedRoutedEventArgs class.

Gets the UIElement that is considered the container of the manipulation.

The UIElement that is considered the container of the manipulation.

Gets the overall changes since the beginning of the manipulation.

The overall changes since the beginning of the manipulation.

Gets or sets a value that marks the routed event as handled. Setting to **true** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled; **false** to leave the routed event unhandled, which permits the event to potentially route further. The default is **false**.

Gets whether the ManipulationCompleted event occurs during inertia.

**true** if the ManipulationCompleted event occurs during inertia; **false** if the event occurs while the user's input device has contact with the element.

Gets the PointerDeviceType for the pointer device involved in the manipulation.

A value of the enumeration.

Gets the x- and y- screen coordinates of the touch input at completed position.

The x- and y- screen coordinates of the touch input at completed position.

Gets the velocities that are used for the manipulation.

The velocities that are used for the manipulation.

Represents the method that will handle ManipulationDelta and related events.

The object where the handler is attached. Event data for the event.

Provides data for the ManipulationDelta event.

Initializes a new instance of the ManipulationDeltaRoutedEventArgs class.

Gets the UIElement that is considered the container of the manipulation.

The UIElement that is considered the container of the manipulation.

Gets the overall changes since the beginning of the manipulation.

The overall changes since the beginning of the manipulation.

Gets the most recent changes of the current manipulation, as a ManipulationDelta.

The most recent changes of the current manipulation.

Gets or sets a value that marks the routed event as handled. Setting to **true** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled; **false** to leave the routed event unhandled, which permits the event to potentially route further. The default is **false**.

Gets whether the ManipulationDelta event occurs during inertia.

**true** if the ManipulationDelta event occurs during inertia; **false** if the event occurs while the user's input device has contact with the element.

Gets the PointerDeviceType for the pointer device involved in the manipulation.

A value of the enumeration.

Gets the point from which the manipulation originated.

The point from which the manipulation originated.

Gets the rates of the most recent changes to the manipulation.

The rates of the most recent changes to the manipulation.

Completes the manipulation without inertia.

Represents the method that will handle the ManipulationInertiaStarting event.

The object where the handler is attached. Event data for the event.

Provides data for the ManipulationInertiaStarting event.

Initializes a new instance of the ManipulationInertiaStartingRoutedEventArgs class.

Gets the UIElement that is considered the container of the manipulation.

The UIElement that is considered the container of the manipulation.

Gets the overall changes since the beginning of the manipulation.

The overall changes since the beginning of the manipulation.

Gets the most recent changes of the current manipulation, as a ManipulationDelta.

The most recent changes of the current manipulation.

Get or sets the rate of slowdown of expansion inertial movement.

The rate of slowdown of expansion inertial movement

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the PointerDeviceType for the pointer device involved in the manipulation.

A value of the enumeration.

Gets information about the rotation information associated with the manipulation for this event occurrence.

Manipulation rotation information.

Gets information about the translation information associated with the manipulation for this event occurrence.

Manipulation translation information.

Gets the rates of the most recent changes to the manipulation.

The rates of the most recent changes to the manipulation.

Specifies how a target UI element interprets manipulation events. This enumeration is flagwise, so you can set multiple modes for the ManipulationMode property.

Enable all manipulation interaction modes except those supported through Direct Manipulation

Do not present graphic interaction with manipulation events.

Permit manipulation actions that rotate the target.

Apply inertia to rotate actions.

Permit manipulation actions that scale the target.

Apply inertia to scale actions.

Enable system-driven touch interactions supported through Direct Manipulation.

Apply inertia to translate actions.

Permit manipulation actions that translate the target on the X axis but using a rails mode.

Permit manipulation actions that translate the target on the Y axis but using a rails mode.

Permit manipulation actions that translate the target on the X axis.

Permit manipulation actions that translate the target on the Y axis.

Specifies how a rotation occurs with one point of user input.

Initializes a new instance of the ManipulationPivot class with no initial values.

Initializes a new instance of the ManipulationPivot class with the specified center and radius values.

The center point of the pivot. The pivot radius.

Gets or sets the center point for rotation manipulations.

The center point for rotation manipulations.

Gets or sets the effective radius of rotation for rotation manipulations.

A value in pixels.

Represents the method that will handle ManipulationStarted and related events.

The object where the handler is attached. Event data for the event.

Provides data for the ManipulationStarted event.

Initializes a new instance of the ManipulationStartedRoutedEventArgs class.

Gets the UIElement that is considered the container of the manipulation.

The UIElement that is considered the container of the manipulation.

Gets the overall changes since the beginning of the manipulation.

The overall changes since the beginning of the manipulation.

Gets or sets a value that marks the routed event as handled. Setting to **true** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled; **false** to leave the routed event unhandled, which permits the event to potentially route further. The default is **false**.

Gets the PointerDeviceType for the pointer device involved in the manipulation.

A value of the enumeration.

Gets the point from which the manipulation originated.

The point from which the manipulation originated.

Completes the manipulation without inertia.

Represents the method that will handle the ManipulationStarting event.

The object where the event handler is attached. Event data for the event.

Provides data for the ManipulationStarting, event.

Initializes a new instance of the ManipulationStartingRoutedEventArgs class.

Gets the UIElement that is considered the container of the manipulation.

The UIElement that is considered the container of the manipulation.

Gets or sets a value that marks the routed event as handled. Setting to **true** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled; **false** to leave the routed event unhandled, which permits the event to potentially route further. The default is **false**.

Gets or sets which types of manipulations are possible.

One of the enumeration values. The default is **All**.

Gets or sets an object that describes the pivot for a single-point manipulation.

An object that describes the pivot for a single-point manipulation.

Provides data for the NoFocusCandidateFound event.

Gets the direction that focus moved from element to element within the app UI.

The direction of focus movement.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the input device type from which input events are received.

The input device type.

Provides basic properties for the input pointer associated with a single mouse, pen/stylus, or touch contact.

Gets a value that determines whether the pointer device was in contact with a sensor or digitizer at the time that the event was reported.

**true** if the pointer device was in contact; otherwise, **false**.

Gets a value that indicates whether the pointer device is within detection range of a sensor or digitizer.

**true** if touch or pen is within detection range or mouse is over; otherwise **false**

Gets the PointerDeviceType for the pointer device.

The PointerDeviceType for this pointer reference.

Gets the system-generated identifier for this pointer reference.

The system-generated identifier.

Represents the method that will handle pointer message events such as PointerPressed.

The object where the event handler is attached. Event data for the event.

Contains the arguments returned by the last pointer event message.

Gets or sets a value that marks the routed event as handled, and prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets a value that indicates whether the pointer event occurred from direct interaction with an object by the user, or was generated by the platform based on changes to the UI of the application.

True if the event was generated by the platform; otherwise, false.

Gets a value that indicates which key modifiers were active at the time that the pointer event was initiated.

A value or values of the enumeration.

Gets a reference to a pointer token.

A pointer token.

Retrieves a PointerPoint object that provides basic info on the pointer associated with the event.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A PointerPoint value that represents the pointer point associated with this event. If **null** was passed as *relativeTo*, the coordinates are in the frame of reference of the overall window. If a *relativeTo* value other than **null** was passed, the coordinates are relative to the object referenced by *relativeTo*.

Retrieves a collection of PointerPoint objects that represent the pointer history from the last pointer event up to and including the current pointer event. Each PointerPoint in the collection provides basic info on the pointer associated with the event.The last item in the collection is equivalent to the PointerPoint object returned by GetCurrentPoint.

Provides the context for the pointer data. Can be any UIElement -derived object that is connected to the same object tree. If **null**, location coordinates are in the context of the app. The collection of PointerPoint objects corresponding to the pointer history associated with the event. If *relativeTo* is **null**, location coordinates are in the context of the app. Otherwise, the coordinates are relative to the object referenced by *relativeTo*.

Provides event data for the ProcessKeyboardAccelerators event.

Gets or sets a value that marks the event as handled.

**true** to mark the event handled. **false** to leave the event unhandled. The default is **false**.

Gets the virtual key (used in conjunction with one or more modifier keys) for a keyboard shortcut (accelerator).

The virtual key.

Gets the virtual key used to modify another keypress for a keyboard shortcut (accelerator).

The virtual key.

Represents the method that will handle a RightTapped routed event.

The object where the handler is attached. Event data for the event.

Provides event data for the RightTapped event.

Initializes a new instance of the RightTappedRoutedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the PointerDeviceType for the pointer device that initiated the associated input event.

The PointerDeviceType for this event occurrence.

Returns the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A Point that represents the current x- and y-coordinates of the mouse pointer position. If **null** was passed as *relativeTo*, this coordinate is for the overall window. If a *relativeTo* value other than **null** was passed, this coordinate is relative to the object referenced by *relativeTo*.

Derives from XamlUICommand, adding a set of standard platform commands with pre-defined properties.

Initializes a new instance of the StandardUICommand class.

Initializes a new instance of the StandardUICommand class of the specified kind.

The pre-defined command (including behavior, and various UI-related properties, methods, and events).

Gets the platform command (with pre-defined properties such as icon, keyboard accelerator, and description) that can be used with a StandardUICommand.

The pre-defined command.

Identifies the Kind dependency property.

The identifier for the Kind dependency property.

Specifies the set of platform commands (with pre-defined properties such as icon, keyboard accelerator, and description) that can be used with a StandardUICommand.

Specifies the backward command.

Specifies the close command.

Specifies the copy command.

Specifies the cut command.

Specifies the delete command.

Specifies the forward command.

No command. Default.

Specifies the open command.

Specifies the paste command.

Specifies the pause command.

Specifies the play command.

Specifies the redo command.

Specifies the save command.

Specifies the select all command.

Specifies the share command.

Specifies the stop command.

Specifies the undo command.

Represents the method that will handle the Tapped event.

The object where the event handler is attached. Event data for the event.

Provides event data for the Tapped event.

Initializes a new instance of the TappedRoutedEventArgs class.

Gets or sets a value that marks the routed event as handled. A **true** value for **Handled** prevents most handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the PointerDeviceType for the pointer device that initiated the associated input event.

The PointerDeviceType for this event occurrence.

Returns the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement.

Any UIElement -derived object that is connected to the same object tree. To specify the object relative to the overall coordinate system, use a *relativeTo*  value of **null**. A Point that represents the current x- and y-coordinates of the mouse pointer position. If **null** was passed as *relativeTo*, this coordinate is for the overall window. If a value other than **null** for *relativeTo* was passed, this coordinate is relative to the object referenced by *relativeTo*.

Provides a base class for defining the command behavior of an interactive UI element that performs an action when invoked (such as sending an email, deleting an item, or submitting a form).

Initializes a new instance of the XamlUICommand class.

Gets or sets the access key (mnemonic) for this element.

The access key (mnemonic) for this element.

Identifies the AccessKey dependency property.

The identifier for the AccessKey dependency property.

Gets or sets the command behavior of an interactive UI element that performs an action when invoked, such as sending an email, deleting an item, or submitting a form.

The command behavior of the element.

Identifies the Command dependency property.

The identifier for the Command dependency property.

Gets or sets a description for this element.

The description for this element.

Identifies the Description dependency property.

The identifier for the Description dependency property.

Gets or sets a glyph from the Segoe MDL2 Assets font for this element.

A glyph from the Segoe MDL2 Assets font for this element.

Identifies the IconSource dependency property.

The identifier for the IconSource dependency property.

Gets or sets the collection of key combinations for this element that invoke an action using the keyboard.

The keyboard accelerators for this element.

Identifies the KeyboardAccelerators dependency property.

The identifier for the KeyboardAccelerators dependency property.

Gets or sets the label for this element.

The label for this element.

Identifies the Label dependency property.

The identifier for the Label dependency property.

Occurs whenever something happens that affects whether the command can execute.

Occurs when a CanExecute call is made.

Occurs when an Execute call is made.

Retrieves whether the command can execute in its current state.

Data used by the command. If the command does not require data, this object can be set to null. **true** if this command can be executed; otherwise, **false**.

Invokes the command.

Data used by the command. If the command does not require data, this object can be set to null.

Notifies the system that the command state has changed.

Specifies the 2D directional navigation behavior when using the keyboard arrow keys.

Behavior is inherited from the elements ancestors. If all ancestors have a value of **Auto**, the fallback behavior is **Disabled**.

Arrow keys cannot be used for 2D directional navigation.

Arrow keys can be used for 2D directional navigation.

Specifies the disambiguation strategy used for navigating between multiple candidate targets using XYFocusDownNavigationStrategy, XYFocusLeftNavigationStrategy, XYFocusRightNavigationStrategy, and XYFocusUpNavigationStrategy.

Indicates that navigation strategy is inherited from the element's ancestors. If all ancestors have a value of **Auto**, the fallback strategy is **Projection**.

Indicates that focus moves to the element closest to the axis of the navigation direction.

Indicates that focus moves to the first element encountered when projecting the edge of the currently focused element in the direction of navigation.

Indicates that focus moves to the closest element based on the shortest 2D distance (Manhattan metric).

Specifies how the XAML framework determines the target of an XY navigation.

Indicates that navigation strategy is inherited from the element's ancestors. If all ancestors have a value of **Auto**, the fallback strategy is **Projection**.

Indicates that focus moves to the element closest to the axis of the navigation direction.

No navigation override is applied.

Indicates that focus moves to the first element encountered when projecting the edge of the currently focused element in the direction of navigation.

Indicates that focus moves to the closest element based on the shortest 2D distance (Manhattan metric).

Represents the method that will handle the VectorChanged event.

The object where the handler is attached. Event data, loosely typed.

Extends IIterable to enable data-binding infrastructure requirements.

Returns a bindable iterator that iterates over the items in the collection.

The bindable iterator.

Supports bindable iteration over a collection.

Gets the current item in the collection.

The current item in the collection.

Gets a value that indicates whether there is a current item or the iterator is at the end of the collection.

**true** if the iterator refers to a valid item that is in the collection; otherwise, **false**.

Moves the iterator forward to the next item and returns HasCurrent.

**true** if the iterator refers to a valid item that is in the collection; otherwise, **false**.

Extends IBindableVector by adding a VectorChanged event for change notification.

Occurs when the vector collection changes (add, delete, item change).

Represents a writeable vector collection of objects that is bindable.

Gets the number of items in the vector.

The number of items in the vector.

Appends an item to the end of the vector.

The item to append to the vector.

Removes all items from the vector.

Returns the item at the specified index in the vector.

The zero-based index of the item in the vector to return. The item at the specified index.

Returns an immutable view of the vector.

The view of the vector.

Returns the index of a specified item in the vector.

The item to find in the vector. The zero-based index of the item if found. 0 is returned if the item is not found, so be sure to check the return value. **true** if the item is found; **false** if the item is not found.

Inserts an item into a vector at a specified index.

The index at which to insert. The item to insert.

Removes the item at the specified index in the vector.

The zero-based index of the vector, at which to remove the item.

Removes the last item in the vector.

Sets the item value at the specified index of the vector.

The zero-based index of the vector, at which to set the value. The item value to set.

Represents a read-only vector collection of objects that is bindable.

Gets the number of items in the vector.

The number of items in the vector.

Returns the item at the specified index in the vector.

The zero-based index of the item in the vector to return. The item at the specified index.

Returns the index of a specified item in the vector.

The item to find in the vector. The zero-based index of the item if found. 0 is returned if the item is not found, so be sure to check the return value. **true** if the item is found; **false** if the item is not found.

Provides a collection-changed pattern interface for C++ bindable classes.

Occurs when the collection changes.

Describes the action that caused a CollectionChanged event.

One or more items were added to the collection.

One or more items were moved within the collection.

One or more items were removed from the collection.

One or more items were replaced in the collection.

The content of the collection changed dramatically.

Provides the event data for a CollectionChanged event.

Initializes a new instance of the NotifyCollectionChangedEventArgs class.

The Action value to report. The NewItems value to report. The OldItems value to report. The NewStartingIndex value to report. The OldStartingIndex value to report.

Gets the description of the action that caused the event.

The description of the action that caused the event, as a value of the enumeration.

Gets the items affected by an action.

The bindable vector of items affected by an action.

Gets the index at which the change occurred.

The index at which the change occurred.

Gets the item affected by a **Replace** or **Remove** action.

The bindable vector of items affected by a **Replace** or **Remove** action.

Gets the starting index at which a **Move**, **Remove**, or **Replace** action occurred.

The zero-based index at which a **Move**, **Remove**, or **Replace** action occurred.

Represents the method that will handle the CollectionChanged event.

The object where the handler is attached. Event data for the event.

Provides basic guidance about the origin of a type. Used as a value by TypeName.

The type is a custom type declared by means other than WinMD.

The type is declared through WinMD (Windows Runtime metadata).

The type is a language-level primitive.

Substitutes for **System.Type** such that type information reported by other APIs doesn't have a dependency on the common language runtime (CLR). This structure is used as a value by properties such as UnderlyingType and Type.

A TypeKind value containing basic guidance regarding the origin of the type.

The name of the type. Depending on the value of *Kind* (see below), *Name* can contain any of the following.

Indicates which property of a type is the XAML content property. A XAML processor uses this information when processing XAML child elements of XAML representations of the attributed type.

Initializes a new instance of the ContentPropertyAttribute class.

Indicates that the XAML metadata in a component library is complete.

Initializes a new instance of the FullXamlMetadataProviderAttribute class.

Provides infrastructure support for event wiring and build actions.

Attaches events and names to XAML-initiated content.

An identifier token to distinguish calls. The target to connect events and names to.

Provides infrastructure support for event wiring and build actions.

Returns the IComponentConnector for this connection.

An identifier token to distinguish calls. The target to connect events and names to. The IComponentConnector for this connection.

Provides methods that enable the XAML parser to communicate with generated binding code.

Updates the compiled data bindings.

The data item. The index of the data item. The number of times ProcessBindings has been called. The phase on the next call to ProcessBindings.

Disassociates item containers from their data items and saves the containers so they can be reused later for other data items.

Provides methods that enable a debugger to disable generated binding code.

Disables a binding while running in a debugger.

The line number of the x:Bind in the XAML source file. The column number of the x:Bind in the XAML source file.

Provides the means to report XAML-type system specifics about XAML members. Using this interface contract, XAML parsers can load any custom types and members thereof that are defined in your app and are referenced in XAML files.

Gets a value that indicates whether the XAML member is an attachable member.

**true** if the XAML member is an attachable member; otherwise, **false**.

Gets a value that indicates whether the XAML member is implemented as a dependency property.

**true** if the XAML member is implemented as a dependency property; otherwise, **false**.

Gets whether the XAML member is read-only in its backing implementation.

**true** if the backing member is read-only; otherwise, **false**.

Gets the XamlName name string that declares the XAML member.

The XamlName name string that declares the XAML member.

Gets the IXamlType of the type where the member can exist.

The IXamlType of the type where the member can exist.

Gets the IXamlType of the type that is used by the member.

The IXamlType of the type that is used by the member.

Provides a get-value utility for this IXamlMember.

The object instance to get the member value from. The member value.

Provides a set-value utility for this IXamlMember.

The object instance to set the member value on. The member value to set.

Implements XAML schema context concepts that support XAML parsing.

Implements XAML schema context access to underlying type mapping, based on specifying a full type name.

The name of the class for which to return a XAML type mapping. The schema context's implementation of the IXamlType concept.

Implements XAML schema context access to underlying type mapping, based on providing a helper value that describes a type.

The type as represented by the relevant type system or interoperation support type. The schema context's implementation of the IXamlType concept.

Gets the set of XMLNS (XAML namespace) definitions that apply to the context.

The set of XMLNS (XAML namespace) definitions.

Provides the means to report XAML-type system specifics about XAML types. Using this interface contract, XAML parsers can load any custom types and members thereof that are defined in your app and are referenced in XAML files.

Gets the IXamlType for the immediate base type of the XAML type. Determination of this value is based on the underlying type for core types.

The IXamlType for the immediate base type of the XAML type.

Gets the IXamlMember information for the XAML content property of this IXamlType.

IXamlMember information for the XAML content property of the IXamlType. May be null if no XAML content property exists.

Gets the full class name of the underlying type.

The full class name of the underlying type.

Gets a value that indicates whether the IXamlType represents an array.

**true** if the IXamlType represents an array; otherwise, **false**.

Gets a value that declares whether the type is bindable.

**true** if the type is bindable, **false** if the type is not bindable.

Gets a value that indicates whether this IXamlType represents a collection.

**true** if this IXamlType represents a collection; otherwise, **false**.

Gets a value that indicates whether this IXamlType represents a constructible type, as per the XAML definition.

**true** if this IXamlType represents a constructible type; otherwise, **false**.

Gets a value that indicates whether this IXamlType represents a dictionary/map.

**true** if this IXamlType represents a dictionary/map; otherwise, **false**.

Gets a value that indicates whether the IXamlType represents a markup extension.

**true** if the IXamlType represents a markup extension; otherwise, **false**.

Gets a value that provides the type information for the **Items** property of this IXamlType.

The IXamlType information for the type of the items in the collection; otherwise, null if this IXamlType does not represent a collection.

Gets a value that provides the type information for the **Key** property of this IXamlType, if this IXamlType represents a dictionary/map.

The IXamlType information for the type of the key for dictionary usage; otherwise, null if this IXamlType does not represent a dictionary/map.

Gets information for the backing type.

The backing type as represented by the relevant type system or interop support type. This is a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

Given a XAML type, sets its values for initialization and returns a usable instance.

The usable instance.

Adds an item to a custom map type.

The type instance to set the map item to. The key of the map item to add. The value of the map item to add.

Adds an item to a custom vector type.

The type instance to set the item to. The value of the item to add.

Creates a type system representation based on a string. The main scenario for this usage is creating an enumeration value and mapping the appropriate enumeration.

The string to create from. The resulting type system representation.

Returns the IXamlMember information for a specific named member from this IXamlType.

The name of the member to get (as a string). The IXamlMember information for the member, if a member as specified by *name* was found; otherwise, null.

Invokes any necessary pre-activation logic as required by the XAML schema context and its platform dependencies.

Provides the means to report XAML-type system specifics about XAML types. Using this interface contract, XAML parsers can load any custom types and members thereof that are defined in your app and are referenced in XAML files.

Gets the IXamlType for the boxed type of the XAML type. Determination of this value is based on the underlying type for core types.

The IXamlType for the boxed type of the XAML type.

Provides a base class for XAML markup extension implementations.

Initializes a new instance of the MarkupExtension class.

When implemented in a derived class, returns an object that is provided as the value of the target property for this markup extension.

The object value to set on the property where the extension is applied.

Reports the type that a markup extension can return.

Initializes a new instance of the MarkupExtensionReturnTypeAttribute class.

Produces a pre-parsed binary representation of a XAML production.

Produces a binary representation of XAML. Input streams are produced in text representation, and output streams are populated with XAML in binary (XBF) representation.

The set of input streams. These are expected to access the text representation of the XAML to write into XBF format. The set of output streams. When the method returns each output stream provides access to the XBF binary representation. You'd typically use this stream to create a file. A helper object that maps types for XAML productions. A structure that captures any error information that is reported by the conversion into XBF format.

Records error information produced by calls to XamlBinaryWriter.Write.

The index of the stream in the original *inputStreams* parameter for XamlBinaryWriter.Write where the error occurred.

The line number in the input XAML text representation where the error was encountered.

The line position in the input XAML text representation where the error was encountered.

Provides helper methods for data binding.

Identifies the DataTemplateComponent attached property.

The identifier for the DataTemplateComponent attached property.

Converts a value from a source type to a target type.

The type to convert the value from. The value to convert. The converted value.

Gets the value of the DataTemplateComponent XAML attached property for a target element.

The object from which the property value is read. The DataTemplateComponent XAML attached property value of the specified object.

Resumes rendering of the specified element.

The element for which to resume rendering.

Sets the value of the DataTemplateComponent XAML attached property for a target element.

The object to which the property value is written. The value to set.

Sets a DependencyProperty from a Boolean value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Byte value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Char value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a DateTime value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Double value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Int32 value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Int64 value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Object value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Point value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Rect value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Single value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Size value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a String value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a TimeSpan value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a UInt32 value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a UInt64 value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Sets a DependencyProperty from a Uri value.

The object to which the property being set belongs. The property to which the value is written. The value to set.

Suspends rendering of the specified element.

The element for which to suspend rendering.

Provides helper methods for the XAML compiler.

Unloads an element from the XAML visual tree.

The element to unload.

Provides a XAML processor engine for parsing XAML and creating corresponding object trees.

Parses a well-formed XAML fragment and creates a corresponding object tree, and returns the root of the object tree.

A string that contains a valid XAML fragment. The root object of the created object tree.

Parses a well-formed XAML fragment creates a corresponding object tree, and returns the root of the object tree. Also performs load-time validation of any linked templates.

A string that contains a valid XAML fragment. The root object of the created object tree.

Specifies a mapping on a per-assembly basis between a XAML namespace and a library-code namespace for backing types, which is then used for type resolution by a XAML object writer or XAML schema context.

The library-code namespace, specified as a string.

The XAML namespace identifier specified in the attribute.

Defines values that specify whether the brush samples from the app content or from the content behind the app window.

The brush samples from the app content.

The brush samples from the content behind the app window.

Paints an area with a semi-transparent material that uses multiple effects including blur and a noise texture.

Initializes a new instance of the AcrylicBrush class.

Gets or sets a value that specifies whether the brush is forced to the solid fallback color.

**true** to always replace the acrylic material with the solid fallback color. Otherwise, **false**. The default is **false**.

Identifies the AlwaysUseFallback dependency property.

The identifier for the AlwaysUseFallback dependency property.

Gets or sets a value that specifies whether the brush samples from the app content or from the content behind the app window.

A value of the enumeration that specifies whether the brush samples from the app content or from the content behind the app window.

Identifies the BackgroundSource dependency property.

The identifier for the BackgroundSource dependency property.

Gets or sets the color tint for the semi-transparent acrylic material.

The color tint for the semi-transparent acrylic material.

Identifies the TintColor dependency property.

The identifier for the TintColor dependency property.

Gets or sets the brightness amount between the TintColor and the underlying pixels behind the Acrylic surface.

The amount of luminosity that is visible through the surface where Acrylic is applied.

Identifies the TintLuminosityOpacity dependency property.

The identifier for the TintLuminosityOpacity dependency property.

Gets or sets the degree of opacity of the color tint.

The opacity expressed as a value between 0 and 1.0. The default value is 1.0, which is full opacity. 0 is transparent opacity.

Identifies the TintOpacity dependency property.

The identifier for the TintOpacity dependency property.

Gets or sets the length of the automatic transition animation used when the TintColor changes.

The length of the automatic transition animation used when the TintColor changes.

Identifies the TintTransitionDuration dependency property.

The identifier for the TintTransitionDuration dependency property.

Describes how content is positioned horizontally in a container.

The contents align toward the center of the container.

The contents align toward the left of the container.

The contents align toward the right of the container.

Describes how content is positioned vertically in a container.

The contents align toward the lower edge of the container.

The contents align toward the center of the container.

The contents align toward the upper edge of the container.

Represents an elliptical arc between two points.

Initializes a new instance of the ArcSegment class.

Gets or sets a value that indicates whether the arc should be greater than 180 degrees.

**true** if the arc should be greater than 180 degrees; otherwise, **false**.

Identifies the IsLargeArc dependency property.

The IsLargeArc dependency property identifier.

Gets or sets the endpoint of the elliptical arc.

The point to which the arc is drawn. The default is a Point with value 0,0.

Identifies the Point dependency property.

The Point dependency property identifier.

Gets or sets the amount (in degrees) by which the ellipse is rotated about the x-axis.

The amount (in degrees) by which the ellipse is rotated about the x-axis. The default is 0.

Identifies the RotationAngle dependency property.

The RotationAngle dependency property identifier.

Gets or sets the x-radius and y-radius of the arc as a Size structure.

A Size structure that describes the x-radius and y-radius of the elliptical arc. The Size structure's **Width** value specifies the arc's x-radius; its **Height** value specifies the arc's y-radius. The default is a Size with value 0,0.

Identifies the Size dependency property.

The Size dependency property identifier.

Gets or sets a value that specifies whether the arc is drawn in the **Clockwise** or **Counterclockwise** direction.

One of the enumeration values that specifies the direction in which the arc is drawn. The default is **Counterclockwise**.

Identifies the SweepDirection dependency property.

The SweepDirection dependency property identifier.

Describes the purpose of the audio information in an audio stream. Used as a value by AudioCategory.

Audio is for system or application notifications, for example ring tones.

Audio is for general media, for example audio for video, or streaming audio, and can be played as background. This enumeration value is deprecated. For more information, see **Remarks**.

BackgroundCapableMedia is deprecated and might not work on all platforms. For more info, see MSDN.

Audio is for peer-to-peer communications, for example chat or VoIP.

Audio is for general media, for example audio for video, or streaming audio, but should not be played as background. This enumeration value is deprecated. For more information, see **Remarks**.

ForegroundOnlyMedia is deprecated and might not work on all platforms. For more info, see MSDN.

Game chat audio. Similar to **Communications** except that **GameChat** will not attenuate other streams.

Audio is for game-specific sound effects.

Audio is background (non-event or ambient) audio for games.

Stream that includes audio without dialog.

Stream that includes audio with dialog.

All other streams.

Audio is for sound effects.

Audio is speech.

Describes the primary usage of the device that is being used to play back audio. This value is used by AudioDeviceType.

The device is primarily for voice communications.

The device is a console and the audio session might support games, notifications, voice commands, and so on.

The device is intended for multimedia playback and/or recording.

Represents a cubic Bezier curve drawn between two points.

Initializes a new instance of the BezierSegment class.

Gets or sets the first control point of the curve.

The first control point of the curve. The default is a Point with value 0,0.

Identifies the Point1 dependency property.

The identifier for the Point1 dependency property.

Gets or sets the second control point of the curve.

The second control point of the curve.

Identifies the Point2 dependency property.

The identifier for the Point2 dependency property.

Gets or sets the end point of the curve.

The end point of the curve.

Identifies the Point3 dependency property.

The identifier for the Point3 dependency property.

Represents the behavior of caching a visual element or tree of elements as bitmap surfaces.

Initializes a new instance of the BitmapCache class.

Defines objects used to paint graphical objects. Classes that derive from Brush describe how the area is painted.

Provides base class initialization behavior for Brush -derived classes.

Gets or sets the degree of opacity of a Brush.

The value of the Opacity property is expressed as a value between 0 and 1.0. The default value is 1.0, which is full opacity. 0 is transparent opacity.

Identifies the Opacity dependency property.

The Opacity dependency property identifier.

Gets or sets the transformation that is applied to the brush using relative coordinates.

The transformation that is applied to the brush using relative coordinates. The default value is null.

Identifies the RelativeTransform dependency property.

The RelativeTransform dependency property identifier.

Gets or sets the transformation that is applied to the brush.

The transformation to apply to the brush.

Identifies the Transform dependency property.

The Transform dependency property identifier.

Defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

When overridden in a derived class, defines a property that can be animated.

The property that can be animated. Information about the property to be animated.

Represents an ordered collection of Brush values.

Initializes a new instance of the BrushCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Brush at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Brush value specified.

The index at which to set the value. The value to set.

Specifies the coordinate system used by a Brush.

The coordinate system is not relative to a bounding box. Values are interpreted directly in local space.

The coordinate system is relative to a bounding box: 0 indicates 0 percent of the bounding box, and 1 indicates 100 percent of the bounding box. For example, (0.5, 0.5) describes a point in the middle of the bounding box, and (1, 1) describes a point at the lower right of the bounding box.

Represents cached content modes for graphics acceleration features.

Provides base class initialization behavior for CacheMode derived classes.

Determines how the colors in a gradient are interpolated.

Colors are interpolated in the scRGB color space.

Colors are interpolated in the sRGB color space.

Applies multiple transform operations to an object.

Initializes a new instance of the CompositeTransform class.

Gets or sets the x-coordinate of the center point for all transforms specified by the CompositeTransform in device-independent pixel (DIP) relative to the upper left-hand corner of the element.

The x-coordinate of the center point for all transforms specified by the CompositeTransform.

Identifies the CenterX dependency property.

The identifier for the CenterX dependency property.

Gets or sets the y-coordinate of the center point for all transforms specified by the CompositeTransform in device-independent pixel (DIP) relative to the upper left-hand corner of the element.

The y-coordinate of the center point for all transforms specified by the CompositeTransform.

Identifies the CenterY dependency property.

The identifier for the CenterY dependency property.

Gets or sets the angle, in degrees, of clockwise rotation.

The angle, in degrees, of clockwise rotation. The default is 0.

Identifies the Rotation dependency property.

The identifier for the Rotation dependency property.

Gets or sets the x-axis scale factor. You can use this property to stretch or shrink an object horizontally.

The scale factor along the x-axis. The default is 1.

Identifies the ScaleX dependency property.

The identifier for the ScaleX dependency property.

Gets or sets the y-axis scale factor. You can use this property to stretch or shrink an object vertically.

The scale factor along the y-axis. The default is 1.

Identifies the ScaleY dependency property.

The identifier for the ScaleY dependency property.

Gets or sets the x-axis skew angle, which is measured in degrees counterclockwise from the y-axis. A skew transform can be useful for creating the illusion of three-dimensional depth in a two-dimensional object.

The skew angle, which is measured in degrees counterclockwise from the y-axis. The default is 0.

Identifies the SkewX dependency property.

The identifier for the SkewX dependency property.

Gets or sets the y-axis skew angle, which is measured in degrees counterclockwise from the x-axis. A skew transform can be useful for creating the illusion of three-dimensional depth in a two-dimensional object.

The skew angle, which is measured in degrees counterclockwise from the x-axis. The default is 0.

Identifies the SkewY dependency property.

The identifier for the SkewY dependency property.

Gets or sets the distance to translate along the x-axis.

The distance to translate (move) an object along the x-axis, in pixels. This property is read/write. The default is 0.

Identifies the TranslateX dependency property.

The identifier for the TranslateX dependency property.

Gets or sets the distance to translate (move) an object along the y-axis.

The distance to translate (move) an object along the y-axis, in pixels. The default is 0.

Identifies the TranslateY dependency property.

The identifier for the TranslateY dependency property.

Represents the composited display surface for an app. This class provides application-wide rendering events.

Occurs immediately after the core rendering process renders a frame. This event lets you determine how long each frame takes to render.

Occurs when the core rendering process renders a frame.

Occurs when an underlying major change occurs, such as a DirectX device change. Typically the application must regenerate its surface contents when notified of this event.

Represents an ordered collection of Double values.

Initializes a new instance of the DoubleCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The **Double** value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the **Double** value specified.

The index at which to set the value. The value to set.

Declares alternate composition and blending modes for elements in mixed XAML / Microsoft DirectX UI.

Uses values from successive parents in the visual tree. This is the default.

Uses the minimum of the source and destination value for each pixel. This corresponds to D2D1_PRIMITIVE_BLEND_MIN.

Uses standard XAML source-over-destination mode. This corresponds to D2D1_PRIMITIVE_BLEND_SOURCE_OVER.

Represents the geometry of a circle or ellipse.

Initializes a new instance of the EllipseGeometry class.

Gets or sets the center point of the EllipseGeometry.

The center point of the EllipseGeometry.

Identifies the Center dependency property.

The Center dependency property identifier.

Gets or sets the x-radius value of the EllipseGeometry.

The x-radius value of the EllipseGeometry.

Identifies the RadiusX dependency property.

The RadiusX dependency property identifier.

Gets or sets the y-radius value of the EllipseGeometry.

The y-radius value of the EllipseGeometry.

Identifies the RadiusY dependency property.

The RadiusY dependency property identifier.

Defines constants that specify how MediaTransportControls fast-forward/backward buttons behave.

If the media doesn't support fast-forward/fast-rewind, the buttons are disabled.

If the media doesn't support fast-forward/fast-rewind, the buttons are hidden.

If the media doesn't support fast-forward/fast-rewind, the media skips 30 seconds.

Specifies how the intersecting areas of PathFigure objects contained in a Geometry are combined to form the area of the Geometry.

Rule that determines whether a point is in the fill region by drawing a ray from that point to infinity in any direction and counting the number of path segments within the given shape that the ray crosses. If this number is odd, the point is inside; if even, the point is outside.

Rule that determines whether a point is in the fill region of the path by drawing a ray from that point to infinity in any direction and then examining the places where a segment of the shape crosses the ray. Starting with a count of zero, add one each time a segment crosses the ray from left to right and subtract one each time a path segment crosses the ray from right to left. After counting the crossings, if the result is zero then the point is outside the path. Otherwise, it is inside.

Represents a family of related fonts.

Initializes a new instance of the FontFamily class from the specified font family string.

The family name of the font to represent. This can include a hashed suffix.

Gets the font family name that is used to construct the FontFamily object.

The font family name of the FontFamily object.

Gets the default font family based on an app's language settings.

The default font family based on an app's language settings. See Remarks.

Provides generalized transformation support for objects. GeneralTransform is a base class that's in the hierarchy of practical transform classes such as TranslateTransform.

Provides base class initialization behavior for GeneralTransform -derived classes.

Gets the inverse transformation of this GeneralTransform, if possible.

An inverse of this instance, if possible; otherwise null.

Implements the behavior for return value of Inverse in a derived or custom GeneralTransform.

The value that should be returned as Inverse by the GeneralTransform.

Transforms the specified bounding box and returns an axis-aligned bounding box that is exactly large enough to contain it.

The bounding box to transform. The smallest axis-aligned bounding box possible that contains the transformed *rect*.

Provides the means to override the TransformBounds behavior in a derived transform class.

The bounding box to transform. The smallest axis-aligned bounding box possible that contains the transformed *rect*.

Uses this transformation object's logic to transform the specified point, and returns the result.

The point to transform using the transformation logic. The result of transforming *point*.

Attempts to transform the specified point and returns a value that indicates whether the transformation was successful.

The point to transform. The result of transforming *inPoint*. **true** if *inPoint* was transformed; otherwise, **false**.

Provides the means to override the TryTransform behavior in a derived transform class.

The point to transform. The result of transforming *inPoint*. **true** if *inPoint* was transformed; otherwise, **false**.

Provides a base class for objects that define geometric shapes. Geometry objects can be used for clipping regions and as geometry definitions for rendering two-dimensional graphical data as a Path.

Gets a Rect that specifies the axis-aligned bounding box of the Geometry.

The axis-aligned bounding box of the Geometry.

Gets an empty geometry object.

The empty geometry object.

Gets the standard tolerance used for polygonal approximation.

The standard tolerance. The default value is 0.25.

Gets or sets the Transform object applied to a Geometry.

The transformation applied to the Geometry. Note that this value may be a single Transform or a list of Transform items.

Identifies the Transform dependency property.

The identifier for the Transform dependency property.

Represents a collection of Geometry objects.

Initializes a new instance of the GeometryCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the value specified.

The index at which to set the value. The value to set.

Represents a composite geometry, composed of other Geometry objects.

Initializes a new instance of the GeometryGroup class.

Gets or sets the GeometryCollection that contains the objects that define this GeometryGroup.

A collection containing the children of this GeometryGroup.

Identifies the Children dependency property.

The identifier for the Children dependency property.

Gets or sets how the intersecting areas of the objects contained in this GeometryGroup are combined.

One of the enumeration values that specifies how the intersecting areas are combined to form the resulting area. The default is **EvenOdd**.

Identifies the FillRule dependency property.

The identifier for the FillRule dependency property.

An abstract class that describes a gradient, composed of gradient stops. Parent class for LinearGradientBrush.

Provides base class initialization behavior for GradientBrush -derived classes.

Gets or sets a ColorInterpolationMode enumeration value that specifies how the gradient's colors are interpolated.

Specifies how the colors in a gradient are interpolated. The default is **SRgbLinearInterpolation**.

Identifies the ColorInterpolationMode dependency property.

The identifier for the ColorInterpolationMode dependency property.

Gets or sets the brush's gradient stops.

A collection of the GradientStop objects associated with the brush, each of which specifies a color and an offset along the brush's gradient axis. The default is an empty GradientStopCollection.

Identifies the GradientStops dependency property.

The identifier for the GradientStops dependency property.

Gets or sets a BrushMappingMode enumeration value that specifies whether the positioning coordinates of the gradient brush are absolute or relative to the output area.

A BrushMappingMode value that specifies how to interpret the gradient brush's positioning coordinates. The default is **RelativeToBoundingBox**.

Identifies the MappingMode dependency property.

The identifier for the MappingMode dependency property.

Gets or sets the type of spread method that specifies how to draw a gradient that starts or ends inside the bounds of the object to be painted.

The type of spread method used to paint the gradient. The default is **Pad**.

Identifies the SpreadMethod dependency property.

The identifier for the SpreadMethod dependency property.

Specifies how to draw the gradient outside a gradient brush's gradient vector or space.

The color values at the ends of the gradient vector fill the remaining space.

The gradient is repeated in the reverse direction until the space is filled.

The gradient is repeated in the original direction until the space is filled.

Describes the location and color of a transition point in a gradient.

Initializes a new instance of the GradientStop class.

Gets or sets the color of the gradient stop.

The color of the gradient stop. The default is Transparent.

Identifies the Color dependency property.

The identifier for the Color dependency property.

Gets the location of the gradient stop within the gradient vector.

The relative location of this gradient stop along the gradient vector. The default is 0.

Identifies the Offset dependency property.

The identifier for the Offset dependency property.

Represents a collection of GradientStop objects that can be individually accessed by index.

Initializes a new instance of the GradientStopCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The GradientStop value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the **GradientStop** value specified.

The index at which to set the value. The value to set.

Paints an area with an image. The image source is typically obtained from file formats such as Joint Photographic Experts Group (JPEG).

Initializes a new instance of the ImageBrush class.

Gets or sets the image source displayed by this ImageBrush. In code you set this with an ImageSource subclass instance, in XAML you set this with a URI to an image source file.

An object representing the image source, to be displayed by this ImageBrush when it's applied to content.

Identifies the ImageSource dependency property.

The identifier for the ImageSource dependency property.

Occurs when there is an error associated with image retrieval or format.

Occurs when the image source is downloaded and decoded with no failure. You can use this event to determine the size of an image before rendering it.

Provides an object source type for the Image.Source and ImageBrush.ImageSource properties.

Paints an area with a linear gradient.

Initializes a new instance of the LinearGradientBrush class.

Initializes a new instance of the LinearGradientBrush class that has the specified GradientStopCollection and angle.

The GradientStops to set on this brush. A System.Double that represents the angle, in degrees, of the gradient. A value of 0 creates a horizontal gradient, and a value of 90 creates a vertical gradient. Negative values are permitted, as are values over 360 (which are treated as **mod** 360).

Gets or sets the ending two-dimensional coordinates of the linear gradient.

The ending two-dimensional coordinates of the linear gradient. The default is a Point with value 1,1.

Identifies the EndPoint dependency property.

The identifier for the EndPoint dependency property.

Gets or sets the starting two-dimensional coordinates of the linear gradient.

The starting two-dimensional coordinates for the linear gradient. The default is a Point with value 0,0.

Identifies the StartPoint dependency property.

The identifier for the StartPoint dependency property.

Represents the geometry of a line.

Initializes a new instance of the LineGeometry class that has no length.

Gets or sets the end point of a line.

The end point of the line. The default is a Point with value 0,0.

Identifies the EndPoint dependency property.

The identifier for the EndPoint dependency property.

Gets or sets the start point of the line.

The start point of the line. The default is a Point with value 0,0.

Identifies the StartPoint dependency property.

The identifier for the StartPoint dependency property.

Represents a line drawn between two points, which can be part of a PathFigure within Path data.

Initializes a new instance of the LineSegment class.

Gets or sets the end point of the line segment.

The end point of the line segment. The default is a Point with value 0,0.

Identifies the Point dependency property.

The identifier for the Point dependency property.

Provides event data for the LoadedImageSurface.LoadCompleted event.

Gets a value that indicates whether the operation was successful. If it failed, indicates the reason for the failure.

A value of the enumeration that indicates whether the operation was successful. If it failed, indicates the reason for the failure.

Defines constants that specify whether an image loaded, or why it failed to load.

The image did not load because the image format is invalid.

The image did not load due to a network error.

The image did not load for some other reason.

The image loaded.

Represents a composition surface that an image can be downloaded, decoded and loaded onto. You can load an image using a Uniform Resource Identifier (URI) that references an image source file, or supplying a IRandomAccessStream.

Gets the size of the decoded image in physical pixels.

The size of the decoded image in physical pixels.

Gets the size of the decoded image in device independent pixels.

The size of the decoded image in device independent pixels.

Gets the natural size of the image in physical pixels, which is defined in the original image source.

The natural size of the image in physical pixels.

Occurs when the image has been downloaded, decoded and loaded to the underlying ICompositionSurface.

Disposes of the LoadedImageSurface and associated resources.

Loads an image onto a LoadedImageSurface from the provided IRandomAccessStream at the natural size

The stream from which the image is loaded. An instance of LoadedImageSurface with the image loaded onto its surface.

Loads an image into a LoadedImageSurface from the provided IRandomAccessStream with the desired maximum size.

The stream from which the image is loaded. The desired maximum size of the image surface in device independent pixels. An instance of LoadedImageSurface with the image loaded onto its surface.

Loads an image into a LoadedImageSurface from the provided Uniform Resource Identifier (URI) at the natural size defined in the image source.

The URI from which the image is loaded. An instance of LoadedImageSurface with the image loaded onto its surface.

Loads an image into a LoadedImageSurface from the provided Uniform Resource Identifier (URI) with the desired maximum size.

The URI from which the image is loaded. The desired maximum size of the image surface in device independent pixels. An instance of LoadedImageSurface with the image loaded onto its surface.

Represents a 3 × 3 affine transformation matrix used for transformations in two-dimensional space.

The value of the first row and first column of this Matrix structure.

The value of the first row and second column of this Matrix structure.

The value of the second row and first column of this Matrix structure.

The value of the second row and second column of this Matrix structure.

Gets or sets the value of the third row and first column of this Matrix structure.

Gets or sets the value of the third row and second column of this Matrix structure.

Applies a Matrix3D projection to an object.

Initializes a new instance of a Matrix3DProjection class.

Gets or sets the Matrix3D that is used for the projection that is applied to the object.

The Matrix3D that is used for the projection that is applied to the object.

Identifies the ProjectionMatrix dependency property.

The identifier for the ProjectionMatrix dependency property.

Provides static helper methods for processing Matrix values. C# and Microsoft Visual Basic code should use members of Matrix instead.

Gets a static constructed Matrix where the values established are representative of an **Identity** transform. C# and Microsoft Visual Basic code should use Identity instead.

A static constructed Matrix where the values established are representative of an **Identity** transform.

Creates a new Matrix based on provided initial Matrix data values. C# and Microsoft Visual Basic code should use Matrix constructor instead.

The initial value of **M11** for the created Matrix. The initial value of **M12** for the created Matrix. The initial value of **M21** for the created Matrix. The initial value of **M22** for the created Matrix. The initial value of **OffsetX** for the created Matrix. The initial value of **OffsetY** for the created Matrix. The created Matrix.

Returns whether the provided Matrix represents an **Identity** transform. C# and Microsoft Visual Basic code should use IsIdentity instead.

The target Matrix to evaluate. **true** if the Matrix represents an **Identity** transform; otherwise, **false**.

Transforms a provided Matrix using a Point input, and returns a Point result. C# and Microsoft Visual Basic code should use Transform instead.

The target Matrix to evaluate. The Point input for the transform operation. The Point result of the transform.

Creates an arbitrary affine matrix transformation that is used to manipulate objects or coordinate systems in a two-dimensional plane.

Initializes a new instance of the MatrixTransform class.

Gets or sets the Matrix that defines this transformation.

The Matrix structure that defines this transformation. The default is an identity Matrix. An identity matrix has a value of 1 in coefficients [1,1], [2,2], and [3,3]; and a value of 0 in the rest of the coefficients.

Identifies the Matrix dependency property.

The identifier for the Matrix dependency property.

Describes the likelihood that the media engine can play a media source based on its file type and characteristics.

Media engine might support the media source.

Media engine cannot support the media source.

Media engine can probably support the media source.

Defines the potential states of a MediaElement object.

The MediaElement is loading the media for playback. Its Position does not advance during this state. If the MediaElement was already playing video, it continues to display the last displayed frame.

The MediaElement contains no media. The MediaElement displays a transparent frame.

The MediaElement is validating and attempting to load the specified source.

The MediaElement does not advance its Position. If the MediaElement was playing video, it continues to display the current frame.

The MediaElement is playing the current media source.

The MediaElement contains media but is not playing or paused. Its Position is 0 and does not advance. If the loaded media is video, the MediaElement displays the first frame.

Provides data for the MediaTransportControls.ThumbnailRequested event.

Returns a deferral that can be used to defer the completion of the ThumbnailRequested event while the thumbnail is generated.

A deferral object that you can use to identify when the thumbnail request is complete.

Sets the source of the thumbnail image.

The source of the thumbnail image.

Provides data for the PartialMediaFailureDetected event.

Initializes a new instance of the PartialMediaFailureDetectedEventArgs class.

Gets error info for the media failure.

The error info for the media failure.

Gets a value indicating whether the stream that failed to decode contains audio or video.

A value indicating whether the stream that failed to decode contains audio or video.

Represents a subsection of a geometry, a single connected series of two-dimensional geometric segments.

Initializes a new instance of the PathFigure class.

Gets or sets a value that indicates whether this figure's first and last segments are connected.

**true** if the first and last segments of the figure are connected; otherwise, **false**.

Identifies the IsClosed dependency property.

The identifier for the IsClosed dependency property.

Gets or sets a value that indicates whether the contained area of this PathFigure is to be used for hit-testing, rendering, and clipping.

**true** if the contained area of this PathFigure is to be used for hit-testing, rendering, and clipping; otherwise, **false**. The default is **true**.

Identifies the IsFilled dependency property.

The identifier for the IsFilled dependency property.

Gets or sets the collection of segments that define the shape of this PathFigure object.

The collection of segments that define the shape of this PathFigure object. The default is an empty collection.

Identifies the Segments dependency property.

The identifier for the Segments dependency property.

Gets or sets the Point where the PathFigure begins.

The Point where the PathFigure begins. The default is a Point with value 0,0.

Identifies the StartPoint dependency property.

The identifier for the StartPoint dependency property.

Represents a collection of PathFigure objects that collectively make up the geometry of a PathGeometry.

Initializes a new instance of the PathFigureCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The PathFigure value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the PathFigure value specified.

The index at which to set the value. The value to set.

Represents a complex vector-based shape that may be composed of arcs, curves, ellipses, lines, and rectangles.

Initializes a new instance of the PathGeometry class.

Gets or sets the collection of PathFigure objects that describe the contents of a path.

A collection of PathFigure objects that describe the contents of a path. Each individual PathFigure describes a shape.

Identifies the Figures dependency property.

The identifier for the Figures dependency property.

Gets or sets a value that determines how the intersecting areas contained in the PathGeometry are combined.

A FillRule enumeration value that indicates how the intersecting areas of the PathGeometry are combined. The default is **EvenOdd**.

Identifies the FillRule dependency property.

The identifier for the FillRule dependency property.

Represents a segment of a PathFigure object. Derived classes of PathFigure describe different types of segments.

Represents a collection of PathSegment objects that can be individually accessed by index.

Initializes a new instance of the PathSegmentCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The PathSegment value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the PathSegment value specified.

The index at which to set the value. The value to set.

Describes the shape at the end of a line or segment.

A cap that does not extend past the last point of the line. Comparable to no line cap.

A semicircle that has a diameter equal to the line thickness.

A rectangle that has a height equal to the line thickness and a length equal to half the line thickness.

An isosceles right triangle whose base length is equal to the thickness of the line.

Describes the shape that joins two lines or segments.

Line joins use beveled vertices.

Line joins use regular angular vertices.

Line joins use rounded vertices.

Represents a perspective transform (a 3-D-like effect) on an object.

Initializes a new instance of the PlaneProjection class.

Gets or sets the x-coordinate of the center of rotation of the object that you rotate.

The x-coordinate of the center of rotation of the object that you rotate. Typical values are between 0 and 1 with a value of 0 corresponding to one edge of the object and 1 to the opposite edge. Values outside this range are allowed and move the center of rotation accordingly. The default is 0.5 (the center of object).

Identifies the CenterOfRotationX  dependency property.

The identifier for the CenterOfRotationX  dependency property.

Gets or sets the y-coordinate of the center of rotation of the object that you rotate.

The y-coordinate of the center of rotation of the object that you rotate. Typical values are between 0 and 1 with a value of 0 corresponding to one edge of the object and 1 to the opposite edge. Values outside this range are allowed and move the center of rotation accordingly. The default is 0.5 (the center of object).

Identifies the CenterOfRotationY  dependency property.

The identifier for the CenterOfRotationY  dependency property.

Gets or sets the z-coordinate of the center of rotation of the object that you rotate.

The z-coordinate of the center of rotation of the object that you rotate. The default is 0. Values greater than 0 correspond to coordinates in front of the plane of the object, and negative values correspond to coordinates behind the plane of the object.

Identifies the CenterOfRotationZ  dependency property.

The identifier for the CenterOfRotationZ  dependency property.

Gets or sets the distance that the object is translated along the x-axis of the screen.

The distance that the object is translated along the x-axis of the screen.

Identifies the GlobalOffsetX  dependency property.

The identifier for the GlobalOffsetX  dependency property.

Gets or sets the distance that the object is translated along the y-axis of the screen.

The distance that the object is translated along the y-axis of the screen.

Identifies the GlobalOffsetY  dependency property.

The identifier for the GlobalOffsetY  dependency property.

Gets or sets the distance that the object is translated along the z-axis of the screen.

The distance that the object is translated along the z-axis of the screen.

Identifies the GlobalOffsetZ  dependency property.

The identifier for the GlobalOffsetZ  dependency property.

Gets or sets the distance that the object is translated along the x-axis of the plane of the object.

The distance that the object is translated along the x-axis of the plane of the object.

Identifies the LocalOffsetX  dependency property.

The identifier for the LocalOffsetX  dependency property.

Gets or sets the distance that the object is translated along the y-axis of the plane of the object.

The distance that the object is translated along the y-axis of the plane of the object.

Identifies the LocalOffsetY  dependency property.

The identifier for the LocalOffsetY  dependency property.

Gets or sets the distance that the object is translated along the z-axis of the plane of the object.

The distance that the object is translated along the z-axis of the plane of the object.

Identifies the LocalOffsetZ  dependency property.

The identifier for the LocalOffsetZ  dependency property.

Gets the projection matrix of the PlaneProjection.

The projection matrix of the PlaneProjection. The default value is null.

Identifies the ProjectionMatrix dependency property.

The identifier for the ProjectionMatrix dependency property.

Gets or sets the number of degrees to rotate the object around the x-axis of rotation.

The number of degrees to rotate the object around the x-axis of rotation. The default is 0.

Identifies the RotationX  dependency property.

The identifier for the RotationX  dependency property.

Gets or sets the number of degrees to rotate the object around the y-axis of rotation.

The number of degrees to rotate the object around the y-axis of rotation. The default is 0.

Identifies the RotationY  dependency property.

The identifier for the RotationY  dependency property.

Gets or sets the number of degrees to rotate the object around the z-axis of rotation.

The number of degrees to rotate the object around the z-axis of rotation. The default is 0.

Identifies the RotationZ  dependency property.

The identifier for the RotationZ  dependency property.

Represents a collection of Point values that can be individually accessed by index.

Initializes a new instance of the PointCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

Adds a new item to the collection.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator object. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Point value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Point value specified.

The index at which to set the value. The value to set.

Represents one or more cubic Bezier curves.

Initializes a new instance of the PolyBezierSegment class.

Gets or sets the Point collection that defines this PolyBezierSegment object.

The collection of points that defines this PolyBezierSegment object.

Identifies the Points  dependency property.

The identifier for the Points  dependency property.

Represents a set of line segments defined by a Point collection with each Point specifying the end point of a line segment.

Initializes a new instance of the PolyLineSegment class.

Gets or sets the collection of Point values that defines this PolyLineSegment object.

The points that define this PolyLineSegment object.

Identifies the Points  dependency property.

The identifier for the Points  dependency property.

Represents a set of quadratic Bezier segments.

Initializes a new instance of the PolyQuadraticBezierSegment class.

Gets or sets the Point collection that defines this PolyQuadraticBezierSegment object.

A collection of points that defines the shape of this PolyQuadraticBezierSegment object. The default value is an empty collection.

Identifies the Points  dependency property.

The identifier for the Points  dependency property.

Provides a base class for projections, which describe how to transform an object in 3-D space using perspective transforms.

Provides base class initialization behavior for Projection -derived classes.

Creates a quadratic Bezier curve between two points in a PathFigure.

Initializes a new instance of the QuadraticBezierSegment class.

Gets or sets the control point of the curve.

The control point of this QuadraticBezierSegment. The default value is a Point with value 0,0.

Identifies the Point1  dependency property.

The identifier for the Point1  dependency property.

Gets or sets the end Point of this QuadraticBezierSegment.

The end point of this QuadraticBezierSegment. The default value is a Point with value 0,0.

Identifies the Point2  dependency property.

The identifier for the Point2  dependency property.

Provides event data for the RateChanged event.

Initializes a new instance of the RateChangedRoutedEventArgs class.

Represents the method that will handle the RateChanged event. This event fires when PlaybackRate or DefaultPlaybackRate change either via user interaction or from code.

The object where the handler is attached. The event data.

Describes a two-dimensional rectangular geometry.

Initializes a new instance of the RectangleGeometry class and creates a rectangle with zero area.

Gets or sets the dimensions of the rectangle.

The Rect structure that describes the position and size of the rectangle. The default is **null**.

Identifies the Rect  dependency property.

The identifier for the Rect  dependency property.

Provides event data for the Rendered event.

Gets the duration of the time it took to render the most recent frame.

The duration of the time it took to render the most recent frame.

Provides event data for the Rendering event.

Gets the time when the frame rendered, for timing purposes

The time when the frame rendered.

Paints a control background with a reveal effect using composition brush and light effects.

Initializes a new instance of the RevealBackgroundBrush class.

Paints a control border with a reveal effect using composition brush and light effects.

Initializes a new instance of the RevealBorderBrush class.

Base class for brushes that use composition effects and lighting to implement the reveal visual design treatment.

Provides base class initialization behavior for RevealBrush-derived classes.

Gets or sets a value that specifies whether the brush is forced to the solid fallback color.

**true** to always replace the reveal effect with the solid fallback color. Otherwise, **false**. The default is **false**.

Identifies the AlwaysUseFallback dependency property.

The identifier for the AlwaysUseFallback dependency property.

Gets or sets a value that specifies the base background color for the brush.

The base background color for the brush. The default value is transparent white (0x00FFFFFF).

Identifies the Color dependency property.

The identifier for the Color dependency property.

Identifies the RevealBrush.State attached property

The identifier for the RevealBrush.State attached property.

Gets or sets a value that specifies the theme used to draw the brush and light, to ensure that the correct composition effect recipe is used for the desired theme.

An ApplicationTheme value.

Identifies the TargetTheme dependency property.

The identifier for the TargetTheme dependency property.

Gets the value of the RevealBrush.State XAML attached property for the target element.

The object from which the property value is read. The RevealBrush.State XAML attached property value of the specified object.

Sets the value of the RevealBrush.State XAML attached property for a target element.

The object to which the property value is written. The value to set.

Defines constants that specify the pointer state of an element.

The element is in its default state.

The pointer is over the element.

The element is pressed.

Rotates an object around a specified point in a two-dimensional x-y coordinate system.

Initializes a new instance of the RotateTransform class.

Gets or sets the angle, in degrees, of clockwise rotation.

The angle, in degrees, of clockwise rotation. The default is 0.

Identifies the Angle dependency property.

The identifier for the Angle dependency property.

Gets or sets the x-coordinate of the rotation center point for this transformation.

The x-coordinate of the center of rotation, in pixels within the transform's frame of reference. The default is 0.

Identifies the CenterX dependency property.

The identifier for the CenterX dependency property.

Gets or sets the y-coordinate of the rotation center point for this transformation.

The y-coordinate of the center of rotation, in pixels within the transform's frame of reference. The default is 0.

Identifies the CenterY dependency property.

The identifier for the CenterY dependency property.

Scales an object in the two-dimensional x-y coordinate system.

Initializes a new instance of the ScaleTransform class.

Gets or sets the x-coordinate of the center point of this ScaleTransform.

The x-coordinate of the center point of this ScaleTransform. The default is 0.

Identifies the CenterX dependency property.

The identifier for the CenterX dependency property.

Gets or sets the y-coordinate of the center point of this ScaleTransform.

The y-coordinate of the center point of this ScaleTransform. The default is 0.

Identifies the CenterY dependency property.

The identifier for the CenterY dependency property.

Gets or sets the x-axis scale factor.

The scale factor along the x-axis. The default is 1.

Identifies the ScaleX dependency property.

The identifier for the ScaleX dependency property.

Gets or sets the y-axis scale factor.

The scale factor along the y-axis. The default is 1.

Identifies the ScaleY dependency property.

The identifier for the ScaleY dependency property.

The base class for shadow effects that can be applied to a XAML element.

Represents a two-dimensional skew.

Initializes a new instance of the SkewTransform class.

Gets or sets the x-axis skew angle, which is measured in degrees counterclockwise from the y-axis.

The skew angle, which is measured in degrees counterclockwise from the y-axis. The default is 0.

Identifies the AngleX dependency property.

The identifier for the AngleX dependency property.

Gets or sets the y-axis skew angle, which is measured in degrees counterclockwise from the x-axis.

The skew angle, which is measured in degrees counterclockwise from the x-axis. The default is 0.

Identifies the AngleY dependency property.

The identifier for the AngleY dependency property.

Gets or sets the x-coordinate of the transform center.

The x-coordinate of the transform center. The default is 0.

Identifies the CenterX dependency property.

The identifier for the CenterX dependency property.

Gets or sets the y-coordinate of the transform center.

The y-coordinate of the transform center. The default is 0.

Identifies the CenterY dependency property.

The identifier for the CenterY dependency property.

Paints an area with a solid color. The solid color is defined by a Color value.

Initializes a new instance of the SolidColorBrush class with no color.

Initializes a new instance of the SolidColorBrush class with the specified Color.

The color to apply to the brush.

Gets or sets the color of this SolidColorBrush.

The brush's color. The default value is Transparent.

Identifies the Color dependency property.

The identifier for the Color dependency property.

Describes the frame-packing mode for stereo 3-D video content.

Regular 2-D video.

Stereo 3-D content packing with components side-by-side.

Stereo 3-D content packing with components top and bottom.

Describes the stereo 3-D video render mode for the current media source.

Regular 2-D video.

Stereo 3-D video.

Describes how content is resized to fill its allocated space.

The content is resized to fill the destination dimensions. The aspect ratio is not preserved.

The content preserves its original size.

The content is resized to fit in the destination dimensions while it preserves its native aspect ratio.

The content is resized to fill the destination dimensions while it preserves its native aspect ratio. If the aspect ratio of the destination rectangle differs from the source, the source content is clipped to fit in the destination dimensions.

Describes the simulation style of a font.

Bold and italic style simulation.

Bold style simulation.

Italic style simulation.

No font style simulation.

Specifies the direction in which an elliptical arc is drawn.

Arcs are drawn in a clockwise (positive-angle) direction.

Arcs are drawn in a counterclockwise (negative-angle) direction.

A ThemeShadow is a preconfigured shadow effect that can be applied to any XAML element to draw shadows appropriately based on x, y, z coordinates. ThemeShadow also automatically adjusts for other environmental specifications:

Initializes a new instance of the ThemeShadow class.

Gets a collection of UI elements that this ThemeShadow is cast on.

A collection of UI elements that this ThemeShadow is cast on.

Base class that describes a way to paint a region. Parent of ImageBrush.

Provides base class initialization behavior for TileBrush -derived classes.

Gets or sets the horizontal alignment of content in the TileBrush base tile.

A value that specifies the horizontal position of TileBrush content in its base tile. The default value is **Center**.

Identifies the AlignmentX dependency property.

The identifier for the AlignmentX dependency property.

Gets or sets the vertical alignment of content in the TileBrush base tile.

A value that specifies the vertical position of TileBrush content in its base tile. The default value is **Center**.

Identifies the AlignmentY dependency property.

The identifier for the AlignmentY dependency property.

Gets or sets a value that specifies how the content of this TileBrush stretches to fit its tiles.

A value that specifies how this TileBrush content is projected onto its base tile. The default value is **Fill**.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Represents metadata associated with a specific point in a media file.

Initializes a new instance of the TimelineMarker class.

Gets or sets the text value of a TimelineMarker.

The text value of the TimelineMarker. The default value is an empty string.

Identifies the Text dependency property.

The identifier for the Text dependency property.

Gets or sets the time at which a TimelineMarker is reached.

The time at which the TimelineMarker is reached. The default value is null.

Identifies the Time dependency property.

The identifier for the Time dependency property.

Gets or sets the marker type of a TimelineMarker.

A string that describes the type of this TimelineMarker. The default value is an empty string.

Identifies the Type dependency property.

The identifier for the Type dependency property.

Represents a collection of TimelineMarker objects that can be individually accessed by index. A TimelineMarkerCollection is an ordered list where the order is determined by the Time value of each TimelineMarker item contained in the collection. For more info on how this affects the collection API, see Remarks.

Initializes a new instance of the TimelineMarkerCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The TimelineMarker value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the TimelineMarker value specified.

The index at which to set the value. The value to set.

Provides event data for the MarkerReached event.

Initializes a new instance of the TimelineMarkerRoutedEventArgs class.

Gets the TimelineMarker that triggered this event.

The TimelineMarker that triggered this event.

Represents methods that will handle various routed events related to timeline markers.

The object where the event handler is attached. The event data.

Defines functionality that enables transformations in a two-dimensional plane.

Represents a collection of Transform objects that can be individually accessed by index.

Initializes a new instance of the TransformCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns an iterator for the items in the collection.

The iterator. The iterator's current position is the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Transform value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a "capacity" in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Transform value specified.

The index at which to set the value. The value to set.

Represents a composite Transform composed of other Transform objects.

Initializes a new instance of the TransformGroup class.

Gets or sets the collection of child Transform objects.

The collection of child Transform objects. The default is an empty collection.

Identifies the Children dependency property.

The identifier for the Children dependency property.

Gets the Matrix structure that describes the transformation represented by this TransformGroup.

A composite of the Transform objects in this TransformGroup.

Translates (moves) an object in the two-dimensional x-y coordinate system.

Initializes a new instance of the TranslateTransform class.

Gets or sets the distance to translate along the x-axis.

The distance to translate (move) an object along the x-axis, in pixels. This property is read/write. The default is 0.

Identifies the X dependency property.

The identifier for the X dependency property.

Gets or sets the distance to translate (move) an object along the y-axis.

The distance to translate (move) an object along the y-axis, in pixels. The default is 0.

Identifies the Y dependency property.

The identifier for the Y dependency property.

Provides utility methods that can be used to traverse object relationships (along child-object or parent-object axes) in the visual tree of your app.

Explicitly removes all references from a target UIElement, with the goal of cleaning up reference cycles.

The target object to disconnect children and remove references from.

Retrieves a set of objects that are located within a specified x-y coordinate point of an app UI. The set of objects represents the components of a visual tree that share that point.

The point to use as the determination point. This point is using the coordinate space of the app window, not of any specific element (and not of *subtree* if specified). An object to search for. If the *subtree* object exists in the overall set of elements that exist at the specified *intersectingPoint* coordinates, then the return value contains only the *subtree* object and any objects that have a higher z-order than *subtree*, listed by inverse of z-order. If the *subtree* object doesn't exist at *intersectingPoint* coordinates, the return value will be empty. An enumerable set of UIElement objects in the visual tree composition at the specified point, listed by inverse of z-order.

Retrieves a set of objects that are located within a specified x-y coordinate point of an app UI. The set of objects represents the components of a visual tree that share that point.

The point to use as the determination point. This point is using the coordinate space of the app window, not of any specific element (and not of *subtree* if specified). An object to search for. If the *subtree* object exists in the overall set of elements that exist at the specified *intersectingPoint* coordinates, then the return value contains only the *subtree* object and any objects that have a higher z-order than *subtree*, listed by inverse of z-order. If the *subtree* object doesn't exist at *intersectingPoint* coordinates, the return value will be empty. **true** to include all elements that intersect, including those elements considered to be invisible to hit testing. **false** to find only visible, hit-testable elements. The default is **false**. An enumerable set of UIElement objects that are determined to be located in the visual tree composition at the specified point, listed by inverse of z-order.

Retrieves a set of objects that are located within a specified Rect frame of an app UI. The set of objects represents the components of a visual tree that share a rectangular area, and might include elements that overdraw.

The Rect to use as the determination area. This frame is using the coordinate space of the app window, not of any specific element (and not of *subtree* if specified). An object to search for. If the *subtree* object exists in the overall set of elements that exist within the specified *intersectingRect*, then the return value contains only the *subtree* object and elements that are drawing on top of its space. If the *subtree* object doesn't exist within the *intersectingRect* frame, the return value will be empty. An enumerable set of UIElement objects that are in the visual tree composition in the specified Rect frame.

Retrieves a set of objects that are located within a specified Rect frame of an app UI. The set of objects represents the components of a visual tree that share a rectangular area, and might include elements that overdraw.

The Rect to use as the determination area. This frame is using the coordinate space of the app window, not of any specific element (and not of *subtree* if specified). An object to search for. If the *subtree* object exists in the overall set of elements that exist within the specified *intersectingRect*, then the return value contains only the *subtree* object and elements that are drawing on top of its space. If the *subtree* object doesn't exist within the *intersectingRect* frame, the return value will be empty. **true** to include all elements that intersect, including those elements considered to be invisible to hit testing. **false** to find only visible, hit-testable elements. The default is **false**. An enumerable set of UIElement objects that are determined to be located in the visual tree composition in the specified Rect frame.

Using the provided index, obtains a specific child object of the provided object by examining the visual tree.

The object that holds the child collection. The index of the requested child object in the *reference* child collection. The child object as referenced by *childIndex*.

Returns the number of children that exist in an object's child collection in the visual tree.

The source visual. The number of visual children for the provided source visual.

Retrieves a collection of all open popup controls from the target Window.

The current Window instance to retrieve the popups from. The list of all open popups. If no popups are open, the list is empty.

Retrieves a collection of all open popup controls from the target XamlRoot.

The current XamlRoot instance to retrieve the popups from. The list of all open popups. If no popups are open, the list is empty.

Returns an object's parent object in the visual tree.

The object for which to get the parent object. The parent object of the *reference* object in the visual tree.

Provides a base class used to create XAML brushes that paint an area with a CompositionBrush.

Provides base class initialization behavior for **XamlCompositionBrushBase** derived classes.

Gets or sets the CompositionBrush used by this XAML brush.

The instance of CompositionBrush used by this XAML brush.

The color to use for rendering in case the CompositionBrush can't be rendered.

The color to use for rendering in place of the composition brush.

Identifies the **FallbackColor** dependency property.

The identifier for the **FallbackColor** dependency property.

Invoked when a brush is first used on screen to paint an element.

Invoked when the brush is no longer being used to paint any elements.

Provides a base class used to create XAML lights that use a CompositionLight to apply lighting effects to XAML elements and brushes.

Initializes a new instance of the **XamlLight** class.

Gets or sets the CompositionLight instance used to apply lighting effects.

An instance of a CompositionLight derived class used to apply lighting effects.

Sets a Brush as a target of a XamlLight.

The identifier for the XamlLight that should target the Brush. The Brush that the light should target.

Sets a UIElement as a target of a XamlLight.

The identifier for the XamlLight that should target the UIElement. The UIElement that the light should target.

Returns the identifier for the custom XamlLight type.

The identifier for the XamlLight.

This method is automatically called when the XamlLight is first in use on the screen, or after being previously disconnected then used again.

The UIElement that the light is attached to.

This method is automatically called when the XamlLight is no longer in use anywhere on the screen.

The UIElement that the light is attached to.

Stops a Brush from being a target of a XamlLight.

The identifier for the XamlLight that should no longer target the Brush. The Brush that the light should no longer target.

Stops a UIElement from being a target of a XamlLight.

The identifier for the XamlLight that should no longer target the UIElement. The UIElement that the light should no longer target.

Provides the animated transition behavior for when controls add or delete children of a panel. For example, if you have a collection of photos displayed in a Grid, you can associate this animation to the Grid so that when photos are added or deleted, the photos will animate in and out of view.

Initializes a new instance of the AddDeleteThemeTransition class.

Represents an easing function that changes a value in the opposite direction of the main function during part of a duration, then reverses and finishes the function-over-time behavior in a conventional way.

Initializes a new instance of the BackEase class.

Gets or sets the amplitude of retraction associated with a BackEase animation.

The amplitude of retraction associated with a BackEase animation. This value must be greater than or equal to 0. The default is 1.

Identifies the Amplitude dependency property.

The identifier for the Amplitude dependency property.

An object that configures the connected animation as a linear transition from the source to the destination.

Initializes a new instance of the BasicConnectedAnimationConfiguration class.

A trigger action that begins a Storyboard. Not commonly used. See Remarks.

Initializes a new instance of the BeginStoryboard class.

Gets or sets the Storyboard that this BeginStoryboard starts.

The Storyboard that the BeginStoryboard starts. The default is null.

Identifies the BeginStoryboard.Storyboard  dependency property.

The identifier for the BeginStoryboard.Storyboard  dependency property.

Represents an easing function that creates an animated bouncing effect.

Initializes a new instance of the BounceEase class.

Gets or sets the number of bounces.

The number of bounces. The value must be greater or equal to zero. Negative values will resolve to zero. The default is 3.

Identifies the Bounces dependency property.

The identifier for the Bounces dependency property.

Gets or sets a value that specifies how bouncy the bounce animation is. Low values of this property result in bounces with little loss of height between bounces (more bouncy) while high values result in dampened bounces (less bouncy).

The value that specifies how bouncy the bounce animation is. This value must be positive. The default value is 2.

Identifies the Bounciness dependency property.

The identifier for the Bounciness dependency property.

Represents an easing function that creates an animation that accelerates and/or decelerates using a circular function.

Initializes a new instance of the CircleEase class.

Describes the potential states of an animation.

The current animation changes in direct relation to the animation of its parent.

The animation continues and does not change in relation to the animation of its parent.

The animation is stopped.

Animates the value of a Color property between two target values using linear interpolation over a specified Duration.

Initializes a new instance of the ColorAnimation class.

Gets or sets the total amount by which the animation changes its starting value.

The total amount by which the animation changes its starting value. The default is null.

Identifies the By  dependency property.

The identifier for the By  dependency property.

Gets or sets the easing function applied to this animation.

The easing function applied to this animation.

Identifies the EasingFunction  dependency property.

The identifier for the EasingFunction   dependency property.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets or sets the animation's starting value.

The starting value of the animation. The default is null.

Identifies the From  dependency property.

The identifier for the From  dependency property.

Gets or sets the animation's ending value.

The ending value of the animation. The default is null.

Identifies the To  dependency property.

The identifier for the To  dependency property.

Animates the value of a Color property along a set of key frames.

Initializes a new instance of the ColorAnimationUsingKeyFrames class.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets the collection of ColorKeyFrame objects that define the animation.

The collection of ColorKeyFrame objects that define the animation. The default is an empty collection.

Provides a base class for specific animation key-frame techniques that define an animation segment with a Color target value. Derived classes each provide a different key-frame interpolation method for a Color value that is provided for a ColorAnimationUsingKeyFrames animation.

Provides base class initialization behavior for ColorKeyFrame -derived classes.

Gets or sets the time at which the key frame's target Value should be reached.

The time at which the key frame's current value should be equal to its Value property. The default is null.

Identifies the KeyTime dependency property.

The identifier for the KeyTime  dependency property.

Gets or sets the key frame's target value.

The key frame's target value, which is the value at its specified KeyTime. The default is a Color with an ARGB value of #00000000.

Identifies the Value dependency property.

The identifier for the Value  dependency property.

Represents a collection of ColorKeyFrame objects that can be individually accessed by index. ColorKeyFrameCollection is the value of the ColorAnimationUsingKeyFrames.KeyFrames property.

Initializes a new instance of the ColorKeyFrameCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The ColorKeyFrame value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the ColorKeyFrame value specified.

The index at which to set the value. The value to set.

Provides common parameters for navigation transition animations.

Initializes a new instance of the CommonNavigationTransitionInfo class.

Identifies the CommonNavigationTransitionInfo.IsStaggerElement attached property.

The identifier for the CommonNavigationTransitionInfo.IsStaggerElement attached property.

Gets or sets a Boolean value indicating if staggering is enabled for the navigation transition.

A Boolean value indicating if staggering is enabled for the navigation transition.

Identifies the IsStaggeringEnabled dependency property.

The identifier for the IsStaggeringEnabled dependency property.

Returns a Boolean value indicating if the specified **UIElement** is the stagger element for the navigation transition.

The **UIElement** to check as being the stagger element. Returns **true** if *element* is the stagger element; otherwise **false**.

Sets a Boolean value indicating if the specified **UIElement** is the stagger element for the navigation transition.

The **UIElement** about which to set the stagger element indicator. Set this value to **true** if *element* is the stagger element; otherwise set it to **false**.

Not intended for general use. See also IndependentlyAnimatableAttribute.

Initializes a new instance of the ConditionallyIndependentlyAnimatableAttribute class.

Represents an animation that simultaneously animates the exit of one element and the entrance of another element.

Gets or sets the configuration that describes the type of connected animation to play.

A configuration that describes the type of connected animation to play.

Gets or sets a value that indicates whether the scale component of the connected animation should be used.

**true** if the scale component of the connected animation should be used. otherwise, **false**. The default is **true**.

Occurs when the animation is finished.

Stops the connected animation.

Sets a custom CompositionAnimation to change the motion of a particular part of the connected animation.

The part of the connected animation to change. The animation to use in place of the default one.

Attempts to start the animation.

The element that is animated into view. **true** if the animation started; **false** if the animation has already been started, if it is no longer active, or if the destination element is the same as the source element.

Attempts to start the animation on the destination element and specified secondary elements.

The element that is animated into view. The collection of secondary elements. These elements will play an entrance animation where they travel alongside the connected animation target in a "coordinated animation". **true** if the animation started; **false** if the animation has already been started, if it is no longer active, or if the destination element is the same as the source element.

Defines constants that specify the component animations that make up a connected animation.

The crossfade animation.

The X component of the translation animation.

The Y component of the translation animation.

The scale animation.

An object that describes the type of animation to play during a connected animation.

Represents a service that provides properties and methods to display a ConnectedAnimation.

Gets or sets the default time that the animation runs.

The default time that the animation runs.

Gets or sets the default CompositionEasingFunction used by the animation.

The default CompositionEasingFunction used by the animation.

Returns the animation with the specified key.

The key for the animation. The animation with the specified key; or **null** if no animation has been prepared for that key, or if the animation is no longer active.

Returns an instance of ConnectedAnimationService for the current view.

An instance of ConnectedAnimationService for the current view.

Returns a connected animation that's associated with the specified key and source element.

The key for the animation. The element that is animated out of view. The animation with the specified key.

Provides the animated transition behavior for when the content of a control is changing. This might be applied in addition to AddDeleteThemeTransition.

Initializes a new instance of the ContentThemeTransition class.

Gets or sets the distance by which the target is translated in the horizontal direction when the transition is active.

The horizontal offset translation, in pixels.

Identifies the HorizontalOffset dependency property.

The identifier for the HorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the transition is active.

The vertical offset translation, in pixels.

Identifies the VerticalOffset dependency property.

The identifier for the VerticalOffset dependency property.

Specifies the object that will fly between pages to provide context during a continuum transition.

Initializes a new instance of the ContinuumNavigationTransitionInfo class.

Gets or sets the element that will fly between pages during a continuum navigation transition.

The element that will fly between pages during a continuum navigation transition.

Identifies the ContinuumNavigationTransitionInfo.ExitElementContainer attached property.

The identifier for the ContinuumNavigationTransitionInfo.ExitElementContainer attached property.

Identifies the ExitElement dependency property.

The identifier for the ExitElement dependency property.

Identifies the ContinuumNavigationTransitionInfo.IsEntranceElement attached property.

The identifier for the ContinuumNavigationTransitionInfo.IsEntranceElement attached property.

Identifies the ContinuumNavigationTransitionInfo.IsExitElement attached property.

The identifier for the ContinuumNavigationTransitionInfo.IsExitElement attached property.

Returns a Boolean value indicating if the specified element is the ExitElement container.

The element to be checked as being the container. Returns **true** if *element* is the container; otherwise **false**.

Returns a Boolean value indicating if the specified **UIElement** is the entrance element for the continuum navigation.

The **UIElement** to check as being the entrance element. Returns **true** if *element* is the entrance element; otherwise **false**.

Returns a Boolean value indicating if the specified **UIElement** is the exit element of the continuum navigation.

The **UIElement** to check as being the exit element. Returns **true** if *element* is the exit element; otherwise **false**.

Sets a Boolean value indicating that the specified element is the exit element container for the continuum navigation.

The element about which to set the exit element container indicator. Set this value to **true** if *element* is the exit element; otherwise set it to **false**.

Sets a Boolean value indicating if the specified **UIElement** is the entrance element for the continuum navigation.

The **UIElement** about which to set the entrance element indicator. Set this value to **true** if *element* is the entrance element; otherwise set it to **false**.

Sets a Boolean value indicating if the specified **UIElement** is the exit element for the continuum navigation.

The **UIElement** about which to set the exit element indicator. Set this value to **true** if *element* is the exit element; otherwise set it to **false**.

Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f* (*t*) = *t*³.

Initializes a new instance of the CubicEase class.

An object that configures the connected animation to play a quick linear animation between source and destination.

Initializes a new instance of the DirectConnectedAnimationConfiguration class.

Animates from the Color value of the previous key frame to its own Value using discrete values.

Initializes a new instance of the DiscreteColorKeyFrame class.

Animates from the Double value of the previous key frame to its own Value using discrete values.

Initializes a new instance of the DiscreteDoubleKeyFrame class.

Animates from the Object value of the previous key frame to its own Value using discrete values.

Initializes a new instance of the DiscreteObjectKeyFrame class.

Animates from the Point value of the previous key frame to its own Value using discrete frames.

Initializes a new instance of the DiscretePointKeyFrame class.

Animates the value of a Double property between two target values using linear interpolation over a specified Duration.

Initializes a new instance of the DoubleAnimation class.

Gets or sets the total amount by which the animation changes its starting value.

The total amount by which the animation changes its starting value. The default is null.

Identifies the By  dependency property.

The identifier for the By  dependency property.

Gets or sets the easing function applied to this animation.

The easing function applied to this animation.

Identifies the EasingFunction  dependency property.

The identifier for the EasingFunction  dependency property.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets or sets the animation's starting value.

The starting value of the animation. The default is null.

Identifies the From  dependency property.

The identifier for the From  dependency property.

Gets or sets the animation's ending value.

The ending value of the animation. The default is null.

Identifies the To  dependency property.

The identifier for the To  dependency property.

Animates the value of a Double property along a set of key frames.

Initializes a new instance of the DoubleAnimationUsingKeyFrames class.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets the collection of DoubleKeyFrame objects that define the animation.

The collection of DoubleKeyFrame objects that define the animation. The default is an empty collection.

An abstract class that defines an animation segment with its own target value and interpolation method for a DoubleAnimationUsingKeyFrames.

Provides base class initialization behavior for DoubleKeyFrame -derived classes.

Gets or sets the time at which the key frame's target Value should be reached.

The time at which the key frame's current value should be equal to its Value property. The default is null.

Identifies the KeyTime dependency property.

The identifier for the KeyTime dependency property.

Gets or sets the key frame's target value.

The key frame's target value, which is the value of this key frame at its specified KeyTime. The default is 0.

Identifies the Value dependency property.

The identifier for the Value dependency property.

Represents a collection of DoubleKeyFrame objects that can be individually accessed by index. DoubleKeyFrameCollection is the value of the DoubleAnimationUsingKeyFrames.KeyFrames property.

Initializes a new instance of the DoubleKeyFrameCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the DoubleKeyFrame located at the specified index.

The integer index for the value to retrieve. The DoubleKeyFrame value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the DoubleKeyFrame value specified.

The index at which to set the value. The value to set.

Represents the preconfigured animation that applies to item elements being dragged.

Initializes a new instance of the DragItemThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Represents the preconfigured animation that applies to the elements underneath an element being dragged.

Initializes a new instance of the DragOverThemeAnimation class.

Gets or sets the direction that the target should translate, when the animation is active.

A value of the enumeration.

Identifies the Direction dependency property.

The identifier for the Direction dependency property.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Gets or sets the distance by which the target is translated when the animation is active.

The offset, in pixels.

Identifies the ToOffset dependency property.

The identifier for the ToOffset dependency property.

Specifies the animation to run when a user navigates forward in a logical hierarchy, like from a master list to a detail page.

Initializes a new instance of the DrillInNavigationTransitionInfo class.

Represents a preconfigured animation that runs when a user navigates forward in a logical hierarchy, like from a master page to a detail page.

Initializes a new instance of the DrillInThemeAnimation class.

Gets or sets the element that is animating into view, such as a detail page.

The element that is animating into view, such as a detail page.

Gets or sets the name of the element that is animating into view.

The name of the element that is animating into view.

Identifies the EntranceTargetName dependency property.

The identifier for the EntranceTargetName dependency property.

Identifies the EntranceTarget dependency property.

The identifier for the EntranceTarget dependency property.

Gets or sets the element that is animating out of view, such as a master page.

The element that is animating out of view, such as a master page.

Gets of sets the name of the element that is animating out of view.

The name of the element that is animating out of view.

Identifies the ExitTargetName dependency property.

The identifier for the ExitTargetName dependency property.

Identifies the ExitTarget dependency property.

The identifier for the ExitTarget dependency property.

Represents a preconfigured animation that runs when a user navigates backward in a logical hierarchy, like from a detail page to a master page.

Initializes a new instance of the DrillOutThemeAnimation class.

Gets or sets the element that is animating into view, such as a master page.

The element that is animating into view, such as a master page.

Gets or sets the name of the element that is animating into view.

The name of the element that is animating into view.

Identifies the EntranceTargetName dependency property.

The identifier for the EntranceTargetName dependency property.

Identifies the EntranceTarget dependency property.

The identifier for the EntranceTarget dependency property.

Gets or sets the element that is animating out of view, such as a detail page.

The element that is animating out of view, such as a detail page.

Gets of sets the name of the element that is animating out of view.

The name of the element that is animating out of view.

Identifies the ExitTargetName dependency property.

The identifier for the ExitTargetName dependency property.

Identifies the ExitTarget dependency property.

The identifier for the ExitTarget dependency property.

Represents the preconfigured animation that applies to potential drop target elements.

Initializes a new instance of the DropTargetItemThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Associates easing functions with a ColorAnimationUsingKeyFrames key-frame animation.

Initializes a new instance of the EasingColorKeyFrame class.

Gets or sets the easing function that is applied to the key frame.

The easing function that is applied to the key frame.

Identifies the EasingFunction dependency property.

The identifier for the EasingFunction dependency property.

Associates an easing function with a DoubleAnimationUsingKeyFrames key-frame animation.

Initializes a new instance of the EasingDoubleKeyFrame class.

Gets or sets the easing function that is applied to the key frame.

The easing function that is applied to the key frame.

Identifies the EasingFunction dependency property.

The identifier for the EasingFunction dependency property.

Provides the base class for all the easing functions.

Gets or sets a value that specifies how the animation interpolates.

One of the enumeration values that specifies how the animation interpolates. The default is **EaseOut**.

Identifies the EasingMode dependency property.

The identifier for the EasingMode dependency property.

Transforms normalized time to control the pace of an animation.

Normalized time (progress) of the animation. A double that represents the transformed progress.

Specifies how the animation associated with an easing function interpolates.

Interpolation follows the mathematical formula associated with the easing function.

Interpolation uses **EaseIn** for the first half of the animation and **EaseOut** for the second half.

Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.

Associates an easing function with a PointAnimationUsingKeyFrames key-frame animation.

Initializes a new instance of the EasingPointKeyFrame class.

Gets or sets the easing function that is applied to the key frame.

The easing function that is applied to the key frame.

Identifies the EasingFunction dependency property.

The identifier for the EasingFunction dependency property.

Provides the animated transition behavior for an edge UI transition.

Initializes a new instance of the EdgeUIThemeTransition class.

Gets or sets the edge position to use for the transition.

A value of the enumeration. The default is **Top**.

Identifies the Edge dependency property.

The identifier for the Edge dependency property.

Represents an easing function that creates an animation that resembles a spring oscillating back and forth until it comes to rest.

Initializes a new instance of the ElasticEase class.

Gets or sets the number of times the target slides back and forth over the animation destination.

The number of times the target slides back and forth over the animation destination. This value must be greater than or equal to 0. The default is 3.

Identifies the Oscillations dependency property.

The identifier for the Oscillations dependency property.

Gets or sets the stiffness of the spring. The smaller the Springiness value is, the stiffer the spring and the faster the elasticity decreases in intensity over each oscillation.

A positive number that specifies the stiffness of the spring. The default value is 3.

Identifies the Springiness dependency property.

The identifier for the Springiness dependency property.

Specifies the animation to run when content appears on a Page.

Initializes a new instance of the EntranceNavigationTransitionInfo class.

Identifies the EntranceNavigationTransitionInfo.IsTargetElement XAML attached property.

The identifier for the EntranceNavigationTransitionInfo.IsTargetElement XAML attached property.

Gets the value of the EntranceNavigationTransitionInfo.IsTargetElement XAML attached property for the target element.

The object from which the property value is read. The EntranceNavigationTransitionInfo.IsTargetElement attached property value of the specified object. **true** if the element is the animation target; otherwise, **false**.

Sets the value of the EntranceNavigationTransitionInfo.IsTargetElement XAML attached property for a target element.

The object to which the property value is written. The value to set. **true** if the element is the animation target; otherwise, **false**.

Provides the animated transition behavior on controls when they first appear. You can use this on individual objects or on containers of objects. In the latter case, child elements will animate into view in sequence rather than all at the same time.

Initializes a new instance of the EntranceThemeTransition class.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset translation, in pixels.

Identifies the FromVerticalOffset dependency property.

The identifier for the FromVerticalOffset dependency property.

Gets or sets a value that determines whether the transition staggers rendering of multiple items, or renders all items at once.

**true** if the animation staggers rendering of multiple items. **false** if the animation renders all items at once.

Identifies the IsStaggeringEnabled dependency property.

The identifier for the IsStaggeringEnabled dependency property.

Represents an easing function that creates an animation that accelerates and/or decelerates using an exponential formula.

Initializes a new instance of the ExponentialEase class.

Gets or sets the exponent used to determine the interpolation of the animation.

The exponent used to determine the interpolation of the animation. The default is 2.

Identifies the Exponent  dependency property.

The identifier for the Exponent  dependency property.

Represents the preconfigured opacity animation that applies to controls when they are first shown.

Initializes a new instance of the FadeInThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Represents the preconfigured opacity animation that applies to controls when they are removed from the UI or hidden.

Initializes a new instance of the FadeOutThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Specifies how a Timeline behaves when it is outside its active period but its parent is inside its active or hold period.

After it reaches the end of its active period, the timeline holds its progress until the end of its parent's active and hold periods.

The timeline stops if it is outside its active period while its parent is inside its active period.

An object that configures the connected animation to play using the gravity configuration.

Initializes a new instance of the GravityConnectedAnimationConfiguration class.

Gets or sets a value that indicates whether a shadow effect is shown.

**true** if a shadow effect is shown; otherwise, **false**.

Not intended for general use. This attribute is used by design tools such as Microsoft Visual Studio. Microsoft Visual Studio interprets the attribute and informs app developers how an animation-property combination will work as far as performance and restrictions.

Initializes a new instance of the FadeOutThemeAnimation class.

Represents a spline key frame to define animation progress.

Initializes a new instance of the KeySpline class.

Gets or sets the first control point used to define a Bezier curve that describes a KeySpline.

The first control point used to define a Bezier curve that describes a KeySpline.

Gets or sets the second control point used to define a Bezier curve that describes a KeySpline.

The second control point used to define a Bezier curve that describes a KeySpline.

Specifies when a particular key frame should take place during an animation.

The time component of this KeyTime.

Provides utility methods for working with KeyTime values. C# and Microsoft Visual Basic code should use members of KeyTime instead.

Generates a new KeyTime with initial data based on the specified TimeSpan. C# and Microsoft Visual Basic code should use FromTimeSpan instead.

The TimeSpan data value to establish. The generated KeyTime value.

Animates from the Color value of the previous key frame to its own Value using linear interpolation.

Initializes a new instance of the LinearColorKeyFrame class.

Animates from the Double value of the previous key frame to its own Value using linear interpolation.

Initializes a new instance of the LinearDoubleKeyFrame class.

Animates from the Point value of the previous key frame to its own Value, using linear interpolation.

Initializes a new instance of the LinearPointKeyFrame class.

Provides page navigation animations.

Initializes a new instance of the NavigationThemeTransition class.

Gets or sets the default transition used when navigating between pages.

The default transition used when navigating between pages.

Identifies the DefaultNavigationTransitionInfo dependency property.

Identifier for the DefaultNavigationTransitionInfo dependency property.

Provides parameter info for the Frame.Navigate method. Controls how the transition animation runs during the navigation action.

Initializes a new instance of the NavigationTransitionInfo class.

When implemented in a derived class, gets the navigation state string that is reported for navigation actions through Frame.Navigate and similar API.

The string to use for navigation state info.

When implemented in a derived class, sets the navigation state string that is passed for navigation actions through Frame.Navigate and similar API.

The string to use for navigation state info.

Animates the value of an Object property along a set of KeyFrames over a specified Duration.

Initializes a new instance of the ObjectAnimationUsingKeyFrames class.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets the collection of ObjectKeyFrame objects that define the animation.

The collection of ObjectKeyFrame objects that define the animation. The default is an empty collection.

Defines an animation segment with its own target value and interpolation method for an ObjectAnimationUsingKeyFrames.

Provides base class initialization behavior for ObjectKeyFrame -derived classes.

Gets or sets the time at which the key frame's target Value should be reached.

The time at which the key frame's current value should be equal to its Value property. The default is null.

Identifies the KeyTime dependency property.

The identifier for the KeyTime dependency property.

Gets or sets the key frame's target value.

The key frame's target value, which is the value of this key frame at its specified KeyTime. The default is null.

Identifies the Value dependency property.

The identifier for the Value dependency property.

Represents a collection of ObjectKeyFrame objects that can be individually accessed by index. ObjectKeyFrameCollection is the value of the ObjectAnimationUsingKeyFrames.KeyFrames property.

Initializes a new instance of the ObjectKeyFrameCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The ObjectKeyFrame value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the ObjectKeyFrame value specified.

The index at which to set the value. The value to set.

Provides the animated transition behavior for a panel UI transition.

Initializes a new instance of the PaneThemeTransition class.

Gets or sets the edge position to use for the transition.

A value of the enumeration. The default is **Left**.

Identifies the Edge dependency property.

The identifier for the Edge dependency property.

Animates the value of a Point property between two target values using linear interpolation over a specified Duration.

Initializes a new instance of the PointAnimation class.

Gets or sets the total amount by which the animation changes its starting value.

The total amount by which the animation changes its starting value. The default is **null**.

Identifies the By dependency property.

The identifier for the By  dependency property.

Gets or sets the easing function you are applying to the animation.

The easing function you are applying to the animation. The default is null.

Identifies the EasingFunction dependency property.

The identifier for the EasingFunction  dependency property.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets or sets the animation's starting value.

The starting value of the animation. The default is **null**.

Identifies the From dependency property.

The identifier for the From dependency property.

Gets or sets the animation's ending value.

The ending value of the animation. The default is **null**.

Identifies the To dependency property.

The identifier for the To dependency property.

Animates the value of a Point property along a set of KeyFrames.

Initializes a new instance of the PointAnimationUsingKeyFrames class.

Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration.

**true** if the animation can be used for a dependent animation case. **false** if the animation cannot be used for a dependent animation case. The default is **false**.

Identifies the EnableDependentAnimation dependency property.

The identifier for the EnableDependentAnimation dependency property.

Gets the collection of PointKeyFrame objects that define the animation.

The collection of PointKeyFrame objects that define the animation. The default is an empty collection.

Represents a preconfigured animation that runs when a pointer down is detected on an item or element.

Initializes a new instance of the PointerDownThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The name of the control element being targeted.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Represents a preconfigured animation that runs after a pointer down is detected on an item or element and the tap action is released.

Initializes a new instance of the PointerDownThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Defines an animation segment with its own target value and interpolation method for a PointAnimationUsingKeyFrames.

Provides base class initialization behavior for PointKeyFrame -derived classes.

Gets or sets the time at which the key frame's target Value should be reached.

The time at which the key frame's current value should be equal to its Value property. The default is null.

Identifies the KeyTime dependency property.

The identifier for the KeyTime dependency property.

Gets or sets the key frame's target value.

The key frame's target value, which is the value of this key frame at its specified KeyTime. The default is 0.

Identifies the Value dependency property.

The identifier for the Value dependency property.

Represents a collection of PointKeyFrame objects that can be individually accessed by index. PointKeyFrameCollection is the value of the PointAnimation.KeyFrames property.

Initializes a new instance of the PointKeyFrameCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index of the value to retrieve. The PointKeyFrame value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to insert the value. The value to insert.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the PointKeyFrame value specified.

The index at which to set the value. The value to set.

Represents the preconfigured animation that applies to pop-in components of controls (for example, tooltip-like UI on an object) as they appear. This animation combines opacity and translation.

Initializes a new instance of the PopInThemeAnimation class.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset translation, in pixels.

Identifies the FromVerticalOffset dependency property.

The identifier for the FromVerticalOffset dependency property.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Represents the preconfigured animation that applies to pop-in components of controls (for example, tooltip-like UI on an object) as they are closed/removed. This animation combines opacity and translation.

Initializes a new instance of the PopOutThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Provides the animated transition behavior that applies to pop-in components of controls (for example, tooltip-like UI on an object) as they appear.

Initializes a new instance of the PopUpThemeTransition class.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset translation, in pixels.

Identifies the FromVerticalOffset dependency property.

The identifier for the FromVerticalOffset dependency property.

Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f* (*t*) = *t**^p* where *p* is equal to the Power property.

Initializes a new instance of the PowerEase class.

Gets or sets the exponential power of the animation interpolation. For example, a value of 7 creates an animation interpolation curve that follows the formula *f* (*t*) = *t*⁷.

The exponential power of the animation interpolation. This value must be greater or equal to 0. The default is 2.

Identifies the Power dependency property.

The identifier for the Power dependency property.

Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f* (*t*) = *t*²

Initializes a new instance of the QuadraticEase class.

Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f* (*t*) = *t*⁴.

Initializes a new instance of the QuarticEase class.

Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f* (*t*) = *t*⁵.

Initializes a new instance of the QuinticEase class.

Provides the animated transition behavior for when list-view controls items change order. Typically this is due to a drag-drop operation. Different controls and themes potentially have varying characteristics for the animations involved.

Initializes a new instance of the ReorderThemeTransition class.

Describes how a Timeline repeats its simple duration.

The number of times a Timeline should repeat.

The time span for which a Timeline should repeat.

The mode or type of repeat behavior that this instance represents, as a value of the enumeration.

Provides basic utility methods for processing RepeatBehavior values. C# and Microsoft Visual Basic code should use members of RepeatBehavior instead.

Gets a static RepeatBehavior that represents the special "Forever" value. C# and Microsoft Visual Basic code should use Forever instead.

A static RepeatBehavior that represents the special "Forever" value.

Determines whether two RepeatBehavior values have equivalent values. C# and Microsoft Visual Basic code should use the equality operator instead.

The first RepeatBehavior to compare. The second RepeatBehavior to compare. **true** if *target* and *value* hold equivalent values; otherwise, **false**.

Creates a new RepeatBehavior based on a repeat count. This corresponds to the *int***x** form when provided as XAML attribute value. C# and Microsoft Visual Basic code should use RepeatBehavior(Double) instead.

The number of times that the target animation should repeat. The created RepeatBehavior, which has a **RepeatBehaviorType** of **Count**.

Creates a new RepeatBehavior based on a timespan. C# and Microsoft Visual Basic code should use RepeatBehavior(TimeSpan) instead.

The time span that declares the desired repeat behavior. The created RepeatBehavior, which has a **RepeatBehaviorType** value of **Duration**.

Returns whether a specified RepeatBehavior has a **RepeatBehaviorType** of **Count** and a nonzero **Count** value. C# and Microsoft Visual Basic code should use HasCount instead.

The RepeatBehavior to evaluate. **true** if *target* has a **RepeatBehaviorType** of **Count** and a nonzero **Count** value. Otherwise, **false**.

Returns whether a specified RepeatBehavior has a **RepeatBehaviorType** of **Duration** and a nonzero **Duration** value. C# and Microsoft Visual Basic code should use HasDuration instead.

The RepeatBehavior to evaluate. **true** if *target* has a **RepeatBehaviorType** of **Duration** and a nonzero **Duration** value. Otherwise, **false**.

Specifies the repeat mode that a RepeatBehavior raw value represents.

The RepeatBehavior represents a case where the timeline should repeat for a fixed number of complete runs.

The RepeatBehavior represents a case where the timeline should repeat for a time duration, which might result in an animation terminating part way through.

The RepeatBehavior represents a case where the timeline should repeat indefinitely.

Use to animate an object that is being repositioned.

Initializes a new instance of the RepositionThemeAnimation class.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset translation, in pixels.

Identifies the FromVerticalOffset dependency property.

The identifier for the FromVerticalOffset dependency property.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Reacts to layout moves when no context is set and a trigger of *move* is passed.

Initializes a new instance of the RepositionThemeTransition class.

Gets or sets a value that determines whether the transition staggers rendering of multiple items, or renders all items at once.

**true** if the animation staggers rendering of multiple items. **false** if the animation renders all items at once. The default is **true**.

Identifies the IsStaggeringEnabled dependency property.

The identifier for the IsStaggeringEnabled dependency property.

Represents an easing function that creates an animation that accelerates and/or decelerates using a sine formula.

Initializes a new instance of the SineEase class.

Defines constants that describe the type of animation to play during a slide transition.

The exiting page fades out and the entering page enters from the bottom.

The exiting page leaves to the right of the panel and the entering page enters from the left.

The exiting page leaves to the left of the panel and the entering page enters from the right.

Provides the parameters for a slide navigation transition.

Initializes a new instance of the **SlideNavigationTransitionInfo** class.

Gets or sets the type of animation effect to play during the slide transition.

The type of animation effect to play during the slide transition.

Identifies the Effect dependency property.

The identifier for the Effect dependency property.

Animates from the Color value of the previous key frame to its own Value using splined interpolation.

Initializes a new instance of the SplineColorKeyFrame class.

Gets or sets the two control points that define animation progress for this key frame.

The two control points that specify the cubic Bezier curve that defines the progress of the key frame.

Identifies the KeySpline dependency property.

The identifier for the KeySpline dependency property.

Animates from the Double value of the previous key frame to its own Value using splined interpolation.

Initializes a new instance of the SplineDoubleKeyFrame class.

Gets or sets the two control points that define animation progress for this key frame.

The two control points that specify the cubic Bezier curve that defines the progress of the key frame.

Identifies the KeySpline dependency property.

The identifier for the KeySpline dependency property.

Animates from the Point value of the previous key frame to its own Value using splined interpolation.

Initializes a new instance of the SplinePointKeyFrame class.

Gets or sets the two control points that define animation progress for this key frame.

The two control points that specify the cubic Bezier curve that defines the progress of the key frame.

Identifies the KeySpline dependency property.

The identifier for the KeySpline dependency property.

Represents the preconfigured animation that conceals a target UI using a *split* animation.

Initializes a new instance of the SplitCloseThemeAnimation class.

Gets or sets the initial size of the target element in the animation direction.

The initial size of the target in pixels.

Identifies the ClosedLength dependency property.

The identifier for the ClosedLength dependency property.

Gets or sets the UI element that specifies the initial clip size.

The UI element that specifies the initial clip size.

Gets or sets the identifying name of the UI element that specifies the initial clip size.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the ClosedTargetName dependency property.

The identifier for the ClosedTargetName dependency property.

Identifies the ClosedTarget dependency property.

The identifier for the ClosedTarget dependency property.

Gets or sets the UI element that will be translated. Typically this is a child/part of the element identified by OpenedTargetName or OpenedTarget.

The UI element that will be translated.

Gets or sets the identifying name of the UI element that will be translated. Typically this is a child/part of the element identified by OpenedTargetName.

The name of the UI element that will be translated.

Identifies the ContentTargetName dependency property.

The identifier for the ContentTargetName dependency property.

Identifies the ContentTarget dependency property.

The identifier for the ContentTarget dependency property.

Gets or sets a value that determines which direction the content should translate when the animation runs.

A value of the enumeration.

Identifies the ContentTranslationDirection dependency property.

The identifier for the ContentTranslationDirection dependency property.

Gets or sets the pixels to translate by when the animation runs.

A distance in pixels.

Identifies the ContentTranslationOffset dependency property.

The identifier for the ContentTranslationOffset dependency property.

Gets or sets an offset from the center of the *opened* target.

An offset in pixels. The default is 0.

Identifies the OffsetFromCenter dependency property.

The identifier for the OffsetFromCenter dependency property.

Gets or sets the final size of the target UI element.

The final size. If left unset, the value defaults to the size of the opened target.

Identifies the OpenedLength dependency property.

The identifier for the OpenedLength dependency property.

Gets or sets the UI element that will be clipped.

The UI element that will be clipped.

Gets or sets the identifying name of the UI element that will be clipped.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the OpenedTargetName dependency property.

The identifier for the OpenedTargetName dependency property.

Identifies the OpenedTarget dependency property.

The identifier for the OpenedTarget dependency property.

Represents the preconfigured animation that reveals a target UI using a *split* animation.

Initializes a new instance of the SplitOpenThemeAnimation class.

Gets or sets the initial size of the target element in the animation direction.

The initial size of the target in pixels.

Identifies the ClosedLength dependency property.

The identifier for the ClosedLength dependency property.

Gets or sets the UI element that specifies the initial clip size.

The UI element that specifies the initial clip size.

Gets or sets the identifying name of the UI element that specifies the initial clip size.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the ClosedTargetName dependency property.

The identifier for the ClosedTargetName dependency property.

Identifies the ClosedTarget dependency property.

The identifier for the ClosedTarget dependency property.

Gets or sets the UI element that will be translated. Typically this is a child/part of the element identified by OpenedTargetName or OpenedTarget.

The UI element that will be translated.

Gets or sets the identifying name of the UI element that will be translated. Typically this is a child/part of the element identified by OpenedTargetName.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the ContentTargetName dependency property.

The identifier for the ContentTargetName dependency property.

Identifies the ContentTarget dependency property.

The identifier for the ContentTarget dependency property.

Gets or sets a value that determines which direction the content should translate when the animation runs.

A value of the enumeration.

Identifies the ContentTranslationDirection dependency property.

The identifier for the ContentTranslationDirection dependency property.

Gets or sets the pixels to translate by when the animation runs.

A distance in pixels.

Identifies the ContentTranslationOffset dependency property.

The identifier for the ContentTranslationOffset dependency property.

Gets or sets an offset from the center of the *opened* target.

An offset in pixels. The default is 0.

Identifies the OffsetFromCenter dependency property.

The identifier for the OffsetFromCenter dependency property.

Gets or sets the final size of the target UI element.

The final size. If left unset, the value defaults to the size of the opened target.

Identifies the OpenedLength dependency property.

The identifier for the OpenedLength dependency property.

Gets or sets the UI element that will be clipped.

The UI element that will be clipped.

Gets or sets the identifying name of the UI element that will be clipped.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the OpenedTargetName dependency property.

The identifier for the OpenedTargetName dependency property.

Identifies the OpenedTarget dependency property.

The identifier for the OpenedTarget dependency property.

Controls animations with a timeline, and provides object and property targeting information for its child animations.

Initializes a new instance of the Storyboard class.

Gets the collection of child Timeline objects.

The collection of child Timeline objects. The default is an empty collection.

Identifies the Storyboard.TargetName XAML attached property.

The identifier for the Storyboard.TargetName XAML attached property.

Identifies the Storyboard.TargetProperty XAML attached property.

The identifier for the Storyboard.TargetProperty XAML attached property.

Initiates the set of animations associated with the storyboard.

Gets the clock state of the Storyboard.

One of the enumeration values. Can be: **Active**, **Filling**, or **Stopped**.

Gets the current animation clock time of the Storyboard.

The current animation time of the Storyboard per the running animation clock, or **null** if the animation clock is **Stopped**.

Gets the value of the Storyboard.TargetName XAML attached property from a target element.

The target element from which to get the value. The Storyboard.TargetName value of the target element.

Gets the value of the Storyboard.TargetProperty XAML attached property from a target element.

The target element from which to get the value. The Storyboard.TargetProperty value of the target element.

Pauses the animation clock associated with the storyboard.

Resumes the animation clock, or run-time state, associated with the storyboard.

Moves the storyboard to the specified animation position. The storyboard performs the requested seek when the next clock tick occurs.

A positive or negative time value that describes the amount by which the timeline should move forward or backward from the beginning of the animation.

Moves the storyboard to the specified animation position immediately (synchronously).

A positive or negative time value that describes the amount by which the timeline should move forward or backward from the beginning of the animation.

Causes the specified Timeline to target the specified object.

The timeline that targets the specified dependency object. The actual instance of the object to target.

Sets the value of the Storyboard.TargetName XAML attached property for a target element.

The target element to set the value for. The Storyboard.TargetName value of the target element to set. This should correspond to an existing Name or **x:Name** value on the UI element that the animation targets.

Sets the value of the Storyboard.TargetProperty XAML attached property for a target element.

The target element for which to set the value. The Storyboard.TargetProperty value of the target element to set. This specifies a qualification path that targets the dependency property where the animation applies. See Remarks.

Advances the current time of the storyboard's clock to the end of its active period.

Stops the storyboard.

Specifies that animations are suppressed during navigation.

Initializes a new instance of the SuppressNavigationTransitionInfo class.

Represents the preconfigured animation that applies to controls when an element slides back into its layout slot after a **Swipe** interaction.

Initializes a new instance of the SwipeBackThemeAnimation class.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset translation, in pixels.

Identifies the FromHorizontalOffset dependency property.

The identifier for the FromHorizontalOffset dependency property.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Represents the preconfigured animation that indicates that a **Swipe** gesture is now possible.

Initializes a new instance of the SwipeHintThemeAnimation class.

Gets or sets the reference name of the control element being targeted.

The reference name. This is typically the **x:Name** of the relevant element as declared in XAML.

Identifies the TargetName dependency property.

The identifier for the TargetName dependency property.

Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.

The horizontal offset translation, in pixels.

Identifies the ToHorizontalOffset dependency property.

The identifier for the ToHorizontalOffset dependency property.

Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.

The vertical offset, in pixels.

Identifies the ToVerticalOffset dependency property.

The identifier for the ToVerticalOffset dependency property.

Defines a duration and other behavior properties for a Windows Runtime animation. Timeline is the base class for Storyboard and all the Windows Runtime animation types, including those from the animation library and those used for custom animations in visual states or page-level XAML.

Provides base class initialization behavior for Timeline -derived classes.

Gets or sets a value that determines whether dependent animations should be permitted to run, throughout the app.

**true** if animations can run in the app for dependent animation cases. Otherwise, **false**. The default is **true**.

Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration.

**true** if the timeline plays in reverse at the end of each iteration; otherwise, **false**. The default value is **false**.

Identifies the AutoReverse  dependency property.

The identifier for the AutoReverse  dependency property.

Gets or sets the time at which this Timeline should begin.

The start time of the time line. The default value is zero.

Identifies the BeginTime  dependency property.

The identifier for the BeginTime  dependency property.

Gets or sets the length of time for which this timeline plays, not counting repetitions.

The timeline's simple duration: the amount of time this timeline takes to complete a single forward iteration. The default value is a Duration that evaluates as Automatic.

Identifies the Duration  dependency property.

The identifier for the Duration  dependency property.

Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period.

A value that specifies how the timeline behaves after it reaches the end of its active period but its parent is inside its active or fill period. The default value is **HoldEnd**.

Identifies the FillBehavior  dependency property.

The identifier for the FillBehavior  dependency property.

Gets or sets the repeating behavior of this timeline.

An iteration **Count** that specifies the number of times the timeline should play, a **TimeSpan** value that specifies the total length of this timeline's active period, or the special value **Forever**, which specifies that the timeline should repeat indefinitely. The default value is a RepeatBehavior with a **Count** value of 1, which indicates that the timeline plays once.

Identifies the RepeatBehavior  dependency property.

The identifier for the RepeatBehavior  dependency property.

Gets or sets the rate, relative to its parent, at which time progresses for this Timeline.

A finite value greater than 0 that specifies the rate at which time progresses for this timeline, relative to the speed of the timeline's parent. If this timeline is a root timeline, specifies the default timeline speed. The value is expressed as a factor where 1 represents normal speed, 2 is double speed, 0.5 is half speed, and so on. The default value is 1.

Identifies for the SpeedRatio  dependency property.

The identifier for the SpeedRatio  dependency property.

Occurs when the Storyboard object has completed playing.

Represents a collection of Timeline objects (specific type animations). A TimelineCollection is the value of the Storyboard.Children property.

Initializes a new instance of the TimelineCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the Timeline located at the specified index.

The integer index for the value to retrieve. The Timeline value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Timeline value specified.

The index at which to set the value. The value to set.

Represents a visual behavior that occurs for predefined actions or state changes. Specific theme transitions (various Transition derived classes) can be applied to individual elements using the UIElement.Transitions property, or applied for scenario-specific theme transition properties such as ContentControl.ContentTransitions.

Represents a collection of Transition objects. Each Transition object represents a different theme transition, part of the Windows Runtime animation library.

Initializes a new instance of the TransitionCollection class.

Gets the size (count) of the collection.

The count of items in the collection.

Adds a new item to the collection.

The new item to add.

Removes all items from the collection.

Returns the iterator for iteration over the items in the collection.

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Returns the item located at the specified index.

The integer index for the value to retrieve. The Transition value at the specified index.

Retrieves multiple elements in a single pass through the iterator.

The index from which to start retrieval. Provides the destination for the result. Size the initial array size as a *capacity* in order to specify how many results should be retrieved. The number of items retrieved.

Gets an immutable view into the collection.

An object representing the immutable collection view.

Retrieves the index of the specified item.

The value to find in the collection. The index of the item to find, if found. **true** if an item with the specified value was found; otherwise, **false**.

Inserts the specified item at the specified index.

The index at which to set the value. The value to set.

Removes the item at the specified index.

The index position of the item to remove.

Removes the last item in the collection.

Initially clears the collection, then inserts the provided array as new items.

The new collection items.

Sets the value at the specified index to the Transition value specified.

The index at which to set the value. The value to set.

Specifies initialization options for a bitmap image.

Loads images without using an existing image cache. This option should be selected only when images in a cache need to be refreshed.

No options are specified.

Provides the practical object source type for the Image.Source and ImageBrush.ImageSource properties. You can define a BitmapImage by using a Uniform Resource Identifier (URI) that references an image source file, or by calling SetSourceAsync and supplying a stream.

Initializes a new instance of the BitmapImage class.

Initializes a new instance of the BitmapImage class, using the supplied Uniform Resource Identifier (URI).

A reference to the image source file.

Gets or sets a value that indicates whether an animated image should play as soon as it loads.

**true** if an animated image should play as soon as it loads; otherwise, **false**. The default is **true**.

Identifies the AutoPlay dependency property.

The identifier for the AutoPlay dependency property.

Gets or sets the BitmapCreateOptions for a BitmapImage.

The BitmapCreateOptions used for this BitmapImage. The default is **None**. With this default, a BitmapImage uses cached content when it is available. For a BitmapImage that is created by referencing an image source file by Uniform Resource Identifier (URI), the Uniform Resource Identifier (URI) controls the internal caching scheme.

Identifies the CreateOptions dependency property.

The identifier for the CreateOptions dependency property.

Gets or sets the height to use for image decoding operations.

The height (in pixels) to use for image decoding operations.

Identifies the DecodePixelHeight dependency property.

The identifier for the DecodePixelHeight dependency property.

Gets or sets a value that determines how DecodePixelWidth and DecodePixelHeight values are interpreted for decoding operations.

A value of the enumeration. The default is **Physical**.

Identifies the DecodePixelType dependency property.

The identifier for the DecodePixelType dependency property.

Gets or sets the width to use for image decoding operations.

The width (in pixels) to use for image decoding operations.

Identifies the DecodePixelWidth dependency property.

The identifier for the DecodePixelWidth dependency property.

Gets a value that indicates whether an image is animated.

**true** if the image is animated; otherwise, **false**.

Identifies the IsAnimatedBitmap dependency property.

The identifier for the IsAnimatedBitmap dependency property.

Gets a value that indicates whether an animated image is playing.

**true** if the animated image is playing; otherwise, **false**.

Identifies the IsPlaying dependency property.

The identifier for the IsPlaying dependency property.

Gets or sets the Uniform Resource Identifier (URI) of the graphics source file that generated this BitmapImage.

An object describing the Uniform Resource Identifier (URI) of the graphics source file that generated this BitmapImage.

Identifies the UriSource dependency property.

The identifier for the UriSource dependency property.

Occurs when a significant change has occurred in the download progress of the BitmapImage content.

Occurs when there is an error associated with image retrieval or format.

Occurs when the image source is downloaded and decoded with no failure. You can use this event to determine the size of an image before rendering it.

Starts the animation of an animated image.

Ends the animation of an animated image.

Provides a source object for properties that use a bitmap-format image source.

Provides base class initialization behavior for BitmapSource -derived classes.

Gets the height of the bitmap in pixels.

The height of the bitmap in pixels.

Identifies the PixelHeight dependency property.

The identifier for the PixelHeight dependency property.

Gets the width of the bitmap in pixels.

The width of the bitmap in pixels.

Identifies the PixelWidth dependency property.

The identifier for the PixelWidth dependency property.

Sets the source image for a BitmapSource by accessing a stream. Most callers should use SetSourceAsync instead.

The stream source that sets the image source value.

Sets the source image for a BitmapSource by accessing a stream and processing the result asynchronously.

The stream source that sets the image source value. An asynchronous handler called when the operation is complete.

Provides values that can be used for decoding operations to optimize for logical versus physical pixels in the source image file.

Use a logical pixel value.

Use a physical pixel value.

Provides event data for the DownloadProgress event.

Gets download progress as a value that is between 0 and 100.

The download progress. A value of 0 indicates no progress; 100 indicates that the download is complete.

Represents the method that will handle the DownloadProgress event.

The object where the handler is attached. Event data for the event.

Represents an image source that can be populated with the combined contents of a XAML visual tree. See for some notable limitations on which XAML visuals can be captured in a RenderTargetBitmap.

Initializes a new instance of the RenderTargetBitmap class.

Gets the height of the rendered bitmap in pixels.

The height of the rendered bitmap in pixels.

Identifies the PixelHeight dependency property.

The identifier for the PixelHeight dependency property.

Gets the width of the rendered bitmap in pixels.

The width of the rendered bitmap in pixels.

Identifies the PixelWidth dependency property.

The identifier for the PixelWidth dependency property.

Retrieves the previously rendered RenderTargetBitmap image as a buffered stream of bytes in **BGRA8** format.

When this method returns, an IBuffer stream that contains bytes. This is the binary data for the image and can be converted to a byte array in **BGRA8** format

Renders a snapshot of a UIElement visual tree to an image source.

A UIElement that represents the visual tree fragment to render. When this method returns, an IAsyncAction object that can be used to control the asynchronous operation.

Renders a snapshot of a UIElement visual tree to an image source. Specify values for *scaledWidth* and *scaledHeight* to alter the original source's rendering dimension.

A UIElement that represents the visual tree fragment to render. Specifies the target width at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. Specifies the target height at which to render. The default is 0. *scaledWidth* and/or *scaledHeight* can be optional; see Remarks. When this method returns, an IAsyncAction object that can be used to control the asynchronous operation.

Provides a source object, backed by a SoftwareBitmap, for properties that use a bitmap-format image source.

Initializes a new instance of the SoftwareBitmapSource class.

Disposes of the object and associated resources.

Sets the source SoftwareBitmap to be used as an image source.

The SoftwareBitmap to be used as an image source. An asynchronous action.

Provides Microsoft DirectX shared surfaces to draw into and then composes the bits into app content.

Initializes a new instance of the SurfaceImageSource class, specifying the size of the drawing area.

Width of the drawing area in pixels. Height of the drawing area in pixels.

Initializes a new instance of the SurfaceImageSource class, specifying the size of the drawing area, and whether opacity is expected to be always full opacity. Use this with `isOpaque=true` if SurfaceImageSource should not support transparency; this can increase performance.

Width of the drawing area in pixels. Height of the drawing area in pixels. **true** if the area should render opaque. **false** to render with possible alpha transparency. A value of **true** can provide a performance benefit if the content is not transparent.

Provides a source object for properties that use a Scalable Vector Graphics (SVG) source. You can define a SvgImageSource by using a Uniform Resource Identifier (URI) that references a SVG file, or by calling SetSourceAsync(IRandomAccessStream) and supplying a stream.

Initializes a new instance of the SvgImageSource class.

Initializes a new instance of the SvgImageSource class, using the supplied Uniform Resource Identifier (URI).

A reference to the SVG source file.

Gets or sets the height to use for SVG rasterization operations.

The height (in logical pixels) to use for SVG decoding operations. The default is **Double.NaN**.

Identifies the **RasterizePixelHeight** dependency property.

The identifier for the **RasterizePixelHeight** dependency property.

Gets or sets the width to use for SVG rasterization operations.

The width (in logical pixels) to use for SVG decoding operations. The default is **Double.NaN**.

Identifies the **RasterizePixelWidth** dependency property.

The identifier for the **RasterizePixelWidth** dependency property.

Gets or sets the Uniform Resource Identifier (URI) of the SVG source file that generated this SvgImageSource.

An object describing the Uniform Resource Identifier (URI) of the SVG source file that generated this SvgImageSource.

Identifies the **UriSource** dependency property.

The identifier for the **UriSource** dependency property.

Occurs when the SVG source is downloaded and decoded with no failure.

Occurs when there is an error associated with SVG retrieval or format.

Sets the source SVG for a SvgImageSource by accessing a stream and processing the result asynchronously.

The stream source that sets the SVG source value. A SvgImageSourceLoadStatus value that indicates whether the operation was successful. If it failed, indicates the reason for the failure.

Provides event data for the SvgImageSource.OpenFailed event.

Gets a value that indicates the reason for the SVG loading failure.

A value of the enumeration.

Defines constants that specify the result of loading an SvgImageSource.

The SVG did not load because the SVG format is invalid.

The SVG did not load due to a network error.

The SVG did not load for some other reason.

The SVG loaded.

Provides event data for the SvgImageSource.Opened event.

Extends SurfaceImageSource to support scenarios when the content is potentially larger than what can fit on screen and the content must be virtualized to render optimally.

Initializes a new instance of the VirtualSurfaceImageSource class, specifying the size of the drawing area.

Width of the drawing area in pixels. Height of the drawing area in pixels.

Initializes a new instance of the VirtualSurfaceImageSource class, specifying the size of the drawing area and a preference for whether to render with an alpha transparency.

Width of the drawing area in pixels. Height of the drawing area in pixels. **true** if the area should render opaque. **false** to render with possible alpha transparency.

Provides a BitmapSource that can be written to and updated.

Initializes a new instance of the WriteableBitmap class.

The width of the bitmap in pixels. The height of the bitmap in pixels.

Gets an access for the direct buffer where each pixel of the WriteableBitmap is written to.

A reference to the pixel buffer.

Requests a draw or redraw of the entire bitmap.

Provides the ability to create a bitmap from a XAML tree in a background task.

Initializes a new instance of the XamlRenderingBackgroundTask class.

Performs the work of the background task. The system calls this method when the associated background task has been triggered.

An interface to an instance of the background task. The system creates this instance when the task has been triggered to run.

Represents 3-D scale, rotation, and translate transforms to be applied to an element.

Initializes a new instance of the CompositeTransform3D class.

Gets the x-coordinate of the center point in pixels for all transforms specified by the CompositeTransform3D.

The x-coordinate of the center point for all transforms specified by the CompositeTransform3D. The default value is 0.

Identifies the CenterX dependency property.

The CenterX dependency property identifier.

Gets the y-coordinate of the center point in pixels for all transforms specified by the CompositeTransform3D.

The y-coordinate of the center point for all transforms specified by the CompositeTransform3D. The default value is 0.

Identifies the CenterY dependency property.

The CenterY dependency property identifier.

Gets the z-coordinate of the center point in pixels for all transforms specified by the CompositeTransform3D.

The z-coordinate of the center point for all transforms specified by the CompositeTransform3D. The default value is 0.

Identifies the CenterZ dependency property.

The CenterZ dependency property identifier.

Gets or sets the angle in degrees of counterclockwise rotation around the x-axis.

The angle of rotation around the x-axis, given in degrees in a counterclockwise direction. The default value is 0 degrees.

Identifies the RotationX dependency property.

The RotationX dependency property identifier.

Gets or sets the angle in degrees of counterclockwise rotation around the y-axis.

The angle of rotation around the y-axis, given in degrees in a counterclockwise direction. The default value is 0 degrees.

Identifies the RotationY dependency property.

The RotationY dependency property identifier.

Gets or sets the angle in degrees of counterclockwise rotation around the z-axis.

The angle of rotation around the z-axis, given in degrees in a counterclockwise direction. The default value is 0 degrees.

Identifies the RotationZ dependency property.

The RotationZ dependency property identifier.

Gets or sets the x-axis scale factor. You can use this property to stretch or shrink an object along this axis.

The scale factor along the x-axis. The default is 1.

Identifies the ScaleX dependency property.

The ScaleX dependency property identifier.

Gets or sets the y-axis scale factor. You can use this property to stretch or shrink an object along this axis.

The scale factor along the y-axis. The default is 1.

Identifies the ScaleY dependency property.

The ScaleY dependency property identifier.

Gets or sets the z-axis scale factor. You can use this property to stretch or shrink an object along this axis.

The scale factor along the z-axis. The default is 1.

Identifies the ScaleZ dependency property.

The ScaleZ dependency property identifier.

Gets or sets the distance to translate along the x-axis in pixels.

The distance to translate (move) an object along the x-axis, in pixels. The default value is 0.

Identifies the TranslateX dependency property.

The TranslateX dependency property identifier.

Gets or sets the distance to translate along the y-axis in pixels.

The distance to translate (move) an object along the y-axis, in pixels. The default value is 0.

Identifies the TranslateY dependency property.

The TranslateY dependency property identifier.

Gets or sets the distance to translate along the z-axis in pixels.

The distance to translate (move) an object along the z-axis, in pixels. The default value is 0.

Identifies the TranslateZ dependency property.

The TranslateZ dependency property identifier.

Represents a 4 × 4 matrix that is used for transformations in a 3-D space. Used as a value for Matrix3DProjection.ProjectionMatrix.

The value of the first row and first column of this Matrix3D.

The value of the first row and second column of this Matrix3D.

The value of the first row and third column of this Matrix3D.

The value of the first row and fourth column of this Matrix3D.

The value of the second row and first column of this Matrix3D.

The value of the second row and second column of this Matrix3D.

The value of the second row and third column of this Matrix3D.

The value of the second row and fourth column of this Matrix3D.

The value of the third row and first column of this Matrix3D.

The value of the third row and second column of this Matrix3D.

The value of the third row and third column of this Matrix3D.

The value of the third row and fourth column of this Matrix3D.

The value of the fourth row and fourth column of this Matrix3D.

The value of the fourth row and first column of this Matrix3D.

The value of the fourth row and second column of this Matrix3D.

The value of the fourth row and third column of this Matrix3D.

Provides static utilities for Matrix3D. C# and Microsoft Visual Basic code should use members of Matrix3D instead.

Gets a static constructed Matrix3D where the values established are representative of an **Identity** transform. C# and Microsoft Visual Basic code should use Identity instead.

A static constructed Matrix3D where the values established are representative of an **Identity** transform.

Defines a new Matrix3D value, using element values for each of the possible values of a Matrix3D structure. C# and Microsoft Visual Basic code should use Matrix3D constructor instead.

The value to set for **M11** of the Matrix3D. The value to set for **M12** of the Matrix3D.. The value to set for **M13** of the Matrix3D. The value to set for **M14** of the Matrix3D. The value to set for **M21** of the Matrix3D. The value to set for **M22** of the Matrix3D. The value to set for **M23** of the Matrix3D. The value to set for **M24** of the Matrix3D. The value to set for **M31** of the Matrix3D. The value to set for **M32** of the Matrix3D. The value to set for **M33** of the Matrix3D. The value to set for **M34** of the Matrix3D. The value to set for **OffsetX** (row 4, column 1) of the Matrix3D. The value to set for **OffsetY** (row 4, column 2) of the Matrix3D. The value to set for **OffsetZ** (row 4, column 3) of the Matrix3D. The value to set for **M44** of the Matrix3D. The created Matrix3D.

Returns whether the provided Matrix3D is invertible. C# and Microsoft Visual Basic code should use HasInverse instead.

The target Matrix3D to evaluate. **true** if the Matrix3D has an inverse; otherwise, **false**.

Returns whether the provided Matrix3D represents an **Identity** transform. C# and Microsoft Visual Basic code should use IsIdentity instead.

The target Matrix3D to evaluate. **true** if the Matrix3D represents an **Identity** transform; otherwise, **false**.

Returns a potentially new Matrix3D value that represents the inversion of the provided Matrix3D. C# and Microsoft Visual Basic code should use Invert instead.

The target Matrix3D to evaluate. The inversion result Matrix3D.

Multiplies the specified matrices. C# and Microsoft Visual Basic code should use the multiplication operator instead.

The first matrix to multiply. The second matrix to multiply. A new Matrix3D that is the result of multiplication.

Represents a 3-D perspective effect.

Initializes a new instance of the PerspectiveTransform3D class.

Gets or sets the distance in pixels to the plane where z=0.

The distance to the z=0 plane. This value must be greater than zero. The default value is 1000.

Identifies the Depth dependency property.

The Depth dependency property identifier.

Gets or sets the x-offset in pixels for the perspective's origin from the center of the element.

The x-offset of the perspective's origin from the center of the element. This distance is measured in pixels and the default value is 0.

Identifies the OffsetX dependency property.

The OffsetX dependency property identifier.

Gets or sets the y-offset in pixels for the perspective's origin from the center of the element.

The y-offset of the perspective's origin from the center of the element. This distance is measured in pixels and the default value is 0.

Identifies the OffsetY dependency property.

The OffsetY dependency property identifier.

The base class for the CompositeTransform3D and PerspectiveTransform3D classes.

Initializes a new instance of the Transform3D class.

Represents options for a frame navigation, including whether it is recorded in the navigation stack and what transition animation is used.

Initializes a new instance of the FrameNavigationOptions class.

Gets or sets a value that indicates whether navigation is recorded in the Frame's ForwardStack or BackStack.

**true** if navigation is recorded in the Frame's ForwardStack or BackStack; otherwise, **false**. The default is **true**.

Gets or sets a value that indicates the animated transition associated with the navigation.

Info about the animated transition.

Represents the method that will handle the LoadCompleted event.

The source of the event. The event data.

Represents the method that will handle the Navigated event.

The object where the handler is attached. Event data for the event.

Provides data for the OnNavigatingFrom callback that can be used to cancel a navigation request from origination.

Specifies whether a pending navigation should be canceled.

**true** to cancel the pending cancelable navigation; **false** to continue with navigation.

Gets the value of the *mode* parameter from the originating Navigate call.

The value of the *mode* parameter from the originating Navigate call.

Gets a value that indicates the animated transition associated with the navigation.

Info about the animated transition.

Gets the navigation parameter associated with this navigation.

The navigation parameter.

Gets the value of the *SourcePageType* parameter from the originating Navigate call.

The value of the *SourcePageType* parameter from the originating Navigate call, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

Represents the method to use as the OnNavigatingFrom callback override.

The object where the method is implemented. Event data that is passed through the callback.

Specifies caching characteristics for a page involved in a navigation.

The page is never cached and a new instance of the page is created on each visit.

The page is cached, but the cached instance is discarded when the size of the cache for the frame is exceeded.

The page is cached and the cached instance is reused for every visit regardless of the cache size for the frame.

Provides data for navigation methods and event handlers that cannot cancel the navigation request.

Gets the root node of the target page's content.

The root node of the target page's content.

Gets a value that indicates the direction of movement during navigation

A value of the enumeration.

Gets a value that indicates the animated transition associated with the navigation.

Info about the animated transition.

Gets any "Parameter" object passed to the target page for the navigation.

An object that potentially passes parameters to the navigation target. May be null.

Gets the data type of the source page.

The data type of the source page, represented as *namespace*.*type* or simply *type*.

Gets the Uniform Resource Identifier (URI) of the target.

A value that represents the Uniform Resource Identifier (URI).

Provides event data for the WebView.NavigationFailed and Frame.NavigationFailed events.

Gets the result code for the exception that is associated with the failed navigation.

A system exception result code.

Gets or sets a value that indicates whether the failure event has been handled.

**true** if the failure event is handled; **false** if the failure event is not yet handled.

Gets the data type of the target page.

The data type of the target page, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

Represents a method that will handle the WebView.NavigationFailed and Frame.NavigationFailed events.

The object where the handler is attached. Event data for the event.

Specifies the navigation stack characteristics of a navigation.

Navigation is going backward in the stack.

Navigation is going forward in the stack.

Navigation is to a new instance of a page (not going forward or backward in the stack).

Navigation is to the current page (perhaps with different data).

Provides event data for the NavigationStopped event.

The object where the handler is attached. Event data for the event.

Represents an entry in the BackStack or ForwardStack of a Frame.

Initializes a new instance of the PageStackEntry class.

The type of page associated with the navigation entry, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)). The navigation parameter associated with the navigation entry. Info about the animated transition associated with the navigation entry.

Gets a value that indicates the animated transition associated with the navigation entry.

Info about the animated transition.

Gets the navigation parameter associated with this navigation entry.

The navigation parameter.

Gets the type of page associated with this navigation entry.

The page type of the navigation entry, as a type reference (System.Type for Microsoft .NET, a TypeName helper struct for Visual C++ component extensions (C++/CX)).

Identifies the SourcePageType dependency property.

The identifier for the SourcePageType dependency property.

Provides event data for the AddPages event.

Initializes a new instance of the AddPagesEventArgs class.

Gets the PrintTaskOptions for the pages added.

An object that manages the options for print tasks.

Represents the method that will handle the AddPages event.

The object where the handler is attached. Event data for the event.

Provides event data for the GetPreviewPage event.

Initializes a new instance of the GetPreviewPageEventArgs class.

Gets the page number of the potentially repaginated page involved in the preview.

The page number of the potentially repaginated page.

Represents the method that will handle the GetPreviewPage event.

The object where the handler is attached. Event data for the event.

Provides event data for the Paginate event.

Initializes a new instance of the PaginateEventArgs class.

Gets the 1-based page number of the current preview page.

The page number.

Gets the PrintTaskOptions for the pages involved in the event occurrence.

An object that manages the options for print tasks.

Represents the method that will handle the Paginate event.

The object where the handler is attached. Event data for the event.

Describes the basis of the page count.

Page count is based on final print job total.

Page count is based on an intermediate total.

Defines a reusable object that sends output to a printer.

Initializes a new instance of the PrintDocument class.

Gets a document source reference for this PrintDocument.

An object representing the document source.

Identifies the DocumentSource dependency property.

The identifier for the DocumentSource dependency property.

Occurs when the PrintManager requests the final collection of pages to send to the printer.

Occurs when the PrintManager requests a particular print page to be shown in the preview window.

Occurs when the PrintManager requests the collection of print pages to be shown in the preview window.

Adds a XAML root visual element to the print list.

The root visual element of the page to add to the print list.

Indicates that the application will not add more pages to the print list, and that the print list is ready to be released.

References the low-level print preview dialog API and invalidates the current print preview.

Sets the specified print page as the current print preview page.

The sequence number of the page to preview. The root visual object for the requested print page.

Sets the number of pages prepared for print preview and added to the print list.

The number of pages included in the preview. A value of the enumeration that specifies how to determine the page count.

Enables loading of custom resource dictionaries as sources. Override GetResource to provide the logic that a XAML parser can use to look up the necessary resources at load time.

Initializes a new instance of the CustomXamlResourceLoader class.

Returns the active CustomXamlResourceLoader instance.

The active CustomXamlResourceLoader instance.

When overridden in a derived class, specifies the logic of resource lookup for this CustomXamlResourceLoader. Given a resource ID and some type information about the expected result, returns the requested resource.

The string-form key of the resource to get. The expected type of the resource. The name of the property that serves as the key in the custom resource lookup logic. The type of the property that serves as the key, with type represented as a string. The retrieved resource.

Draws an ellipse with a given Height and Width specified in device-independent pixel (DIP).

Initializes a new instance of the Ellipse class.

Draws a straight line between two points.

Initializes a new instance of the Line class.

Gets or sets the x-coordinate of the Line start point.

The x-coordinate for the start point of the line, in pixels. The default is 0.

Identifies the X1 dependency property.

The identifier for the X1 dependency property.

Gets or sets the x-coordinate of the Line end point.

The x-coordinate for the end point of the line, in pixels. The default is 0.

Identifies the X2 dependency property.

The identifier for the X2 dependency property.

Gets or sets the y-coordinate of the Line start point.

The y-coordinate for the start point of the line, in pixels. The default is 0.

Identifies the Y1 dependency property.

The identifier for the Y1 dependency property.

Gets or sets the y-coordinate of the Line end point.

The y-coordinate for the end point of the line, in pixels. The default is 0.

Identifies the Y2 dependency property.

The identifier for the Y2 dependency property.

Draws a series of connected lines and curves. The line and curve dimensions are declared through the Data property, and can be specified either with Move and draw commands syntax, or with an object model.

Initializes a new instance of the Path class.

Gets or sets a Geometry that specifies the shape to be drawn.

A description of the shape to be drawn.

Identifies the Data dependency property.

The identifier for the Data dependency property.

Draws a polygon, which is a connected series of lines that form a closed shape.

Initializes a new instance of the Polygon class.

Gets or sets a value that specifies how the interior fill of the shape is determined.

A value of the enumeration. The default is **EvenOdd**.

Identifies the FillRule dependency property.

The identifier for the FillRule dependency property.

Gets or sets a collection that contains the vertex points of the polygon.

A collection of Point structures that describes the vertex points of the polygon. The default is null. The value can be expressed as a string for XAML or type conversion.

Identifies the Points dependency property.

The identifier for the Points dependency property.

Draws a series of connected straight lines.

Initializes a new instance of the Polyline class.

Gets or sets a value that specifies how the interior fill of the shape is determined.

A value of the enumeration that specifies the fill behavior. The default is **EvenOdd**.

Identifies the FillRule dependency property.

The identifier for the FillRule dependency property.

Gets or sets a collection that contains the vertex points of the Polyline.

A collection of Point structures that describes the vertex points of the Polyline. The default is null.

Identifies the Points dependency property.

The identifier for the Points dependency property.

Draws a rectangle with a given Height and Width specified in device-independent pixel (DIP).

Initializes a new instance of the Rectangle class.

Gets or sets the x-axis radius of the ellipse that is used to round the corners of the rectangle.

The x-axis radius of the ellipse that is used to round the corners of the rectangle.

Identifies the RadiusX dependency property.

The identifier for the RadiusX dependency property.

Gets or sets the y-axis radius of the ellipse that is used to round the corners of the rectangle.

The y-axis radius of the ellipse that is used to round the corners of the rectangle. The default is 0.

Identifies the RadiusY dependency property.

The identifier for the RadiusY dependency property.

Provides a base class for shape elements, such as Ellipse, Polygon, and Rectangle.

Provides base class initialization behavior for Shape derived classes.

Gets or sets the Brush that paints the interior area of the shape.

A Brush that paints/fills the shape interior. The default is **null**, (a null brush) which is evaluated as Transparent for rendering.

Identifies the Fill dependency property.

The identifier for the Fill dependency property.

Gets a value that represents a Transform that is applied to the geometry of a Shape before it is drawn.

A Transform that is applied to the geometry of a Shape before it is drawn.

Gets or sets a Stretch enumeration value that describes how the shape fills its allocated space.

One of the Stretch enumeration values. The default value at run time depends on the type of Shape.

Identifies the Stretch dependency property.

The identifier for the Stretch dependency property.

Gets or sets the Brush that specifies how the Shape outline is painted.

A Brush that specifies how the Shape outline is painted. The default is null.

Gets or sets a collection of Double values that indicates the pattern of dashes and gaps that is used to outline shapes.

A collection of Double values that specifies the pattern of dashes and gaps.

Identifies the StrokeDashArray dependency property.

The identifier for the StrokeDashArray dependency property.

Gets or sets a PenLineCap enumeration value that specifies how the ends of a dash are drawn.

One of the enumeration values for PenLineCap. The default is **Flat**.

Identifies the StrokeDashCap dependency property.

The identifier for the StrokeDashCap dependency property.

Gets or sets a value that specifies the distance within the dash pattern where a dash begins.

A value that represents the distance within the dash pattern where a dash begins. The default value is 0.

Identifies the StrokeDashOffset dependency property.

The identifier for the StrokeDashOffset dependency property.

Gets or sets a PenLineCap enumeration value that describes the Shape at the end of a line.

One of the enumeration values for PenLineCap. The default is **Flat**.

Identifies the StrokeEndLineCap dependency property.

The identifier for the StrokeEndLineCap dependency property.

Gets or sets a PenLineJoin enumeration value that specifies the type of join that is used at the vertices of a Shape.

A value of the PenLineJoin enumeration that specifies the join appearance. The default value is **Miter**.

Identifies the StrokeLineJoin dependency property.

The identifier for the StrokeLineJoin dependency property.

Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of a Shape element.

The limit on the ratio of the miter length to the StrokeThickness of a Shape element. This value is always a positive number that is greater than or equal to 1.

Identifies the StrokeMiterLimit dependency property.

The identifier for the StrokeMiterLimit dependency property.

Identifies the Stroke dependency property.

The identifier for the Stroke dependency property.

Gets or sets a PenLineCap enumeration value that describes the Shape at the start of a Stroke.

A value of the PenLineCap enumeration that specifies the shape at the start of a Stroke. The default is **Flat**.

Identifies the StrokeStartLineCap dependency property.

The identifier for the StrokeStartLineCap dependency property.

Gets or sets the width of the Shape stroke outline.

The width of the Shape outline, in pixels. The default value is 0.

Identifies the StrokeThickness dependency property.

The identifier for the StrokeThickness dependency property.

Returns a mask that represents the alpha channel of a XAML shape as a CompositionBrush.

A mask that represents the alpha channel of a XAML shape.

Provides a method to translate a URI to a content stream for use by the WebView.NavigateToLocalStreamUri method.

Translates a URI to a content stream for use by the WebView.NavigateToLocalStreamUri method.

The URI to translate. When this method returns, the content stream.

Provides error status resulting from a web service operation.

Gets a WebErrorStatus value based on an error encountered by a web service operation.

The error encountered by a web service operation represented as an **hResult**. The error status value for a web service operation.

Defines errors encountered during operations involving web services, such as authentication, proxy configuration, and destination URIs.

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

The request cannot be fulfilled due to bad syntax.

Cannot connect to destination.

The SSL certificate common name does not match the web address.

The SSL certificate contains errors.

The SSL certificate has expired.

The SSL certificate is invalid.

The SSL certificate has been revoked.

Indicates that the request could not be processed because of conflict in the request.

The connection was aborted.

The connection was reset.

The connection was ended.

The server returned an invalid or unrecognized response.

The server cannot meet the requirements of the Expect request-header field.

The server has refused the request.

The resource was found but is available in a location different from the one included in the request.

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

Indicates that the resource requested is no longer available and will not be available again.

Could not resolve provided host name.

Redirected from a secure location to an unsecure location.

Redirected from a location to a secure location.

The server does not support the HTTP protocol version used in the request.

The request does not support the range.

A generic error message, given when no more specific message is suitable.

The request did not specify the length of its content, which is required by the requested resource.

A request was made of a resource using a request method not supported by that resource.

The request is mising the file size.

This and all future requests should be directed to the given URI.

The requested URL represents a high level grouping of which lower level selections need to be made.

The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.

The requested resource could not be found but may be available again in the future.

The server either does not recognize the request method, or it lacks the ability to fulfill the request.

Indicates the resource has not been modified since last requested.

The operation was canceled.

Reserved.

The server does not meet one of the preconditions that the requester put on the request.

The client must first authenticate itself with the proxy.

The request redirect failed.

The client has asked for a portion of the file, but the server cannot supply that portion.

The request is larger than the server is willing or able to process.

The server timed out waiting for the request.

Provided URI length exceeds the maximum length the server can process.

The response to the request can be found under another URI using a GET method.

The server is not responding.

The server is currently unavailable.

The requested resource resides temporarily under a different URI.

The connection has timed out.

Authentication has failed or credentials have not yet been provided.

An unexpected client-side error has occurred.

A request was unexpectedly redirected.

An unexpected server-side error has occurred.

An unexpected status code indicating a failure was received.

An unknown error has occurred.

The request entity has a media type which the server or resource does not support.

The requested resource must be accessed through the proxy given by the Location field.

Encapsulates the methods needed to implement the AtomPub protocol which enables HTTP CRUD access to Web resources using the Atom 1.0 wire format.

Creates a new AtomPubClient object.

Creates a new AtomPubClient object with the credential to use when making requests to the server. Initially, a 'username/password' tuple. However, for domain credentials, the username must be in 'domain\user form'.

The specified security credentials.

Gets or sets a **Boolean** value that specifies whether to bypass the cache when retrieving the feed.

**TRUE** if the cache should be bypassed; otherwise **FALSE**.

Gets or sets the maximum number of bytes to buffer when receiving a response from a server.

Maximum size and default is **UInt32.MaxValue**.

Gets or sets the credentials to use when making requests via a proxy.

The PasswordCredential to use.

Gets or sets the credentials to use when making requests to the server.

Initially, this value is a username/password tuple. For domain credentials, the username is in domain\user form.

Gets or sets the maximum amount of time, in milliseconds, to wait for any of the asynchronous operations to complete. If the operation is not complete within this amount of time, it will fail with a status code indicating that it timed out.

Default value is 30000 (30 seconds). A value of **UInt32.MaxValue** indicates that the syndication client will wait indefinitely for a response.

Cancels any in-progress asynchronous operations, causing them to fail (asynchronously) with an error code indicating cancellation.

Creates a new media resource in the specified collection.

The Uniform Resource Identifier (URI) of the specified collection in which the new resource should be created. The type for the media resource. The description of the new resource that is turned into the Slug: header of the POST request. Specifies the IInputStream to use as the media resource. The object that is used to create the resource asynchronously and to report the progress and completion status of the operation.

Creates a new Entry resource in the specified collection. The Uri of the collection in which to create the new resource can be discovered from the ResourceCollection object retrieved from the RetrieveResourceAsync method.

The Uri of the specified collection in which the new resource should be created. The description of the new resource that is turned into the Slug: header of the POST request. The new resource to be created. The object that is used to create the resource asynchronously and to report the progress and completion status of the operation.

Deletes an existing Entry or Media Link resource.

The Uri of the resource to be deleted. The object that is used to delete the resource asynchronously and to report the progress and completion status of the operation.

Deletes an existing Entry or Media Link resource. This differs from the DeleteResourceAsync method in that the SyndicationItem object that represents the resource to be deleted is specified instead of the Uri. The DeleteResourceItemAsync method uses the property of the specified SyndicationItem as the Uri of the resource to be deleted.

The resource to be deleted. The object that is used to delete the resource asynchronously and to report the progress and completion status of the operation.

Starts an asynchronous operation to download the syndication feed from the given URI. This method instantiates a SyndicationFeed object from the feed string, which can be in one of the formats specified in SyndicationFormat.

The URI from which the feed is downloaded. Contains the results of the operation.

Retrieves a media link resource from the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) for the media resource. The object used to retrieve the media resource and report the progress and completion status of the operation.

Retrieves an Entry resource or Media Link resource from the specified Uniform Resource Identifier (URI).

The specified Uniform Resource Identifier (URI). The object that is used to retrieve the resource asynchronously and to report the progress and completion status of the operation.

Retrieves a service document from the specified Uri.

The specified Uri. The object that is used to retrieve the service document asynchronously and to report the progress and completion status of the operation.

Sets an HTTP header for the request. This method can be called multiple times to set multiple headers. When the same header is set multiple times, the values will be concatenated and separated by ",".

The name of the header. The value of the header.

Updates a media link resource from the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) of the resource to be updated. The media type of the resource. The IInputStream of the media that is updating the media resource. Completion status or error codes.

Updates an existing Entry or Media Link resource. If an ETag: header has previously been seen while retrieving this resource (in a response to RetrieveResourceAsync, CreateResourceAsync or a previous call to UpdateResourceAsync), this method automatically sends an If-Match: header with the remembered value.

The Uniform Resource Identifier (URI) of the resource to be updated. The resource to be updated. The object that is used to update the resource asynchronously and to report the progress and completion status of the operation.

Updates an existing Entry or Media Link resource. This differs from the UpdateResourceAsync method in that the EditUri property of the specified SyndicationItem object is used as the Uri of the resource to be updated.

The resource to be updated. The object that is used to update the resource asynchronously and to report the progress and completion status of the operation.

Encapsulates one or more collections within a workspace.

Gets or sets the collection of **app:accept** elements.

The collection of accept elements.

Gets the list of attributes of the element.

The list of attributes.

Gets or sets the Uniform Resource Identifier (URI) for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The Uniform Resource Identifier (URI) for the element.

Gets the collection of **atom:category** elements within the **app:categories** element.

The collection of categories.

Gets the list of child elements within the element.

The list of child elements.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The language of the element.

Gets or sets the local name of the element. It must be valid according to XML 1.0.

The name of the element.

Gets or sets the namespace of the element.

The namespace name.

Gets or sets the text content of the element. If the element contains only child elements, this attribute is NULL.

The node value.

Gets the **atom:title** element under the **app:collection** element.

The collection of title elements.

Gets the Uniform Resource Identifier (URI) representing the **href** attribute of the **app:collection** element. This is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute when it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be Null.

The Uniform Resource Identifier (URI) of the resource collection.

Generates the DOM object that represents this element, and all the attributes and child elements including foreign markups.

The format of the element. The only formats accepted by this method are Atom 1.0 and RSS 2.0. The XML document.

Encapsulates a service document.

Gets the list of attributes of the element.

A list of attributes of the element.

Gets or sets the Uniform Resource Identifier (URI) for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The base Uniform Resource Identifier (URI) for the element.

Gets the list of child elements within the element.

The list of child elements.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The language of the element.

Gets or sets the local name of the element. It must be valid according to XML 1.0.

The local name of the element.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this attribute is NULL.

The text for the element.

Gets the collection of **app:workspace** elements in the service document.

The collection of workspace elements.

Generates the DOM object that represents this element, and all the attributes and child elements including foreign markups.

The format of the element. The only formats accepted by this method are Atom 1.0 and RSS 2.0. The XML document.

Encapsulates a workspace in a service document.

Gets the list of attributes of the element.

The list of attributes.

Gets or sets the Uniform Resource Identifier (URI) for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The base Uniform Resource Identifier (URI) for the element.

Gets the read-only collection of **app:collection** elements within the **app:workspace** element.

The collection of collection elements.

Gets the list of child elements within the element.

The list of child elements.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The language of the element.

Gets or sets the local name of the element. It must be valid according to XML 1.0.

The name of the element.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this attribute is NULL.

The text of the element.

Gets the **atom:title** element under the **app:workspace** element.

The text of the title.

Generates the DOM object that represents this element, and all the attributes and child elements including foreign markups.

The format for the element. The only formats accepted by this method are Atom 1.0 and RSS 2.0. The XML document.

Provides HTTP content that uses a buffer.

Initializes a new instance of the HttpBufferContent class with the specified buffer.

The content used to initialize the HttpBufferContent.

Initializes a new instance of the HttpBufferContent class with an offset and count of bytes from the specified buffer.

The content used to initialize the HttpBufferContent. The offset in bytes from the beginning of the *content* buffer to initialize the HttpBufferContent. The count of bytes in the *content* buffer to initialize the HttpBufferContent.

Get a collection of content headers set on the HttpBufferContent.

A collection of content headers set on the HttpBufferContent.

Serialize the HttpBufferContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpBufferContent instance and releases allocated resources.

Serialize the HttpBufferContent to a buffer as an asynchronous operation.

The object that represents the asynchronous operation.

Serialize the HttpBufferContent and return an input stream that represents the content as an asynchronous operation.

The object that represents the asynchronous operation.

Serialize the HttpBufferContent to a String as an asynchronous operation.

The object that represents the asynchronous operation.

Returns a string that represents the current HttpBufferContent object.

A string that represents the current object.

Computes the HttpBufferContent length in bytes.

The length in bytes of the HttpBufferContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpBufferContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Sends HTTP requests and receives HTTP responses from a resource identified by a URI. For programming guidance for the **HttpClient** class, and code examples, see the HttpClient conceptual topic.

Initializes a new instance of the HttpClient class. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

Initializes a new instance of the HttpClient class with a specific filter for handling HTTP response messages. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The HTTP filter to use for handling response messages.

Gets a collection of headers that should be sent with each request. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The headers that should be sent with each request.

Closes the HttpClient instance and releases allocated resources. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

Send a DELETE request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a GET request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri to which the request is to be sent. The object representing the asynchronous operation.

Send a GET request to the specified Uri with an HTTP completion option as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. An HTTP completion option value that indicates when the operation should be considered completed. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as a buffer in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as a stream in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a POST request to the specified URI as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The URI the request is sent to. The HTTP request content to send to the server. The object representing the asynchronous operation.

Send a PUT request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The HTTP request content to send to the server. The object representing the asynchronous operation.

Send an HTTP request as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The HTTP request message to send. The object representing the asynchronous operation.

Send an HTTP request with an HTTP completion option as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The HTTP request message to send. A value that indicates whether the HttpClient operation is considered completed when all of the response is read, or when just the headers are read. The object representing the asynchronous operation.

Returns a string that represents the current HttpClient object. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

A string that represents the current object.

Send a DELETE request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Sends a GET request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Sends a GET request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. An HTTP completion option value that indicates when the operation should be considered completed. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as HttpGetBufferResult with an IBuffer value in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as a stream in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The object representing the asynchronous operation.

Sends a POST request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The HTTP request content to send to the server. The object representing the asynchronous operation.

Sends a PUT request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The Uri the request is sent to. The HTTP request content to send to the server. The object representing the asynchronous operation.

Sends an HTTP request to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The HTTP request message to send. The object representing the asynchronous operation.

Sends an HTTP request with a completion option to the specified Uri as an asynchronous operation. For programming guidance for the HttpClient class, and code examples, see the HttpClient conceptual topic.

The HTTP request message to send. A value that indicates whether the HttpClient operation is considered completed when all of the response is read, or when just the headers are read. The object representing the asynchronous operation.

Indicates whether asynchronous HttpClient operations are considered completed when all of the response is read, or when just the headers are read.

The operation should complete after reading the entire response including the content.

The operation should complete as soon as a response is available and headers are read. The content is not read yet.

Provides a set of properties and methods to manage an HTTP cookie.

Initializes a new instance of the HttpCookie class with a specified name, domain, and path.

The name for the HttpCookie The domain for which the HttpCookie is valid. The URIs to which the HttpCookie applies.

Get the domain for which the HttpCookie is valid.

The domain for which the HttpCookie is valid.

Get or set the expiration date and time for the HttpCookie.

The expiration date and time for the HttpCookie.

Get or set a value that controls whether a script or other active content can access this HttpCookie.

Whether a script or other active content can access this HttpCookie.

Get the token that represents the HttpCookie name.

The token that represents the HttpCookie name.

Get the URI path component to which the HttpCookie applies.

The URI path component to which the HttpCookie applies.

Get or set the security level for the HttpCookie.

The security level for the HttpCookie.

Get or set the value for the HttpCookie.

The value for the HttpCookie.

Returns a string that represents the current HttpCookie object.

A string that represents the current object.

Provides a collection container for instances of the HttpCookie class.

Gets the number of cookies in the HttpCookieCollection.

The number of cookies in the HttpCookieCollection.

Retrieves an iterator to the first HttpCookie item in the HttpCookieCollection.

An iterator to the first HttpCookie item in the HttpCookieCollection.

Returns the HttpCookie at the specified index from the HttpCookieCollection.

The zero-based index of a specified item in the HttpCookieCollection. The HTTP cookie at the specified index from the HttpCookieCollection.

Retrieves the HttpCookie items that start at the specified index in the HttpCookieCollection.

The zero-based index of the start of the HttpCookie items in the HttpCookieCollection. The HttpCookie items that start at *startIndex* in the HttpCookieCollection. The number of HttpCookie items retrieved.

Retrieves the index of an HttpCookie in the HttpCookieCollection.

The HttpCookie to find in the HttpCookieCollection. The index of the HttpCookie in the HttpCookieCollection. Indicates whether the item is found.

Add or delete an HttpCookie or view the cookies associated with an app.

Delete an HttpCookie from the cookies associated with an app.

The HttpCookie to delete.

Gets an HttpCookieCollection that contains the HttpCookie instances that are associated with a specific URI.

The URI of the HttpCookie instances desired. The HttpCookieCollection that contains the HttpCookie instances that are associated with a specific URI.

Add or change an HttpCookie in the cookies associated with an app that is sent on future requests.

The HttpCookie to change or add. **true** if the HttpCookie replaced an existing cookie; otherwise **false**.

Add or change an HttpCookie in the cookies associated with an app.

The HttpCookie to change or add. A value that indicates whether the HttpCookie is a third party HTTP cookie. **true** if the HttpCookie replaced an existing cookie; otherwise **false**.

Provides HTTP content that uses name/value data encoded with the **application/x-www-form-urlencoded** MIME type.

Initializes a new instance of the HttpFormUrlEncodedContent class with the specified content.

The content used to initialize the HttpFormUrlEncodedContent.

Get a collection of content headers set on the HttpFormUrlEncodedContent.

A collection of content headers set on the HttpFormUrlEncodedContent.

Serialize the HttpFormUrlEncodedContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpFormUrlEncodedContent instance and releases allocated resources.

Serialize the HttpFormUrlEncodedContent to a buffer as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpFormUrlEncodedContent and return an input stream that represents the content as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpFormUrlEncodedContent to a String as an asynchronous operation.

The object representing the asynchronous operation.

Returns a string that represents the current HttpFormUrlEncodedContent object.

A string that represents the current object.

Computes the HttpFormUrlEncodedContent length in bytes.

The length in bytes of the HttpFormUrlEncodedContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpFormUrlEncodedContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Combines the final buffer result along with the following: the original HTTP request, the resulting HTTP response (if any), an extended error value, and a succeeded indication.

The extended error code for an HTTP request.

HRESULT value of the error.

Gets the request message that led to this HttpGetBufferResult.

The request message that led to this HttpGetBufferResult.

Gets the HTTP response message including headers, the status code, and data.

The response message which resulted from the HttpRequestMessage.

Gets whether the HTTP request was successful.

True if HTTP request was successful; otherwise False. A request is successful if a 200-series HTTP response was received and, if the response body was read, that there were no exceptions when processing the response body.

The returned data from an HTTP request as an IBuffer.

IBuffer value of the HTTP response.

Closes the HttpGetBufferResult instance and releases allocated resources.

Returns a string that represents the current HttpGetBufferResult object.

A string that represents the current object.

Combines the final input stream result along with following: the original HTTP request, the resulting HTTP response (if any), an extended error value, and a succeeded indication.

The extended error code for an HTTP request.

HRESULT value of the error or null if there was no error.

Gets the request message that led to this HttpGetInputStreamResult.

The request message that led to this HttpGetInputStreamResult.

Gets the HTTP response message including headers, the status code, and data.

The response message which resulted from the HttpRequestMessage.

Gets whether the HTTP request was successful.

True if HTTP request was successful; otherwise False. A request is successful if a 200-series HTTP response was received and, if the response body was read, that there were no exceptions when processing the response body.

The returned data from an HTTP request as an IInputStream.

**IInputStream** value of the HTTP response.

Closes the HttpGetInputStreamResult instance and releases allocated resources.

Returns a string that represents the current HttpGetInputStreamResult object.

A string that represents the current object.

Combines the final string result along with the following: the original HTTP request, the resulting HTTP response (if any), an extended error value, and a succeeded indication.

The extended error code for an HTTP request.

HRESULT value of the error or null if there was no error.

Gets the request message that led to this HttpGetStringResult.

The request message that led to this HttpGetStringResult.

Gets the HTTP response message including headers, the status code, and data.

The response message which resulted from the HttpRequestMessage.

Gets whether the HTTP request was successful.

True if HTTP request was successful; otherwise False. A request is successful if a 200-series HTTP response was received and, if the response body was read, that there were no exceptions when processing the response body.

The returned string data from an HTTP request as a string.

String value of the HTTP response.

Closes the HttpGetStringResult instance and releases allocated resources.

Returns a string that represents the current HttpGetStringResult object.

A string that represents the current object.

Retrieves standard HTTP methods such as GET and POST and creates new HTTP methods.

Initializes a new instance of the HttpMethod class with a specific HTTP method.

The HTTP method.

Gets the HTTP DELETE method.

The HTTP DELETE method.

Gets the HTTP GET method.

The HTTP GET method.

Gets the HTTP HEAD method.

The HTTP HEAD method.

Gets the HTTP method.

An HTTP method represented as a String.

Gets the HTTP OPTIONS method.

The HTTP OPTIONS method.

Gets the HTTP PATCH method,

The HTTP PATCH method.

Gets the HTTP POST method.

The HTTP POST method.

Gets the HTTP PUT method.

The HTTP PUT method.

Returns a string that represents the current HttpMethod object.

A string that represents the current object.

Provides HTTP content that uses the **multipart/*** MIME type.

Initializes a new instance of the HttpMultipartContent class.

Initializes a new instance of the HttpMultipartContent class with the specified MIME subtype.

The MIME subtype of the multipart content.

Initializes a new instance of the HttpMultipartContent class with the specified MIME subtype and boundary string.

The MIME subtype of the multipart content. The boundary string for the multipart content.

Get a collection of content headers set on the HttpMultipartContent.

A collection of content headers set on the HttpMultipartContent.

Add HTTP content to the HttpMultipartContent instance.

The HTTP content to add to HttpMultipartContent.

Serialize the HttpMultipartContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpMultipartContent instance and releases allocated resources.

Gets an object that can be used to enumerate the contents in the HttpMultipartContent object.

An object that can be used to enumerate the contents in the HttpMultipartContent object.

Serialize the HttpMultipartContent to a buffer as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpMultipartContent and return an input stream that represents the content as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpMultipartContent to a String as an asynchronous operation.

The object representing the asynchronous operation.

Returns a string that represents the current HttpMultipartContent object.

A string that represents the current object.

Determines whether the HttpMultipartContent has a valid length in bytes.

The length in bytes of the HttpMultipartContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpMultipartContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Provides HTTP content that uses the **multipart/form-data** MIME type.

Initializes a new instance of the HttpMultipartFormDataContent class.

Initializes a new instance of the HttpMultipartFormDataContent class with the specified boundary string.

The boundary string for the multipart content.

Get a collection of content headers set on the HttpMultipartFormDataContent.

A collection of content headers set on the HttpMultipartFormDataContent.

Add HTTP content to the HttpMultipartFormDataContent instance.

The HTTP content to add to HttpMultipartFormDataContent.

Add HTTP content with a specified name to the HttpMultipartFormDataContent instance.

The HTTP content to add to HttpMultipartFormDataContent. The name for the HTTP content to add to HttpMultipartFormDataContent.

Add HTTP content with a specified name from a file to the HttpMultipartFormDataContent instance.

The HTTP content to add to HttpMultipartFormDataContent. The name for the HTTP content to add to HttpMultipartFormDataContent. The file name for the HTTP content to add to HttpMultipartFormDataContent.

Serialize the HttpMultipartFormDataContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpMultipartFormDataContent instance and releases allocated resources.

Gets an object that can be used to enumerate the contents in the HttpMultipartFormDataContent object.

An object that can be used to enumerate the contents in the HttpMultipartFormDataContent object.

Serialize the HttpMultipartFormDataContent to a buffer as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpMultipartFormDataContent and return an input stream that represents the content as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpMultipartFormDataContent to a String as an asynchronous operation.

The object representing the asynchronous operation.

Returns a string that represents the current HttpMultipartFormDataContent object.

A string that represents the current object.

Determines whether the HttpMultipartFormDataContent has a valid length in bytes.

The length in bytes of the HttpMultipartFormDataContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpMultipartFormDataContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Contains status information on the progress of an HttpClient operation.

The total number of bytes received.

The total number of bytes sent.

The number of retries.

The step in the progress of an HTTP connection.

The total number of data bytes to receive.

The total number of data bytes to send.

Indicates the step in the progress for an HTTP connection.

The socket used for the HTTP connection is connecting to the server.

The system starts to detect a proxy.

The HTTP connection to the server is negotiating SSL.

A default value that should not be encountered.

The HTTP client is receiving content from the server.

The HTTP client is receiving headers from the server.

The system is resolving the hostname for the HTTP connection.

HTTP content is being sent to the server.

HTTP headers are being sent to the server.

The HTTP client is waiting for a response from the server.

Represents an HTTP request message including headers.

Initializes a new instance of the HttpRequestMessage class.

Initializes a new instance of the HttpRequestMessage class with an HTTP method and a request Uri.

The HTTP method to perform The Uri to request.

Gets or sets the HTTP content to send to the server on the HttpRequestMessage object.

The HTTP content to send to the server on the HttpRequestMessage object.

Gets the collection of the HTTP request headers associated with the HttpRequestMessage.

The collection of HTTP request headers associated with the HttpRequestMessage.

Gets or sets the HTTP method to be performed on the request URI.

The HTTP method to be performed on the request URI.

Gets a set of properties on the HttpRequestMessage instance that are for use by the developer.

A set of properties on the HttpRequestMessage instance that are for use by the developer.

Gets or sets the Uri used for the HttpRequestMessage object.

The Uri used for the HTTP request.

Get information about the underlying transport socket used by an HTTP connection.

Information about the underlying transport socket used by an HTTP connection.

Closes the HttpRequestMessage instance and releases allocated resources.

Returns a string that represents the current HttpRequestMessage object.

A string that represents the current object.

Combines the original HTTP request along with the following: the resulting HTTP response (if any), an extended error value, and a succeeded indication.

The extended error code for an HTTP request.

HRESULT value of the error or null if there was no error.

Gets the request message that led to this HttpRequestResult.

The request message that led to this HttpRequestResult.

Gets the HTTP response message including headers, the status code, and data.

The response message which resulted from the HttpRequestMessage.

Gets whether the HTTP request was successful.

True if HTTP request was successful; otherwise False. A request is successful if a 200-series HTTP response was received and, if the response body was read, that there were no exceptions when processing the response body.

Closes the HttpRequestResult instance and releases allocated resources.

Returns a string that represents the current HttpRequestResult object.

A string that represents the current object.

Represents an HTTP response message including headers, the status code, and data.

Initializes a new instance of the HttpResponseMessage class.

Initializes a new instance of the HttpResponseMessage class with a specific HttpStatusCode.

The status code of the HTTP response.

Gets or sets the content of the HTTP response message on the HttpResponseMessage object.

The content of the HTTP response message on the HttpResponseMessage object.

Gets the collection of HTTP response headers associated with the HttpResponseMessage that were sent by the server.

The collection of HTTP response headers.

Gets a value that indicates whether the HTTP response was successful.

A value that indicates if the HTTP response was successful. true if HttpStatusCode was in the **Successful** range (200-299); otherwise false.

Gets or sets the reason phrase which typically is sent by servers together with the status code.

The reason phrase sent by the server.

Gets or sets the request message that led to this response message.

The request message that led to this response message.

Gets the source of the data received in the HttpResponseMessage.

The source of the data received in the HttpResponseMessage.

Gets or sets the status code of the HTTP response.

The status code of the HTTP response.

Gets or sets the HTTP protocol version used on the HttpResponseMessage object.

The HTTP protocol version. The default is 1.1.

Closes the HttpResponseMessage instance and releases allocated resources.

Throws an exception if the IsSuccessStatusCode property for the HTTP response is false.

The HTTP response if the request was successful.

Returns a string that represents the current HttpResponseMessage object.

A string that represents the current object.

Indicates the source of the data received in the HttpResponseMessage.

The data was from the local cache.

The data was received over the network.

A default value that should not be returned under normal circumstances.

Contains the values of status codes defined for HTTP in the response to an HTTP request.

The request has been accepted for further processing.

Some of the results of the requested operation were already reported.

An intermediate proxy server received a bad response from another proxy or the origin server.

The request could not be understood by the server. This status code is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.

The request could not be carried out because of a conflict on the server.

The client should continue with its request.

The request resulted in a new resource created before the response was sent.

An expectation given in an **Expect** header could not be met by the server.

The method could not be performed on the resource because the requested action depended on another action and that action failed.

The server refuses to fulfill the request.

The requested information is located at the URI specified in the **Location** header. The default action when this status is received is to follow the **Location** header associated with the response. When the original request method was **POST**, the redirected request will use the **GET** method.

An intermediate proxy server timed out while waiting for a response from another proxy or the origin server.

The requested resource is no longer available.

The requested HTTP version is not supported by the server.

The server has fulfilled a **GET** request for the resource and the response is the result of one or more actions applied to the current instance.

The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary.

A generic error has occurred on the server.

The required **Content-Length** header is missing.

The source or destination resource of a method is locked. This response should contain an appropriate precondition or post-condition code.

The server terminated an operation because it encountered an infinite loop while processing a request. This status indicates that the entire operation failed.

The HTTP method in the request is not allowed on the requested resource.

The requested information has been moved to the URI specified in the **Location** header. The default action when this status is received is to follow the **Location** header associated with the response.

The requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the **Location** header associated with this response.

The response provides status for multiple independent operations. Specific error messages appear in the body of the multi- status response.

The server indicates that the client needs to authenticate to gain network access. The response should contain a link to a resource that allows the user to submit credentials.

The request has been successfully processed and that the response is intentionally blank.

The returned meta-information is from a cached copy instead of the origin server and therefore may be incorrect.

The client request wasn't successful.

The client has indicated with **Accept** headers that it will not accept any of the available representations of the resource.

The policy for accessing the resource has not been met in the request.

The requested resource does not exist on the server.

The server does not support the requested function.

The client's cached copy is up to date. The contents of the resource are not transferred.

The request succeeded and that the requested information is in the response. This is the most common status code to receive.

The response is a partial response as requested by a **GET** request that includes a byte range.

This code is reserved for future use.

The target resource has been assigned a new permanent URI and any future references to this resource should use one of the returned URIs specified in the **Location** header.

A condition set for this request failed, and the request cannot be carried out. Conditions are set with conditional request headers like **If-Match**, **If-None-Match**, or **If-Unmodified-Since**.

The origin server requires the request to be conditional.

The server has received a Web Distributed Authoring and Versioning (WebDAV) request and is processing the request.

The requested proxy requires authentication. The **Proxy-Authenticate** header contains the details of how to perform the authentication.

The range of data requested from the resource cannot be returned, either because the beginning of the range is before the beginning of the resource, or the end of the range is after the end of the resource.

The request is too large for the server to process.

The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields.

The client did not send a request within the time the server was expecting the request.

The URI is too long.

The client should reset (not reload) the current resource.

Automatically redirects the client to the URI specified in the **Location** header as the result of a **POST**. The request to the resource specified by the **Location** header will be made with the **GET** method.

The server is temporarily unavailable, usually due to high load or maintenance.

The HTTP protocol version or protocol is being changed.

The request information is located at the URI specified in the **Location** header. The default action when this status is received is to follow the **Location** header associated with the response. When the original request method was **POST**, the redirected request will also use the **POST** method.

The user has sent too many requests in a given amount of time. The response should include details explaining the condition, and may include a **Retry-After** header indicating how long to wait before making a new request.

The requested resource requires authentication. The **WWW-Authenticate** header contains the details of how to perform the authentication.

The server understands the content type of the request entity and the syntax of the request entity is correct, but the server was unable to process the contained instructions.

The request is an unsupported type.

The client should switch to a different protocol such as TLS/1.0.

The request should use the proxy server at the URI specified in the **Location** header.

The server has an internal configuration error. The chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.

Provides HTTP content that uses a stream.

Initializes a new instance of the HttpStreamContent class with the specified content.

The content used to initialize the HttpStreamContent.

Get a collection of content headers set on the HttpStreamContent.

A collection of content headers set on the HttpStreamContent.

Serialize the HttpStreamContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpStreamContent instance and releases allocated resources.

Serialize the HttpStreamContent to a buffer as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpStreamContent and return an input stream that represents the content as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HttpStreamContent to a String as an asynchronous operation.

The object representing the asynchronous operation.

Returns a string that represents the current HttpStreamContent object.

A string that represents the current object.

Determines whether the HttpStreamContent has a valid length in bytes.

The length in bytes of the HttpStreamContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpStreamContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Provides HTTP content that uses a string.

Initializes a new instance of the HttpStringContent class with the specified content.

The content used to initialize the HttpStringContent.

Initializes a new instance of the HttpStringContent class with the specified content and encoding.

The content used to initialize the HttpStringContent. The encoding to use for the content.

Initializes a new instance of the HttpStringContent class with the specified content, encoding, and media type.

The content used to initialize the HttpStringContent. The encoding to use for the content. The media type to use for the content.

Get a collection of content headers set on the HttpStringContent.

A collection of content headers set on the HttpStringContent.

Serialize the HttpStringContent into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Closes the HttpStringContent instance and releases allocated resources.

Serialize the HttpStringContent to a buffer as an asynchronous operation.

The object that represents the asynchronous operation.

Serialize the HttpStringContent and return an input stream that represents the content as an asynchronous operation.

The object that represents the asynchronous operation.

Serialize the HttpStringContent to a String as an asynchronous operation.

The object that represents the asynchronous operation.

Returns a string that represents the current HttpStringContent object.

A string that represents the current object.

Compute the HttpStringContent length in bytes.

The length in bytes of the HttpStringContent. **true** if *length* is a valid length; otherwise, **false**.

Write the HttpStringContent to an output stream as an asynchronous operation.

The output stream to write to. The object that represents the asynchronous operation.

Provides information about the underlying transport used by the HTTP connection.

Gets the certificate from the server with the SSL information.

The certificate from the server with the SSL information.

Gets the list of errors that occurred making an SSL connection.

The list of errors that occurred making an SSL connection.

Gets the category of an error on an SSL connection.

The category of error on an SSL connection.

Gets the intermediate certificates sent by the server during SSL negotiation on this HttpTransportInformation object.

The set of certificates sent by the server during SSL negotiation on this HttpTransportInformation object.

Returns a string that represents the current HttpTransportInformation object.

A string that represents the current object.

Represents the HTTP protocol version.

HTTP 1.0.

HTTP 1.1.

HTTP 2.0

This value may be returned by third party filters.

Provides a base interface for an HTTP entity body and content headers.

Get a collection of content headers set on the IHttpContent.

A collection of content headers set on the IHttpContent.

Serialize the HTTP content into memory as an asynchronous operation.

The object that represents the asynchronous operation.

Serialize the HTTP content to a buffer as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HTTP content and return an input stream that represents the content as an asynchronous operation.

The object representing the asynchronous operation.

Serialize the HTTP content to a String as an asynchronous operation.

The object representing the asynchronous operation.

Determines whether the HTTP content has a valid length in bytes.

The length in bytes of the HTTP content. **true** if *length* is a valid length; otherwise, **false**.

Write the HTTP content to an output stream as an asynchronous operation.

The output stream to write to. The object representing the asynchronous operation.

The base protocol filter for an HttpClient instance.

Initializes a new instance of the HttpBaseProtocolFilter class.

Get or set a value that indicates whether the HttpBaseProtocolFilter should follow redirection responses.

A value that indicates whether the HttpBaseProtocolFilter should follow redirection responses.

Get or set a value that indicates whether the HttpBaseProtocolFilter can prompt for user credentials when requested by the server.

A value that indicates whether HttpBaseProtocolFilter can prompt for user credentials when requested by the server.

Gets or sets a value that indicates whether the HttpBaseProtocolFilter can automatically decompress the HTTP content response.

A value that indicates whether HttpBaseProtocolFilter can automatically decompress the HTTP content response.

Get or set the read and write cache control behavior to be used on the HttpBaseProtocolFilter object.

The cache control behavior to be used on the HttpBaseProtocolFilter object.

Get or set the client SSL certificate that will be sent to the server if the server requests a client certificate.

The client SSl certificate.

Get the HttpCookieManager with the cookies associated with an app.

The HttpCookieManager object that contains the cookies associated with an app.

Gets or sets the cookie usage behavior. By default, cookies are handled automatically.

The cookie usage behavior.

Get a vector of SSL server certificate errors that the app might subsequently choose to ignore.

A vector of SSL server certificate errors that the app might subsequently choose to ignore.

Get or set the maximum number of TCP connections allowed per HTTP server by the HttpBaseProtocolFilter object.

The maximum number of connections allowed per HTTP server.

Gets or sets the version of the HTTP protocol used.

An enumeration value that specifies the version of HTTP used.

Get or set the credentials to be used to negotiate with an HTTP proxy.

The credentials to be used to negotiate with an HTTP proxy.

Get or set the credentials to be used to authenticate with an HTTP server.

The credentials to be used to authenticate with an HTTP server.

Get or set a value that indicates whether the HttpBaseProtocolFilter can use a proxy for sending HTTP requests.

A value that indicates whether HttpBaseProtocolFilter can use a proxy to send HTTP requests.

Gets the User associated with the HttpBaseProtocolFilter.

The User associated with the HttpBaseProtocolFilter.

This event is raised when the SSL/TLS connection is being established with the server. You should implement an event handler for this event if you need to perform extra validation (in addition to the OS default) of the server SSL certificate.

Clears authentication credentials currently cached on the device.

Closes the HttpBaseProtocolFilter instance and releases allocated resources.

Creates a new HttpBaseProtocolFilter for a specific User.

The User for which you want to create the HttpBaseProtocolFilter. Returns an HttpBaseProtocolFilter for the account specified by the *user* parameter.

Send an HTTP request using the HttpBaseProtocolFilter as an asynchronous operation.

The HTTP request message to send. The object representing the asynchronous operation.

Provides control of the local HTTP cache for responses to HTTP requests by methods in the Windows.Web.Http and Windows.Web.Http.Filters namespaces.

Get or set the read behavior to use for cache control on the HttpCacheControl object.

The read behavior to use for cache control.

Get or set the write behavior to use for cache control on the HttpCacheControl object.

The read behavior to use for cache control.

Indicates if read requests by class methods in the Windows.Web.Http and Windows.Web.Http.Filters namespaces use the local HTTP cache for the response.

Always use the cache algorithm specified in RFC 2616 by the IETF to optimize network bandwidth.

Use the local HTTP cache if possible but always ask the server if more recent content is available.

Do not use cache nor do a conditional request. This ensures that all HTTP requests go directly to the server.

Only use data from the local HTTP cache. This is the offline behavior.

Indicates if content returned by requests used by class methods in the Windows.Web.Http and Windows.Web.Http.Filters namespaces is written to the local HTTP cache.

Use the default behavior of WinInet. This usually results in writing the response to the local HTTP cache.

Never write the response to the local HTTP cache.

Defines the cookie usage behavior that is used in the CookieUsageBehavior property.

Automatically handle cookies.

Do not handle cookies automatically.

Provides data for the ServerCustomValidationRequested event.

Gets the HTTP request containing the destination URI, headers, and body.

The HTTP request containing the destination URI, headers, and body.

Gets the X509Certificate provided by the server.

The X509Certificate provided by the server.

Gets the errors that the OS validation logic has found in this certificate or the chain.

The errors that the OS validation logic has found in this certificate or the chain.

Gets the severity level of errors encountered.

The severity level of errors encountered.

Gets the chain of intermediate certificates, ending in the root CA associated with the remote certificate.

The chain of intermediate certificates, ending in the root CA associated with the remote certificate.

Requests that suspension of the event handler be delayed until the deferral is completed by calling the Complete method on the Deferral object.

The deferral object.

Reject the server's certificate. This will result in the client terminating the connection to the server.

An interface used to implement custom filters for an HttpClient instance.

Send an HTTP request on the IHttpFilter instance as an asynchronous operation.

The HTTP request message to send. The object representing the asynchronous operation.

Represents the value of the **Cache-Control** HTTP header on HTTP content associated with an HTTP request or response.

Gets or sets the value of the **max-age** directive in the **Cache-Control** HTTP header.

The value of the max-age directive in the **Cache-Control** HTTP header.

Gets or sets the value of the **max-stale** directive in the **Cache-Control** HTTP header.

the value of the **max-stale** directive in the **Cache-Control** HTTP header.

Gets or sets the value of the **min-fresh** directive in the **Cache-Control** HTTP header.

The value of the **min-fresh** directive in the **Cache-Control** HTTP header.

Gets or sets the value of the **s-maxage** directive in the **Cache-Control** HTTP header.

The value of the **s-maxage** directive in the **Cache-Control** HTTP header.

Gets the number of HttpNameValueHeaderValue objects in the collection.

The number of HttpNameValueHeaderValue objects in the HttpCacheDirectiveHeaderValueCollection.

Adds a new HttpNameValueHeaderValue item to the end of the collection.

The HttpNameValueHeaderValue object to append.

Removes all objects from the collection.

Retrieves an iterator to the first HttpNameValueHeaderValue item in the collection.

An object that can be used to enumerate the HttpNameValueHeaderValue items in the collection. The iterator points to the first HttpNameValueHeaderValue item in the HttpCacheDirectiveHeaderValueCollection.

Returns the HttpNameValueHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the HttpCacheDirectiveHeaderValueCollection. The HttpNameValueHeaderValue at the specified index in the HttpCacheDirectiveHeaderValueCollection.

Retrieves the HttpNameValueHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpNameValueHeaderValue items in the HttpCacheDirectiveHeaderValueCollection. An array of HttpNameValueHeaderValue items that start at *startIndex* in the HttpCacheDirectiveHeaderValueCollection. The number of HttpNameValueHeaderValue items retrieved.

Returns an immutable view of the HttpCacheDirectiveHeaderValueCollection.

The view of the HttpCacheDirectiveHeaderValueCollection.

Retrieves the index of an HttpNameValueHeaderValue in the collection.

The HttpNameValueHeaderValue to find in the HttpCacheDirectiveHeaderValueCollection. The index of the HttpNameValueHeaderValue in the HttpCacheDirectiveHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpNameValueHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpCacheDirectiveHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpCacheDirectiveHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpNameValueHeaderValue item from the collection.

Replaces all the HttpNameValueHeaderValue items in the collection with the specified HttpNameValueHeaderValue items.

The collection of HttpNameValueHeaderValue items to add to the collection.

Sets the HttpNameValueHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpNameValueHeaderValue. The item to set.

Returns a string that represents the current HttpCacheDirectiveHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpCacheDirectiveHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents authentication information used in the **Proxy-Authenticate** and **WWW-Authenticate** HTTP header values.

Initializes a new instance of the HttpChallengeHeaderValue class with the scheme to use for authorization.

The scheme to use for authorization.

Initializes a new instance of the HttpChallengeHeaderValue class with the scheme to use for authorization and the **SPNEGO** token.

The scheme to use for authorization. The **SPNEGO** token to use with the **Negotiate** protocol scheme.

Gets the credentials that contain the authentication information of the user agent for the resource being requested.

The credentials that contain the authentication information.

Gets the scheme to use for authentication.

The scheme to use for authentication.

The **SPNEGO** token to use with the **Negotiate** protocol scheme.

The **SPNEGO** token.

Converts a string to an HttpChallengeHeaderValue instance.

A string that represents authentication header value information. An HttpChallengeHeaderValue instance.

Returns a string that represents the current HttpChallengeHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpChallengeHeaderValue information.

The string to validate. The HttpChallengeHeaderValue version of the string. **true** if input is valid HttpChallengeHeaderValue information; otherwise, **false**.

Represents the value of the **Proxy-Authenticate** or **WWW-Authenticate** HTTP header on an HTTP response.

Gets the number of HttpChallengeHeaderValue objects in the collection.

The number of HttpChallengeHeaderValue objects in the HttpChallengeHeaderValueCollection.

Adds a new HttpChallengeHeaderValue item to the end of the collection.

The HttpChallengeHeaderValue object to append.

Removes all HttpChallengeHeaderValue objects from the collection.

Retrieves an iterator to the first HttpChallengeHeaderValue item in the collection.

An object that can be used to enumerate the HttpChallengeHeaderValue items in the collection. The iterator points to the first HttpChallengeHeaderValue item in the HttpChallengeHeaderValueCollection.

Returns the HttpChallengeHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the HttpChallengeHeaderValueCollection. The HttpChallengeHeaderValue at the specified index in the HttpChallengeHeaderValueCollection

Retrieves the HttpChallengeHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpChallengeHeaderValue items in the HttpChallengeHeaderValueCollection. An array of HttpChallengeHeaderValue items that start at *startIndex* in the HttpChallengeHeaderValueCollection. The number of HttpChallengeHeaderValue items retrieved.

Returns an immutable view of the HttpChallengeHeaderValueCollection.

The view of the HttpChallengeHeaderValueCollection.

Retrieves the index of an HttpChallengeHeaderValue in the collection.

The HttpChallengeHeaderValue to find in the HttpChallengeHeaderValueCollection. The index of the HttpChallengeHeaderValue in the HttpChallengeHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpChallengeHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpChallengeHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpChallengeHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpChallengeHeaderValue item from the collection.

Replaces all the HttpChallengeHeaderValue items in the collection with the specified HttpChallengeHeaderValue items.

The collection of HttpChallengeHeaderValue items to add to the collection.

Sets the HttpChallengeHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpChallengeHeaderValue. The item to set.

Returns a string that represents the current HttpChallengeHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpChallengeHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents connection information used in the **Connection** HTTP header on an HTTP request.

Initializes a new instance of the HttpConnectionOptionHeaderValue class.

The value of the **connection-token** to use.

Gets the value of the **connection-token** in the **Connection** HTTP header.

The value of the **connection-token** in the **Connection** HTTP header.

Converts a string to an HttpConnectionOptionHeaderValue instance.

A string that represents the connection information in the **Connection** HTTP header. An HttpConnectionOptionHeaderValue instance.

Returns a string that represents the current HttpConnectionOptionHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpConnectionOptionHeaderValue information.

The string to validate. The HttpConnectionOptionHeaderValue version of the string. **true** if input is valid HttpConnectionOptionHeaderValue information; otherwise, **false**.

Represents the value of the **Connection** HTTP header on an HTTP request.

Gets the number of HttpConnectionOptionHeaderValue objects in the collection.

The number of HttpConnectionOptionHeaderValue objects in the HttpConnectionOptionHeaderValueCollection.

Adds a new HttpConnectionOptionHeaderValue item to the end of the collection.

The HttpConnectionOptionHeaderValue object to append.

Removes all HttpConnectionOptionHeaderValue objects from the collection.

Retrieves an iterator to the first HttpConnectionOptionHeaderValue item in the collection.

An object that can be used to enumerate the HttpConnectionOptionHeaderValue items in the collection. The iterator points to the first HttpConnectionOptionHeaderValue item in the HttpConnectionOptionHeaderValueCollection.

Returns the HttpConnectionOptionHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the HttpConnectionOptionHeaderValueCollection. The HttpConnectionOptionHeaderValue at the specified index in the HttpConnectionOptionHeaderValueCollection.

Retrieves the HttpConnectionOptionHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpConnectionOptionHeaderValue items in the HttpConnectionOptionHeaderValueCollection. An array of HttpConnectionOptionHeaderValue items that start at *startIndex* in the HttpConnectionOptionHeaderValueCollection. The number of HttpConnectionOptionHeaderValue items retrieved.

Returns an immutable view of the HttpConnectionOptionHeaderValueCollection.

The view of the HttpConnectionOptionHeaderValueCollection.

Retrieves the index of an HttpConnectionOptionHeaderValue in the collection.

The HttpConnectionOptionHeaderValue to find in the HttpConnectionOptionHeaderValueCollection. The index of the HttpConnectionOptionHeaderValue in the HttpConnectionOptionHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpConnectionOptionHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpConnectionOptionHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpConnectionOptionHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpConnectionOptionHeaderValue item from the collection.

Replaces all the HttpConnectionOptionHeaderValue items in the collection with the specified HttpConnectionOptionHeaderValue items.

The collection of HttpConnectionOptionHeaderValue items to add to the collection.

Sets the HttpConnectionOptionHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpConnectionOptionHeaderValue. The item to set.

Returns a string that represents the current HttpConnectionOptionHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpConnectionOptionHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents content encoding information used in the **Content-Encoding** HTTP header on HTTP content in a request or a response.

Initializes a new instance of the HttpContentCodingHeaderValue class.

The value of the **content-coding** to use.

Gets the value of the **content-coding** information used in the **Content-Encoding** HTTP header.

The value of the **content-coding** characteristic in the **Content-Encoding** HTTP header.

Converts a string to an HttpContentCodingHeaderValue instance.

A string that represents the content coding information in the **Content-Encoding** HTTP header. An HttpContentCodingHeaderValue instance.

Returns a string that represents the current HttpContentCodingHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpContentCodingHeaderValue information.

The string to validate. The HttpContentCodingHeaderValue version of the string. **true** if *input* is valid HttpContentCodingHeaderValue information; otherwise, **false**.

Represents the value of the **Content-Encoding** HTTP header on HTTP content in a request or a response.

Gets the number of HttpContentCodingHeaderValue objects in the collection.

The number of HttpContentCodingHeaderValue objects in the HttpContentCodingHeaderValueCollection.

Adds a new HttpContentCodingHeaderValue item to the end of the collection.

The HttpContentCodingHeaderValue object to append.

Removes all objects from the collection.

Retrieves an iterator to the first HttpContentCodingHeaderValue item in the collection.

An object that can be used to enumerate the HttpContentCodingHeaderValue items in the collection. The iterator points to the first HttpContentCodingHeaderValue item in the HttpContentCodingHeaderValueCollection.

Returns the HttpContentCodingHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the HttpContentCodingHeaderValueCollection. The HttpContentCodingHeaderValue at the specified index in the HttpContentCodingHeaderValueCollection.

Retrieves the HttpContentCodingHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpContentCodingHeaderValue items in the HttpContentCodingHeaderValueCollection. An array of HttpContentCodingHeaderValue items that start at *startIndex* in the HttpContentCodingHeaderValueCollection. The number of HttpContentCodingHeaderValue items retrieved.

Returns an immutable view of the HttpContentCodingHeaderValueCollection.

The view of the HttpContentCodingHeaderValueCollection.

Retrieves the index of an HttpContentCodingHeaderValue in the collection.

The HttpContentCodingHeaderValue to find in the HttpContentCodingHeaderValueCollection. The index of the HttpContentCodingHeaderValue in the HttpContentCodingHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpContentCodingHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpContentCodingHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpContentCodingHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpContentCodingHeaderValue item from the collection.

Replaces all the HttpContentCodingHeaderValue items in the collection with the specified HttpContentCodingHeaderValue items.

The HttpContentCodingHeaderValue items to add to the collection.

Sets the HttpContentCodingHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpContentCodingHeaderValue. The item to set.

Returns a string that represents the current HttpContentCodingHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpContentCodingHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents accept encoding information used in the **Accept-Encoding** HTTP header on an HTTP request.

Initializes a new instance of the HttpContentCodingHeaderValue class with **content-coding** information.

The value of the **content-coding** to use.

Initializes a new instance of the HttpContentCodingHeaderValue class with **content-coding** information and a qvalue.

The value of the **content-coding** information to use. The value of the **qvalue** to use.

Gets the value of the **content-coding** characteristic in the **Accept-Encoding** HTTP header.

The value of the **content-coding** characteristic in the **Accept-Encoding** HTTP header.

Gets the value of the **qvalue** attribute in the **Accept-Encoding** HTTP header.

The value of the **qvalue** attribute in the **Accept-Encoding** HTTP header.

Converts a string to an HttpContentCodingWithQualityHeaderValue instance.

A string that represents the content coding information in the **Accept-Encoding** HTTP header. An HttpContentCodingWithQualityHeaderValue instance.

Returns a string that represents the current HttpContentCodingHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpContentCodingWithQualityHeaderValue information.

The string to validate. The HttpContentCodingWithQualityHeaderValue version of the string. **true** if *input* is valid HttpContentCodingWithQualityHeaderValue information; otherwise, **false**.

Represents the value of the **Accept-Encoding** HTTP header on an HTTP request.

Gets the number of HttpContentCodingWithQualityHeaderValue objects in the collection.

The number of HttpContentCodingWithQualityHeaderValue objects in the HttpContentCodingWithQualityHeaderValueCollection.

Adds a new HttpContentCodingWithQualityHeaderValue item to the end of the collection.

The HttpContentCodingWithQualityHeaderValue object to append.

Removes all objects from the collection.

Retrieves an iterator to the first HttpContentCodingWithQualityHeaderValue item in the collection.

An object that can be used to enumerate the HttpContentCodingWithQualityHeaderValue items in the collection. The iterator points to the first HttpContentCodingWithQualityHeaderValue item in the HttpContentCodingWithQualityHeaderValueCollection.

Returns the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpContentCodingWithQualityHeaderValue at the specified index in the HttpContentCodingWithQualityHeaderValueCollection.

Retrieves the HttpContentCodingWithQualityHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpContentCodingWithQualityHeaderValue items in the HttpContentCodingWithQualityHeaderValueCollection. An array of HttpContentCodingWithQualityHeaderValue items that start at *startIndex* in the HttpContentCodingWithQualityHeaderValueCollection. The number of HttpContentCodingWithQualityHeaderValue items retrieved.

Returns an immutable view of the HttpContentCodingWithQualityHeaderValueCollection.

The view of the HttpContentCodingWithQualityHeaderValueCollection.

Retrieves the index of an HttpContentCodingWithQualityHeaderValue in the collection.

The HttpContentCodingWithQualityHeaderValue to find in the HttpContentCodingWithQualityHeaderValueCollection. The index of the HttpContentCodingWithQualityHeaderValue in the HttpContentCodingWithQualityHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpContentCodingWithQualityHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpContentCodingWithQualityHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpContentCodingWithQualityHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpContentCodingWithQualityHeaderValue item from the collection.

Replaces all the HttpContentCodingWithQualityHeaderValue items in the collection with the specified HttpContentCodingWithQualityHeaderValue items.

The HttpContentCodingWithQualityHeaderValue items to add to the collection.

Sets the HttpContentCodingWithQualityHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpContentCodingWithQualityHeaderValue. The item to set.

Returns a string that represents the current HttpContentCodingWithQualityHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpContentCodingWithQualityHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents the value of the **Content-Disposition** HTTP header on HTTP content in a request or a response.

Initializes a new instance of the HttpContentDispositionHeaderValue class with **content-coding** information for use in the **Content-Disposition** HTTP header.

The content disposition value to be used in the **Content-Disposition** HTTP header. For valid values, see Content Disposition Values and [Content-Disposition

Gets or sets the value of the **disposition-type** information in the **Content-Disposition** HTTP header.

The value of the **disposition-type** characteristic in the **Content-Disposition** HTTP header.

Gets or sets the value of the **filename-parm** information in the **Content-Disposition** HTTP header for a single file.

A suggested filename.

Gets or sets the value of the **filename-parm** characteristic in the **Content-Disposition** HTTP header for multiple files.

A suggested filename of the form filename*.

Gets or sets the name for a content body part in the **Content-Disposition** HTTP header.

The name for the content body part.

Gets a set of parameters included in the **Content-Disposition** HTTP header.

A set of parameters.

Gets or sets the approximate size, in bytes, of the file used in the **Content-Disposition** HTTP header.

The approximate size, in bytes.

Converts a string to an HttpContentDispositionHeaderValue instance.

A string that represents the content disposition information in the **Content-Disposition** HTTP header. An HttpContentDispositionHeaderValue instance.

Returns a string that represents the current HttpContentDispositionHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpContentDispositionHeaderValue information.

The string to validate. The HttpContentDispositionHeaderValue version of the string. **true** if *input* is valid HttpContentDispositionHeaderValue information; otherwise, **false**.

Provides a collection of the HTTP headers associated with content on an HTTP request or response.

Initializes a new instance of the HttpContentHeaderCollection class.

Gets or sets the HttpContentDispositionHeaderValue object that represents the value of an HTTP **Content-Disposition** header on the HTTP content.

The object that represent the value of HTTP **Content-Disposition** header on the HTTP content. A **null** value means that the header is absent.

Gets the HttpContentCodingHeaderValueCollection of HttpContentCodingHeaderValue objects that represent the value of an HTTP **Content-Encoding** header on the HTTP content.

The collection of HttpContentCodingHeaderValue objects that represent the value of an HTTP **Content-Encoding** header on the HTTP content. An empty collection means that the header is absent.

Gets the HttpLanguageHeaderValueCollection of objects that represent the value of an HTTP **Content-Language** header on the HTTP content.

The collection of objects that represent the value of an HTTP **Content-Language** header on the HTTP content. An empty collection means that the header is absent

Gets or sets the value of the HTTP **Content-Length** header on the HTTP content.

The value of the HTTP **Content-Length** header value on the HTTP content. A null value means that the header is absent.

Gets or sets the value of the HTTP **Content-Location** header on the HTTP content.

The value of the HTTP **Content-Location** header on the HTTP content. A null value means that the header is absent.

Gets or sets the value of an HTTP **Content-MD5** header on the HTTP content.

The value of the HTTP **Content-MD5** header on the HTTP content. A **null** value means that the header is absent.

Gets or sets the HttpContentRangeHeaderValue object that represent the value of an HTTP **Content-Range** header on the HTTP content.

The object that represent the value of the HTTP **Content-Range** header on the HTTP content. A null value means that the header is absent.

Gets or sets the HttpMediaTypeHeaderValue object that represent the value of an HTTP **Content-Type** header on the HTTP content.

The object that represent the value of an HTTP **Content-Type** header on the HTTP content. A **null** value means that the header is absent.

Gets or sets the DateTime object that represents the value of an HTTP **Expires** header on the HTTP content.

The object that represents the value of an HTTP **Expires** header on the HTTP content. A **null** value means that the header is absent.

Gets or sets the DateTime object that represents the value of an HTTP **Last-Modified** header on the HTTP content.

The object that represents the value of an HTTP **Last-Modified** header on the HTTP content. A **null** value means that the header is absent.

Gets the number of objects in the HttpContentHeaderCollection.

The number of objects in the HttpContentHeaderCollection.

Adds a new item to the end of the HttpContentHeaderCollection.

The name of the value to add. The item value to add.

Removes all objects from the HttpContentHeaderCollection.

Retrieves an iterator to the first item in the HttpContentHeaderCollection.

An object that can be used to enumerate the items in the collection. The iterator points to the first item in the HttpContentHeaderCollection.

Returns an immutable view of the HttpContentHeaderCollection.

The view of the HttpContentHeaderCollection.

Determines whether the HttpContentHeaderCollection contains the specified key.

The key associated with the item to locate. **true** if the key is found; otherwise, **false**.

Inserts or replaces an item in the HttpContentHeaderCollection with the specified key and value.

The key of the item to be inserted. The value of the item to insert. **true** if an item with the specified key is an existing item that was replaced; otherwise **false**.

Finds an item in the HttpContentHeaderCollection if it exists.

The key of the item to lookup. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes a specific object from the HttpContentHeaderCollection.

The key of the item to remove.

Returns a string that represents the current HttpContentHeaderCollection object.

A string that represents the current object.

Try to append the specified item to the HttpContentHeaderCollection without validation.

The name of the item to append. The value of the item to append. **true** if the item was appended; otherwise **false**.

Represents the value of the **Content-Range** HTTP header on HTTP content in a request or a response.

Initializes a new instance of the HttpContentRangeHeaderValue class with a content length.

The length, in bytes, of the full content entity body.

Initializes a new instance of the HttpContentRangeHeaderValue class with a start and stop position.

The position, in bytes, at which to start sending data. The position, in bytes, at which to stop sending data.

Initializes a new instance of the HttpContentRangeHeaderValue class with a start and stop position and a content length.

The position, in bytes, at which to start sending data. The position, in bytes, at which to stop sending data. The length, in bytes, of the full content entity body.

Gets the position at which to start sending data in the **Content-Range** HTTP header.

The position, in bytes, at which to start sending data.

Gets the position at which to stop sending data in the **Content-Range** HTTP header.

The position at which to stop sending data.

Gets the length of the full content entity body in the **Content-Range** HTTP header.

The length of the full content entity body.

Gets or sets the value of the range units used in the **Content-Range** HTTP header.

The range units used.

Converts a string to an HttpContentRangeHeaderValue instance.

A string that represents the content range information in the **Content-Range** HTTP header. An HttpContentRangeHeaderValue instance.

Returns a string that represents the current HttpContentRangeHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpContentRangeHeaderValue information.

The string to validate. The HttpContentRangeHeaderValue version of the string. **true** if *input* is valid HttpContentRangeHeaderValue information; otherwise, **false**.

Represents cookie information used in the **Cookie** HTTP header on an HTTP request.

Initializes a new instance of the HttpCookiePairHeaderValue class. with a cookie name.

A token that represents the cookie name.

Initializes a new instance of the HttpCookiePairHeaderValue class. with a cookie name and a value for the cookie.

A token that represents the cookie name. A value for the cookie.

Gets a token that represents the cookie name used in the **Cookie** HTTP header.

A token that represents the cookie name.

Gets or sets a value for the cookie used in the **Cookie** HTTP header.

A value for the cookie.

Converts a string to an HttpCookiePairHeaderValue instance.

A string that represents the cookie name and value in the **Cookie** HTTP header. An HttpCookiePairHeaderValue instance.

Returns a string that represents the current HttpCookiePairHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpCookiePairHeaderValue information.

The string to validate. The HttpCookiePairHeaderValue version of the string. **true** if *input* is valid HttpCookiePairHeaderValue information; otherwise, **false**.

Represents the value of the **Cookie** HTTP header on an HTTP request.

Gets the number of HttpCookiePairHeaderValue objects in the collection.

The number of HttpCookiePairHeaderValue objects in the HttpCookiePairHeaderValueCollection.

Adds a new HttpCookiePairHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpCookiePairHeaderValue item in the collection.

An object that can be used to enumerate the HttpCookiePairHeaderValue items in the collection. The iterator points to the first HttpCookiePairHeaderValue item in the HttpCookiePairHeaderValueCollection.

Returns the HttpCookiePairHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpCookiePairHeaderValue at the specified index in the HttpCookiePairHeaderValueCollection.

Retrieves the HttpCookiePairHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpCookiePairHeaderValue items in the HttpCookiePairHeaderValueCollection. An array of HttpCookiePairHeaderValue items that start at *startIndex* in the HttpCookiePairHeaderValueCollection. The number of HttpCookiePairHeaderValue items retrieved.

Returns an immutable view of the HttpCookiePairHeaderValueCollection.

The view of the HttpCookiePairHeaderValueCollection.

Retrieves the index of an HttpCookiePairHeaderValue in the collection.

The HttpCookiePairHeaderValue to find in the HttpCookiePairHeaderValueCollection. The index of the HttpCookiePairHeaderValue in the HttpCookiePairHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpCookiePairHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpCookiePairHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpCookiePairHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpCookiePairHeaderValue item from the collection.

Replaces all the HttpCookiePairHeaderValue items in the collection with the specified HttpCookiePairHeaderValue items.

The HttpCookiePairHeaderValue items to add to the collection.

Sets the HttpCookiePairHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpCookiePairHeaderValue. The item to set.

Returns a string that represents the current HttpCookiePairHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpCookiePairHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents the value of the **Authorization** or **Proxy-Authorization** HTTP header on an HTTP request.

Initializes a new instance of the HttpCredentialsHeaderValue class with the scheme to use for authentication.

The scheme to use for authentication.

Initializes a new instance of the HttpCredentialsHeaderValue class with the scheme and user token information to use for authentication.

The scheme to use for authentication. The user token information to use for authentication.

Gets a set of name/value pairs included in the **Authorization** or **Proxy-Authorization** HTTP header.

A set of name/value pairs.

Gets the scheme to use for authentication.

The scheme to use for authentication.

Gets the user token information used in the **Authorization** or **Proxy-Authorization** HTTP header.

The user token information in the **Authorization** or **Proxy-Authorization** HTTP header.

Converts a string to an HttpCredentialsHeaderValue instance.

A string that represents the credential information in the **Authorization** or **Proxy-Authorization** HTTP header. An HttpCredentialsHeaderValue instance.

Returns a string that represents the current HttpCredentialsHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpCredentialsHeaderValue information.

The string to validate. The HttpCredentialsHeaderValue version of the string. **true** if *input* is valid HttpCredentialsHeaderValue information; otherwise, **false**.

Represents the value of the **Retry-After** HTTP header on an HTTP response.

Gets the value of the **HTTP-date** information used in the **Retry-After** HTTP header.

The value of the **HTTP-date** information.

Gets the value of the **delta-seconds** information used in the **Retry-After** HTTP header.

The value of the **delta-seconds** information.

Converts a string to an HttpDateOrDeltaHeaderValue instance.

A string that represents the **HTTP-date** or **delta-seconds** information in the **Retry-After** HTTP header. An HttpDateOrDeltaHeaderValue instance.

Returns a string that represents the current HttpDateOrDeltaHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpDateOrDeltaHeaderValue information.

The string to validate. The HttpDateOrDeltaHeaderValue version of the string. **true** if *input* is valid HttpDateOrDeltaHeaderValue information; otherwise, **false**.

Represents a token for a particular server behavior required by the client that is used in the **Expect** HTTP header on an HTTP request.

Initializes a new instance of the HttpExpectationHeaderValue class with a name.

A token that represents a name used in the **Expect** HTTP header.

Initializes a new instance of the HttpExpectationHeaderValue class with a name and value for the name.

A token that represents a name used in the **Expect** HTTP header. A value for the name used in the **Expect** HTTP header.

Gets or sets a token that represents a name for a server behavior used in the **Expect** HTTP header.

A token that represents the name for a server behavior.

Gets a set of parameters for a server behavior included in the **Expect** HTTP header.

A set of parameters for a server behavior.

Gets or sets a value for a server behavior used in the **Expect** HTTP header.

A value for a server behavior used in the **Expect** HTTP header.

Converts a string to an HttpExpectationHeaderValue instance.

A string that represents the information in the **Expect** HTTP header. An HttpExpectationHeaderValue instance.

Returns a string that represents the current HttpExpectationHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpCredentialsHeaderValue information.

The string to validate. The HttpExpectationHeaderValue version of the string. **true** if *input* is valid HttpExpectationHeaderValue information; otherwise, **false**.

Represents the value of the **Expect** HTTP header on an HTTP request.

Gets the number of HttpExpectationHeaderValue objects in the collection.

The number of HttpExpectationHeaderValue objects in the HttpExpectationHeaderValueCollection.

Adds a new HttpExpectationHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpExpectationHeaderValue item in the collection.

An object that can be used to enumerate the HttpExpectationHeaderValue items in the collection. The iterator points to the first HttpExpectationHeaderValue item in the HttpExpectationHeaderValueCollection.

Returns the HttpExpectationHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpExpectationHeaderValue at the specified index in the HttpExpectationHeaderValueCollection.

Retrieves the HttpExpectationHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpExpectationHeaderValue items in the HttpExpectationHeaderValueCollection. An array of HttpExpectationHeaderValue items that start at *startIndex* in the HttpExpectationHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpExpectationHeaderValueCollection.

The view of the HttpExpectationHeaderValueCollection.

Retrieves the index of an HttpExpectationHeaderValue in the collection.

The HttpExpectationHeaderValue to find in the HttpExpectationHeaderValueCollection. The index of the HttpExpectationHeaderValue in the HttpExpectationHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpExpectationHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpExpectationHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpExpectationHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpExpectationHeaderValue item from the collection.

Replaces all the HttpExpectationHeaderValue items in the collection with the specified HttpExpectationHeaderValue items.

The HttpExpectationHeaderValue items to add to the collection.

Sets the HttpExpectationHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpExpectationHeaderValue. The item to set.

Returns a string that represents the current HttpExpectationHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpExpectationHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents the value of the **Content-Language** HTTP header on HTTP content in a request or a response.

Gets the number of Language objects in the collection.

the number of Language objects in the HttpLanguageHeaderValueCollection.

Adds a new Language item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first Language item in the collection.

An object that can be used to enumerate the Language items in the collection. The iterator points to the first Language item in the HttpLanguageHeaderValueCollection.

Returns the Language item at the specified index in the collection.

The zero-based index of a specified item in the collection. The Language item at the specified index in the HttpLanguageHeaderValueCollection.

Retrieves the Language items that start at the specified index in the collection.

The zero-based index of the start of the Language items in the HttpLanguageHeaderValueCollection. An array of Language items that start at *startIndex* in the HttpLanguageHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpLanguageHeaderValueCollection.

The view of the HttpLanguageHeaderValueCollection.

Retrieves the index of a Language in the collection.

The item to find in the HttpLanguageHeaderValueCollection. The index of the Language item in the HttpLanguageHeaderValueCollection. Indicates whether the item is found.

Inserts a Language into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpLanguageHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpLanguageHeaderValueCollection.

The index of the entry to remove.

Removes the last Language item from the collection.

Replaces all the Language items in the collection with the specified Language items.

The Language items to add to the collection.

Sets the Language at the specified index in the collection.

The zero-based index at which to set the Language. The item to set.

Returns a string that represents the current HttpLanguageHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpLanguageHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents accept language information used in the **Accept-Language** HTTP header on an HTTP request.

Initializes a new instance of the HttpLanguageRangeWithQualityHeaderValue class with language-range information.

The value of the **language-range** information used in the **Accept-Language** HTTP header.

Initializes a new instance of the HttpLanguageRangeWithQualityHeaderValue class with language-range and quality information.

The value of the **language-range** information used in the **Accept-Language** HTTP header. The value of the **qvalue** or quality factor used in the **Accept-Language** HTTP header.

Gets the value of the **language-range** information from the HttpLanguageRangeWithQualityHeaderValue used in the **Accept-Language** HTTP header.

The value of the **language-range** information.

Gets the value of the **qvalue** or quality factor from the HttpLanguageRangeWithQualityHeaderValue used in the **Accept-Language** HTTP header.

The value of the **qvalue** or quality factor.

Converts a string to an HttpLanguageRangeWithQualityHeaderValue instance.

A string that represents the language-range and quality factor information used in the **Accept-Encoding** HTTP header. An HttpLanguageRangeWithQualityHeaderValue instance.

Returns a string that represents the current HttpLanguageRangeWithQualityHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpLanguageRangeWithQualityHeaderValue information.

The string to validate. The HttpLanguageRangeWithQualityHeaderValue version of the string. **true** if *input* is valid HttpLanguageRangeWithQualityHeaderValue information; otherwise, **false**.

Represents the value of the **Accept-Language** HTTP header on an HTTP request.

Gets the number of HttpLanguageRangeWithQualityHeaderValue objects in the collection.

The number of HttpLanguageRangeWithQualityHeaderValue objects in the HttpLanguageRangeWithQualityHeaderValueCollection.

Adds a new HttpLanguageRangeWithQualityHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpLanguageRangeWithQualityHeaderValue item in the collection.

An object that can be used to enumerate the HttpLanguageRangeWithQualityHeaderValue items in the collection. The iterator points to the first HttpLanguageRangeWithQualityHeaderValue item in the HttpLanguageRangeWithQualityHeaderValueCollection.

Returns the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpLanguageRangeWithQualityHeaderValue at the specified index in the HttpLanguageRangeWithQualityHeaderValueCollection.

Retrieves the HttpLanguageRangeWithQualityHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpLanguageRangeWithQualityHeaderValue items in the HttpLanguageRangeWithQualityHeaderValueCollection. An array of HttpLanguageRangeWithQualityHeaderValue items that start at *startIndex* in the HttpLanguageRangeWithQualityHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpLanguageRangeWithQualityHeaderValueCollection.

The view of the HttpLanguageRangeWithQualityHeaderValueCollection.

Retrieves the index of an HttpLanguageRangeWithQualityHeaderValue in the collection.

The HttpLanguageRangeWithQualityHeaderValue to find in the HttpLanguageRangeWithQualityHeaderValueCollection. The index of the HttpLanguageRangeWithQualityHeaderValue in the HttpLanguageRangeWithQualityHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpLanguageRangeWithQualityHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpLanguageRangeWithQualityHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpLanguageRangeWithQualityHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpLanguageRangeWithQualityHeaderValue item from the collection.

Replaces all the HttpLanguageRangeWithQualityHeaderValue items in the collection with the specified HttpLanguageRangeWithQualityHeaderValue items.

The HttpLanguageRangeWithQualityHeaderValue items to add to the collection.

Sets the HttpLanguageRangeWithQualityHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpLanguageRangeWithQualityHeaderValue. The item to set.

Returns a string that represents the current HttpLanguageRangeWithQualityHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpLanguageRangeWithQualityHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents the value of the **Content-Type** HTTP header on the HTTP content in a request or a response.

Initializes a new instance of the HttpMediaTypeHeaderValue class.

The **media-type** of the entity-body used in the **Content-Type** HTTP header.

Gets or sets the character set of the entity-body used in the **Content-Type** HTTP header.

The character set of the entity-body.

Gets or sets the **media-type** of the entity-body used in the **Content-Type** HTTP header.

The **media-type** of the entity-body.

Gets a set of parameters included in the **Content-Type** HTTP header.

A set of parameters.

Converts a string to an HttpMediaTypeHeaderValue instance.

A string that represents the media-type and character set information used in the **Content-Type** HTTP header. An HttpMediaTypeHeaderValue instance.

Returns a string that represents the current HttpMediaTypeHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpMediaTypeHeaderValue information.

The string to validate. The HttpMediaTypeHeaderValue version of the string. **true** if *input* is valid HttpMediaTypeHeaderValue information; otherwise, **false**.

Represents accept information used in the **Accept** HTTP header on an HTTP request.

Initializes a new instance of the HttpMediaTypeHeaderValue class with a media type.

The **media-type** of the entity-body to accept that is used in the **Accept** HTTP header.

Initializes a new instance of the HttpMediaTypeHeaderValue class with a media type and quality.

The **media-type** of the entity-body to accept that is used in the **Accept** HTTP header. The **qvalue** or quality.

Gets or sets the character set of the content to accept that is used in the **Accept** HTTP header.

The character set of the entity-body.

Gets or sets the **media-type** of the content to accept that is used in the **Accept** HTTP header.

The **media-type** of the entity-body.

Gets a set of parameters included in the **Accept** HTTP header.

A set of parameters.

Get or set the **qvalue** or quality used in the **Accept** HTTP header.

The **qvalue** or quality.

Converts a string to an HttpMediaTypeWithQualityHeaderValue instance.

A string that represents the media-type, character set, and quality information used in the **Accept** HTTP header. An HttpMediaTypeWithQualityHeaderValue instance.

Returns a string that represents the current HttpMediaTypeWithQualityHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpMediaTypeWithQualityHeaderValue information.

The string to validate. The HttpMediaTypeWithQualityHeaderValue version of the string. **true** if *input* is valid HttpMediaTypeWithQualityHeaderValue information; otherwise, **false**.

Represents the value of the **Accept** HTTP header on an HTTP request.

Gets the number of HttpMediaTypeWithQualityHeaderValue objects in the collection.

The number of HttpMediaTypeWithQualityHeaderValue objects in the HttpMediaTypeWithQualityHeaderValueCollection.

Adds a new HttpMediaTypeWithQualityHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpMediaTypeWithQualityHeaderValue item in the collection.

An object that can be used to enumerate the HttpMediaTypeWithQualityHeaderValue items in the collection. The iterator points to the first HttpMediaTypeWithQualityHeaderValue item in the HttpMediaTypeWithQualityHeaderValueCollection.

Returns the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpMediaTypeWithQualityHeaderValue at the specified index in the HttpMediaTypeWithQualityHeaderValueCollection.

Retrieves the HttpMediaTypeWithQualityHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpMediaTypeWithQualityHeaderValue items in the HttpMediaTypeWithQualityHeaderValueCollection. An array of HttpMediaTypeWithQualityHeaderValue items that start at *startIndex* in the HttpMediaTypeWithQualityHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpMediaTypeWithQualityHeaderValueCollection.

The view of the HttpMediaTypeWithQualityHeaderValueCollection.

Retrieves the index of an HttpMediaTypeWithQualityHeaderValue in the collection.

The HttpMediaTypeWithQualityHeaderValue to find in the HttpMediaTypeWithQualityHeaderValueCollection. The index of the HttpMediaTypeWithQualityHeaderValue in the HttpMediaTypeWithQualityHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpMediaTypeWithQualityHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpMediaTypeWithQualityHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpMediaTypeWithQualityHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpMediaTypeWithQualityHeaderValue item from the collection.

Replaces all the HttpMediaTypeWithQualityHeaderValue items in the collection with the specified HttpMediaTypeWithQualityHeaderValue items.

The HttpMediaTypeWithQualityHeaderValue items to add to the collection.

Sets the HttpMediaTypeWithQualityHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpMediaTypeWithQualityHeaderValue. The item to set.

Returns a string that represents the current HttpMediaTypeWithQualityHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpMediaTypeWithQualityHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents the value of the **Allow** HTTP header on an HTTP response.

Gets the number of HttpMethod objects in the collection.

The number of HttpMethod objects in the HttpMethodHeaderValueCollection.

Adds a new HttpMethod item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpMethod item in the collection.

An object that can be used to enumerate the HttpMethod items in the collection. The iterator points to the first HttpMethod item in the HttpMethodHeaderValueCollection.

Returns the HttpMethod at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpMethod at the specified index in the HttpMethodHeaderValueCollection.

Retrieves the HttpMethod items that start at the specified index in the collection.

The zero-based index of the start of the HttpMethod items in the HttpMethodHeaderValueCollection. An array of HttpMethod items that start at *startIndex* in the HttpMethodHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpMethodHeaderValueCollection.

The view of the HttpMethodHeaderValueCollection.

Retrieves the index of an HttpMethod in the collection.

The HttpMethod to find in the HttpMethodHeaderValueCollection. The index of the HttpMethod in the HttpMethodHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpMethod into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpMethodHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpMethodHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpMethod item from the collection.

Replaces all the HttpMethod items in the collection with the specified HttpMethod items.

The HttpMethod items to add to the collection.

Sets the HttpMethod at the specified index in the collection.

The zero-based index at which to set the HttpMethod. The item to set.

Returns a string that represents the current HttpMethodHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpMethodHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Represents name and value information used in a number of HTTP headers.

Initializes a new instance of the HttpNameValueHeaderValue class. with a name.

The name to be used.

Initializes a new instance of the HttpNameValueHeaderValue class. with a name and value.

The name to be used. The value to associate with the *name*.

Gets the name used in the HttpNameValueHeaderValue object.

The name used in the HttpNameValueHeaderValue object.

Gets or sets the value associated with a name used in the HttpNameValueHeaderValue object.

The value associated with a name used in the HttpNameValueHeaderValue object.

Converts a string to an HttpNameValueHeaderValue instance.

A string that represents the name and value. An HttpNameValueHeaderValue instance.

Returns a string that represents the current HttpNameValueHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpNameValueHeaderValue information.

The string to validate. The HttpNameValueHeaderValue version of the string. **true** if *input* is valid HttpNameValueHeaderValue information; otherwise, **false**.

Represents product information used by the HttpProductHeaderValue and HttpProductInfoHeaderValueCollection classes in the **User-Agent** HTTP header.

Initializes a new instance of the HttpProductHeaderValue class with a product name.

The name of the product token used in the **User-Agent** HTTP header.

Initializes a new instance of the HttpProductHeaderValue class with a product name and a product version.

The name of the product token used in the **User-Agent** HTTP header. The version of the product token used in the **User-Agent** HTTP header.

Gets a token that represents the name of the product to be used in the **User-Agent** HTTP header.

The name of the product token

Gets a token that represents the version of the product to be used in the **User-Agent** HTTP header.

The version of the product token.

Converts a string to an HttpProductHeaderValue instance.

A string that represents the product name and version. An HttpProductHeaderValue instance.

Returns a string that represents the current HttpProductHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpProductHeaderValue information.

The string to validate. The HttpProductHeaderValue version of the string. **true** if *input* is valid HttpProductHeaderValue information; otherwise, **false**.

Represents product information used in the **User-Agent** HTTP header on an HTTP request.

Initializes a new instance of the HttpProductInfoHeaderValue class with a product comment.

The product comment used in the **User-Agent** HTTP header.

Initializes a new instance of the HttpProductInfoHeaderValue class with a product name and version.

The name of the product token used in the **User-Agent** HTTP header. The version of the product token used in the **User-Agent** HTTP header.

Gets the product comment from the HttpProductInfoHeaderValue used in the **User-Agent** HTTP header.

The product comment used in the **User-Agent** HTTP header.

Gets the product from the HttpProductInfoHeaderValue used in the **User-Agent** HTTP header.

The product name and version used in the **User-Agent** HTTP header.

Converts a string to an HttpProductInfoHeaderValue instance.

A string that represents the product information. An HttpProductInfoHeaderValue instance.

Returns a string that represents the current HttpProductInfoHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpProductInfoHeaderValue information.

The string to validate. The HttpProductInfoHeaderValue version of the string. **true** if *input* is valid HttpProductInfoHeaderValue information; otherwise, **false**.

Represents the value of the **User-Agent** HTTP header on an HTTP request.

Gets the number of HttpProductInfoHeaderValue objects in the collection.

The number of HttpProductInfoHeaderValue objects in the HttpProductInfoHeaderValueCollection.

Adds a new HttpProductInfoHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpProductInfoHeaderValue item in the collection.

An object that can be used to enumerate the HttpProductInfoHeaderValue items in the collection. The iterator points to the first HttpProductInfoHeaderValue item in the HttpProductInfoHeaderValueCollection.

Returns the HttpProductInfoHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpProductInfoHeaderValue at the specified index in the HttpProductInfoHeaderValueCollection.

Retrieves the HttpProductInfoHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpProductInfoHeaderValue items in the HttpProductInfoHeaderValueCollection. An array of HttpProductInfoHeaderValue items that start at *startIndex* in the HttpProductInfoHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpProductInfoHeaderValueCollection.

The view of the HttpProductInfoHeaderValueCollection.

Retrieves the index of an HttpProductInfoHeaderValue in the collection.

The HttpProductInfoHeaderValue to find in the HttpProductInfoHeaderValueCollection. The index of the HttpProductInfoHeaderValue in the HttpProductInfoHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpProductInfoHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpProductInfoHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpMethodHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpProductInfoHeaderValue item from the collection.

Replaces all the HttpProductInfoHeaderValue items in the collection with the specified HttpProductInfoHeaderValue items.

The HttpProductInfoHeaderValue items to add to the collection.

Sets the HttpProductInfoHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpProductInfoHeaderValue. The item to set.

Returns a string that represents the current HttpProductInfoHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpProductInfoHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Provides a collection of the HTTP headers associated with an HTTP request.

Gets the HttpMediaTypeWithQualityHeaderValueCollection of HttpMediaTypeWithQualityHeaderValue objects that represent the value of an **Accept** HTTP header on an HTTP request.

The collection of HttpMediaTypeWithQualityHeaderValue objects that represent the value of an **Accept** HTTP header. An empty collection means that the header is absent.

Gets the HttpContentCodingWithQualityHeaderValueCollection of HttpContentCodingWithQualityHeaderValue objects that represent the value of an **Accept-Encoding** HTTP header on an HTTP request.

The collection of HttpContentCodingWithQualityHeaderValue objects that represent the value of an **Accept-Encoding** HTTP header. An empty collection means that the header is absent.

Gets the HttpLanguageRangeWithQualityHeaderValueCollection of HttpLanguageRangeWithQualityHeaderValue objects that represent the value of an **Accept-Language** HTTP header on an HTTP request.

The collection of HttpLanguageRangeWithQualityHeaderValue objects that represent the value of an **Accept-Language** HTTP header. An empty collection means that the header is absent.

Gets or sets the HttpCredentialsHeaderValue object that represents the value of an **Authorization** HTTP header on an HTTP request.

The value of an **Authorization** HTTP header on an HTTP request. A null value means that the header is absent.

Gets the HttpCacheDirectiveHeaderValueCollection that represents the value of a **Cache-Control** HTTP header on an HTTP request.

The object that represents the value of a **Cache-Control** HTTP header. An empty collection means that the header is absent.

Gets the HttpConnectionOptionHeaderValueCollection of HttpConnectionOptionHeaderValue objects that represent the value of a **Connection** HTTP header on an HTTP request.

The collection of HttpConnectionOptionHeaderValue objects that represent the HTTP **Connection** header. An empty collection means that the header is absent.

Gets the HttpCookiePairHeaderValueCollection of HttpCookiePairHeaderValue objects that represent the value of an **Cookie** HTTP header sent on an HTTP request.

The collection of HttpCookiePairHeaderValue objects that represent the HTTP cookies in a **Cookie** HTTP header. An empty collection means that the header is absent.

Gets or sets the DateTime object that represents the value of a **Date** HTTP header on an HTTP request.

The object that represents the value of a **Date** HTTP header on an HTTP request. A null value means that the header is absent.

Gets the HttpExpectationHeaderValueCollection of HttpExpectationHeaderValue objects that represent the value of an **Expect** HTTP header on an HTTP request.

The collection of HttpExpectationHeaderValue objects that represent the value of an **Expect** HTTP header on an HTTP request. An empty collection means that the header is absent.

Gets or sets the String that represents the value of a **From** HTTP header on an HTTP request.

The value of a **From** HTTP header on an HTTP request. An empty string means that the header is absent.

Gets or sets the HostName that represents the value of a **Host** HTTP header on an HTTP request.

The HostName that represents the value of a **Host** HTTP header on an HTTP request. A null value means that the header is absent.

Gets or sets the DateTime object that represents the value of an **If-Modified-Since** HTTP header on an HTTP request.

The DateTime object that represents the value of an **If-Modified-Since** HTTP header on an HTTP request. A null value means that the header is absent.

Gets or sets the DateTime object that represents the value of an **If-Unmodified-Since** HTTP header on an HTTP request.

The DateTime object that represents the value of an **If-Unmodified-Since** HTTP header on an HTTP request. A null value means that the header is absent.

Gets or sets an integer value that represents the value of a **Max-Forwards** HTTP header on an HTTP request.

An integer value that represents the value of a **Max-Forwards** HTTP header on an HTTP request. A null value means that the header is absent.

Gets or sets the HttpCredentialsHeaderValue object that represent the value of a **Proxy-Authorization** HTTP header on an HTTP request.

The object that represent the value of a **Proxy-Authorization** HTTP header on an HTTP request. A null value means that the header is absent.

Gets or sets the Uri that represents the value of a **Referer** HTTP header on an HTTP request.

The object that represents the value of a **Referer** HTTP header on an HTTP request. A null value means that the header is absent.

Gets the number of objects in the HttpRequestHeaderCollection.

The number of objects in the HttpRequestHeaderCollection.

Gets the HttpTransferCodingHeaderValueCollection of HttpTransferCodingHeaderValue objects that represent the value of a **Transfer-Encoding** HTTP header on an HTTP request.

The collection of HttpTransferCodingHeaderValue objects that represent the value of a **Transfer-Encoding** HTTP header on an HTTP request. An empty collection means that the header is absent.

Gets the HttpProductInfoHeaderValueCollection of HttpProductInfoHeaderValue objects that represent the value of a **User-Agent** HTTP header on an HTTP request.

The collection of HttpProductInfoHeaderValue objects that represent the value of a **User-Agent** HTTP header on an HTTP request. An empty collection means that the header is absent.

Adds a new item to the end of the HttpRequestHeaderCollection.

The name of the value to add. The item value to add.

Removes all objects from the HttpRequestHeaderCollection.

Retrieves an iterator to the first item in the HttpRequestHeaderCollection.

An object that can be used to enumerate the items in the collection. The iterator points to the first item in the HttpRequestHeaderCollection.

Returns an immutable view of the HttpRequestHeaderCollection.

The view of the HttpRequestHeaderCollection.

Determines whether the HttpRequestHeaderCollection contains the specified key.

The key associated with the item to locate. **true** if the key is found; otherwise, **false**.

Inserts or replaces an item in the HttpRequestHeaderCollection with the specified key and value.

The key of the item to be inserted. The value of the item to insert. **true** if an item with the specified key is an existing item that was replaced; otherwise **false**.

Finds an item in the HttpRequestHeaderCollection if it exists.

The key of the item to lookup. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes a specific object from the HttpRequestHeaderCollection.

The key of the item to remove.

Returns a string that represents the current HttpRequestHeaderCollection object.

A string that represents the current object.

Try to append the specified item to the HttpRequestHeaderCollection without validation.

The name of the item to append. The value of the item to append. **true** if the item was appended; otherwise **false**.

Provides a collection of the HTTP headers associated with an HTTP response.

Gets or sets the TimeSpan object that represents the value of an **Age** HTTP header on an HTTP response.

The object that represents the value of an **Age** HTTP header on an HTTP response. A **null** value means that the header is absent.

Gets the HttpMethodHeaderValueCollection of HttpMethod objects that represent the value of an **Allow** HTTP header on an HTTP response.

The collection of HttpMethod objects that represent the value of an **Allow** HTTP header on an HTTP response. An empty collection means that the header is absent.

Gets the HttpCacheDirectiveHeaderValueCollection of objects that represent the value of a **Cache-Control** HTTP header on an HTTP response.

The collection of objects that represent the value of a **Cache-Control** HTTP header on an HTTP response. An empty collection means that the header is absent.

Gets the HttpConnectionOptionHeaderValueCollection of HttpConnectionOptionHeaderValue objects that represent the value of a **Connection** HTTP header on an HTTP response.

The collection of HttpConnectionOptionHeaderValue objects that represent the value of a **Connection** HTTP header. An empty collection means that the header is absent.

Gets or sets the DateTime object that represents the value of a **Date** HTTP header on an HTTP response.

The object that represents the value of a **Date** HTTP header on an HTTP request. A **null** value means that the header is absent.

Gets or sets the Uri that represents the value or a **Location** HTTP header on an HTTP response.

The object that represents the value of a **Location** HTTP header on an HTTP response. A **null** value means that the header is absent.

Gets the HttpChallengeHeaderValueCollection of HttpChallengeHeaderValue objects that represent the value of a **Proxy-Authenticate** HTTP header on an HTTP response.

The collection of HttpChallengeHeaderValue objects that represent the value of a **Proxy-Authenticate** HTTP header on an HTTP response. An empty collection means that the header is absent.

Gets or sets the HttpDateOrDeltaHeaderValue object that represent the value of a **Retry-After** HTTP header on an HTTP response.

The object that represents the value of a **Retry-After** HTTP header on an HTTP response. A **null** value means that the header is absent.

Gets the number of objects in the HttpResponseHeaderCollection.

The number of objects in the HttpResponseHeaderCollection.

Gets the HttpTransferCodingHeaderValueCollection of HttpTransferCodingHeaderValue objects that represent the value of a **Transfer-Encoding** HTTP header on an HTTP response.

The collection of HttpTransferCodingHeaderValue objects that represent the value of a **Transfer-Encoding** HTTP header on an HTTP response. An empty collection means that the header is absent.

Gets the HttpChallengeHeaderValueCollection of HttpChallengeHeaderValue objects that represent the value of a **WWW-Authenticate** HTTP header on an HTTP response.

The collection of HttpChallengeHeaderValue objects that represent the value of a **WWW-Authenticate** HTTP header on an HTTP response. An empty collection means that the header is absent.

Adds a new item to the end of the HttpResponseHeaderCollection.

The name of the value to add. The item value to add.

Removes all objects from the collection.

Retrieves an iterator to the first item in the HttpResponseHeaderCollection.

An object that can be used to enumerate the items in the collection. The iterator points to the first item in the HttpResponseHeaderCollection.

Returns an immutable view of the HttpResponseHeaderCollection.

The view of the HttpResponseHeaderCollection.

Determines whether the HttpResponseHeaderCollection contains the specified key.

The key associated with the item to locate. **true** if the key is found; otherwise, **false**.

Inserts or replaces an item in the HttpResponseHeaderCollection with the specified key and value.

The key of the item to be inserted. The value of the item to insert. **true** if an item with the specified key is an existing item that was replaced; otherwise **false**.

Lookup an item in the HttpResponseHeaderCollection.

The key of the item to lookup. The value, if an item with the specified key exists. Use the **HasKey** method to determine whether the key exists.

Removes an item with a given key from the HttpResponseHeaderCollection.

Key of the item to be removed.

Returns a string that represents the current HttpResponseHeaderCollection object.

A string that represents the current object.

Try to append the specified item to the HttpResponseHeaderCollection without validation.

The name of the item to append. The value of the item to append. **true** if the item was appended; otherwise **false**.

Represents transfer coding information used in the **Transfer-Encoding** HTTP header on an HTTP request.

Initializes a new instance of the HttpProductInfoHeaderValue class.

The **transfer-coding** information to initialize the HttpProductInfoHeaderValue object.

Gets a set of parameters used in the **Transfer-Encoding** HTTP header.

A set of name/value parameters used in the **Transfer-Encoding** HTTP header.

Gets the transfer-coding value used in the **Transfer-Encoding** HTTP header.

The transfer-coding value (transfer-coding name) used in the **Transfer-Encoding** HTTP header.

Converts a string to an HttpTransferCodingHeaderValue instance.

A string that represents the **transfer-coding** information. An HttpProductInfoHeaderValue instance.

Returns a string that represents the current HttpTransferCodingHeaderValue object.

A string that represents the current object.

Determines whether a string is valid HttpTransferCodingHeaderValue information.

The string to validate. The HttpTransferCodingHeaderValue version of the string. **true** if *input* is valid HttpTransferCodingHeaderValue information; otherwise, **false**.

Represents the value of the **Transfer-Encoding** HTTP header on an HTTP request.

Gets the number of HttpTransferCodingHeaderValue objects in the collection.

The number of HttpTransferCodingHeaderValue objects in the HttpTransferCodingHeaderValueCollection.

Adds a new HttpTransferCodingHeaderValue item to the end of the collection.

The new item to add.

Removes all objects from the collection.

Retrieves an iterator to the first HttpTransferCodingHeaderValue item in the collection.

An object that can be used to enumerate the HttpTransferCodingHeaderValue items in the collection. The iterator points to the first HttpTransferCodingHeaderValue item in the HttpTransferCodingHeaderValueCollection.

Returns the HttpTransferCodingHeaderValue at the specified index in the collection.

The zero-based index of a specified item in the collection. The HttpTransferCodingHeaderValue at the specified index in the HttpTransferCodingHeaderValueCollection.

Retrieves the HttpTransferCodingHeaderValue items that start at the specified index in the collection.

The zero-based index of the start of the HttpTransferCodingHeaderValue items in the HttpTransferCodingHeaderValueCollection. An array of HttpTransferCodingHeaderValue items that start at *startIndex* in the HttpTransferCodingHeaderValueCollection. The number of items retrieved.

Returns an immutable view of the HttpTransferCodingHeaderValueCollection.

The view of the HttpTransferCodingHeaderValueCollection.

Retrieves the index of an HttpTransferCodingHeaderValue in the collection.

The HttpTransferCodingHeaderValue to find in the HttpTransferCodingHeaderValueCollection. The index of the HttpTransferCodingHeaderValue in the HttpTransferCodingHeaderValueCollection. Indicates whether the item is found.

Inserts an HttpTransferCodingHeaderValue into the collection at the specified index.

The zero-based index at which *value* should be inserted. The object to insert into the collection.

Parses and adds an entry to the HttpTransferCodingHeaderValueCollection.

The entry to add.

Removes the entry at the specified index from the HttpTransferCodingHeaderValueCollection.

The index of the entry to remove.

Removes the last HttpTransferCodingHeaderValue item from the collection.

Replaces all the HttpTransferCodingHeaderValue items in the collection with the specified HttpTransferCodingHeaderValue items.

The HttpTransferCodingHeaderValue items to add to the collection.

Sets the HttpTransferCodingHeaderValue at the specified index in the collection.

The zero-based index at which to set the HttpTransferCodingHeaderValue. The item to set.

Returns a string that represents the current HttpTransferCodingHeaderValueCollection object.

A string that represents the current object.

Tries to parse and add the specified item to the HttpTransferCodingHeaderValueCollection.

The item to parse and add. **true** if the item successfully parsed and was added; otherwise **false**.

Encapsulates the data and methods needed to retrieve feeds from a URI asynchronously. It supports authentication.

Gets or sets a Boolean that indicates whether cache will be bypassed when retrieving the feed.

**TRUE** if the cache should be bypassed; otherwise **FALSE**.

Gets or sets the maximum number of bytes to buffer when receiving a response from a server.

Maximum size and default is **UInt32.MaxValue**.

Gets or sets the credentials to use when making requests using a proxy.

Initially, this value is a username/password tuple. For domain credentials, the username is in domain\user form.

Gets or sets the credentials to use when making requests to the server.

Initally, this value is a username/password tuple. For domain credentials, the username is in domain\user form.

Gets or sets the maximum amount of time, in milliseconds, to wait for any of the asynchronous operations to complete. If the operation is not complete within this amount of time, it will fail with a status code indicating that it timed out.

Default value is 30000 (30 seconds). A value of **UInt32.MaxValue** indicates that the syndication client will wait indefinitely for a response.

Initiates an asynchronous operation to download the syndication feed from the given URI. This method instantiates a SyndicationFeed object from the feed string, which can be in one of the formats specified in SyndicationFormat.

The URI from which the feed is downloaded. Contains the results of the operation.

Sets an HTTP header for the request. This method can be called multiple times to set multiple headers. When the same header is set multiple times, the values will be concatenated and separated by ",".

The name of the header. The value of the header.

Represents a generic syndication XML element extension.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Represents text, HTML, or XHTML content. This interface encapsulates elements in *RSS 2.0* or *Atom 1.0* that can have either text, HTML, or XHTML content. In *Atom 1.0* this interface maps to an **atomTextConstruct** in the schema, which can be element **atom:title**, **atom:subtitle**, **atom:rights** or **atom:summary**.

Gets or sets the content of a text content construct like **atom:title**.

The text content.

Gets or sets the type of the content.

This value can be "text", "html", "xhtml" or other media types.

Gets or sets the XML content.

The XML content within the **atom:content** element.

Contains progress information for a data retrieval operation.

The number of bytes that have been received in this data retrieval operation.

The total number of bytes to be received during this data retrieval operation.

Represents a custom attribute not defined in the specification.

Creates a new SyndicationAttribute object.

Creates a new SyndicationAttribute object with the specified **Name**, **Namespace**, and **Value** property values.

The name of the attribute. The namespace of the attribute. The value of the attribute.

Gets the name of the syndication attribute.

The **atom:name** element.

Gets the namespace of the attribute.

The namespace of the attribute.

Gets or sets the value of the attribute.

The value of the attribute.

Represents the category of a feed or an item. This class encapsulates information in the **/rss/channel/item/category** element in *RSS 2.0* or the **atom:category** element in *Atom 1.0*.

Creates a SyndicationCategory object.

Creates a SyndicationCategory object with the specified **term** property.

A string that identifies the category. This parameter represents the required **term** attribute on **atom:category** or the text content of the **category** element in *RSS 2.0*.

Creates SyndicationCategory object with the specified property values.

A string that identifies the category. The scheme of the category. A label for display in end-user applications.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the label for the category. This property represents the **label** attribute on **atom:category**. It provides a label for display in end-user applications.

The **label** attribute on **atom:category**.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the scheme of the category. This property represents the **scheme** attribute on **atom:category** or the **domain** attribute on the **category** element in *RSS 2.0*.

The **scheme** attribute on **atom:category** or the **domain** attribute on the **category** element in *RSS 2.0*.

Gets or sets a string that identifies the category. This property represents the required **term** attribute on **atom:category** or the text content of the **category** element in *RSS 2.0*.

The required **term** attribute on **atom:category** or the text content of the **category** element in *RSS 2.0*.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Implements the ISyndicationClient interface which retrieves feeds from a URI asynchronously.

Creates a new SyndicationClient object.

Creates a new SyndicationClient object with authentication credentials.

Credentials for user authentication.

Gets or sets a **Boolean** value that specifies whether to bypass the cache when retrieving the feed.

**TRUE** if the cache should be bypassed; otherwise **FALSE**.

Gets or sets the maximum number of bytes to buffer when receiving a response from a server.

Maximum size and default is **UInt32.MaxValue**.

Gets or sets the credentials to use when making requests via a proxy.

The PasswordCredential to use.

Gets or sets the credentials to use when making requests to the server.

Initally, this value is a username/password tuple. For domain credentials, the username is in domain\user form.

Gets or sets the maximum amount of time, in milliseconds, to wait for any of the asynchronous operations to complete. If the operation is not complete within this amount of time, it will fail with a status code indicating that it timed out.

Default value is 30000 (30 seconds). A value of **UInt32.MaxValue** indicates that the syndication client will wait indefinitely for a response.

Starts an asynchronous operation to download the syndication feed from the given URI. This method instantiates a SyndicationFeed object from the feed string, which can be in one of the formats specified in SyndicationFormat.

The URI from which the feed is downloaded. Contains the results of the operation.

Sets an HTTP header for the request. This method can be called multiple times to set multiple headers. When the same header is set multiple times, the values will be concatenated and separated by ",".

The name of the header. The value of the header.

Represents feed content including Text, HTML, XHTML, URL, and XML. This object encapsulates the **atom:content** element in *Atom 1.0* and can contain a link to external content.

Creates a new SyndicationContent object.

Creates a new SyndicationContent object with the specified **Text** and **Type** property values.

The text of the content. The type of the content.

Creates a new SyndicationContent object with the specified **Uri** property value.

The Uri value.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the URI to the content. This property represents the **src** attribute on **atom:content**.

The **src** attribute on **atom:content**.

Gets the syndication content.

The text of the syndication content.

Gets or sets the type of the content.

This value can be "text", "html", "xhtml" or other media types.

Gets or sets the XML content.

The XML content within the **atom:content** element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Represents an error encountered during a Syndication operation.

Gets the specific error using the returned **HRESULT** value. Possible values are defined by SyndicationErrorStatus.

An **HRESULT** returned during the operation. The error encountered.

Defines errors encountered during a Syndication operation.

The provided XML is not valid.

A required attribute is missing.

A required element is missing.

An unexpected error was encountered with the content.

An unknown error has occurred.

The content is not presented in a supported format.

Contains information about a feed. This class encapsulates the information in the **/rss/channel** element in *RSS 2.0* or the **atom:feed** element in *Atom 1.0*.

Creates a new SyndicationFeed object.

Creates a new SyndicationFeed object with a **Title**, **Subtitle**, and **Uri**.

The **Title** of the syndication feed. The **Subtitle** of the syndication feed. The Uri value.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets the authors of an item. This property represents the collection of all the **atom:author** elements under **atom:entry**.

The collection of all the **atom:author** elements under **atom:entry**.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets a collection of categories of the feed. This property represents the collection of all the **atom:category** elements under **atom:feed**.

The collection of all **atom:category** elements under **atom:feed**.

Gets a collection of the contributors of the feed. This property represents the collection of all the **atom:contributor** elements under **atom:feed**.

The collection of all **atom:contributor** elements under **atom:feed**.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets the first Uniform Resource Identifier (URI) in a sequence. This property represents the **atom:link** element with attribute **rel=”first”**.

The **atom:link** element with attribute **rel="first"**. This property is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Gets or sets the generator of the feed. This property represents the **atom:generator** element or the **generator** element in *RSS 2.0*.

The **atom:generator** element or the **generator** element in *RSS 2.0*.

Gets or sets the Uniform Resource Identifier (URI) for the image for the feed. This property represents the **atom:icon** element.

The **atom:icon** element. It is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Gets or sets the identifier for the syndication feed.

The **atom:Id** element or the **guid** element in *RSS 2.0*.

Gets or sets the Uniform Resource Identifier (URI) of the logo for the feed. This property represents the **atom:logo** element or **image/uri** element in *RSS 2.0*.

The **atom:logo** element or **image/uri** element in *RSS 2.0*.

Gets the collection of items in the feed. This property represents the collection of **atom:entry** elements or a collection of **item** elements in *RSS 2.0*.

The collection of **atom:entry** elements or a collection of **item** elements in *RSS 2.0*.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the time the feed was last modified. This property represents the **/rss/channel/lastBuildDate** or **atom:updated** element.

The **/rss/channel/lastBuildDate** or **atom:updated** element.

Gets the last Uniform Resource Identifier (URI) in the sequence. This property represents the **atom:link** element with attribute **rel=”last”**.

The **atom:link** element with attribute **rel="last"**. It is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Gets the links associated with the feed. This property represents a collection of the **atom:link** elements under **atom:feed**. In *RSS 2.0*, this maps to the **link** element.

A collection of the **atom:link** elements under **atom:feed**. In *RSS 2.0* this maps to the **link** element.

Gets the next Uniform Resource Identifier (URI) in the sequence. This property represents the **atom:link** element with attribute **rel="next"**.

The **atom:link** element with attribute **rel=”next”**. It is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets the previous Uniform Resource Identifier (URI) in the sequence. This property represents the **atom:link** element with attribute **rel="previous"**.

The **atom:link** element with attribute **rel=”previous”**. It is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative Uniform Resource Identifier (URI) string and there is no **xml:base** attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Gets or sets information about the rights for the feed. This property represents the **atom:rights** element or the **copyright** element in *RSS 2.0*.

The **atom:rights** element or the **copyright** element in *RSS 2.0*.

Gets the format of the source document. If the object is not loaded from a document, this property will return **SyndicationFormat_Atom10**.

The format of the source document or **SyndicationFormat_Atom10**.

Gets or sets the subtitle of the feed. This property represents the **atom:subtitle** element or the **description** element in *RSS 2.0*.

The **atom:subtitle** element or the **description** element in *RSS 2.0*.

Gets or sets the title of the syndication feed.

The **atom:title** element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Initializes the object from the given feed string, which can be in either *RSS 2.0* or *Atom 1.0* format.

The feed string, which can be in either *RSS 2.0* or *Atom 1.0* format.

Initializes the SyndicationFeed object from the given DOM object, which can contain XML content in either *RSS 2.0 * or *Atom 1.0* format.

The DOM object which contains XML content in either *RSS 2.0* or *Atom 1.0* format.

Specifies the syndication formats supported by the API.

The API supports the *Atom 0.3* format.

The API supports the *Atom 1.0* format.

The API supports the *RSS 0.91* format.

The API supports the *RSS 0.92* format.

The API supports the *RSS 1.0* format.

The API supports the *RSS 2.0* format.

Describes the agent or the tool used to generate the feed. This class encapsulates information in the **/rss/channel/generator** element in *RSS 2.0* or the **/atom:feed/atom:generator** element in *Atom 1.0*.

Creates a new SyndicationGenerator object.

Creates a new SyndicationGenerator object with the specified **Text** property value.

Identifies the generator. This parameter represents the text content in the **atom:generator** element or the **generator** element in *RSS 2.0*.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the text that identifies the generator.

The text content in the **atom:generator** element or the **generator** element in RSS 2.0.

Gets or sets the Uniform Resource Identifier (URI) of the syndication generator.

The **href** attribute on **atom:link**.

Gets or sets the version of the generator.

The **version** attribute on **atom:generator**.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Represents an item in the feed. This class encapsulates information in the **/rss/channel/item** element in *RSS 2.0* or the **atom:entry** element in *Atom 1.0*.

Creates a new SyndicationItem object.

Creates a new SyndicationItem object with a title, content, and URI.

Title of the new item. The content for this feed item. The URI associated with this item.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets the authors of an item. This property represents the collection of all the **atom:author** elements under **atom:entry**.

The collection of all the **atom:author** elements under **atom:entry**.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets a collection of categories of the feed. This property represents the collection of all the **atom:category** elements under **atom:feed**.

The collection of all **atom:category** elements under **atom:feed**.

Gets or sets the Uniform Resource Identifier (URI) of the comments for the item. This property represents the **/rss/channel/item/comments** element.

The **/rss/channel/item/comments** element.

Gets or sets the content of the item.

The content of the item.

Gets a collection of the contributors of the feed. This property represents the collection of all the **atom:contributor** elements under **atom:feed**.

The collection of all **atom:contributor** elements under **atom:feed**.

Gets the Uniform Resource Identifier (URI) of an editable media resource.

The **atom:link** element with the attribute **rel=”edit-media”**.

Gets the Uniform Resource Identifier (URI) of an editable resource.

The **atom:link** element with **rel="edit"**.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets an ETag HTTP header.

An Etag HTTP header.

Gets or sets the identifier for the syndication feed.

The **atom:Id** element or the **guid** element in *RSS 2.0*.

Gets the Uniform Resource Identifier (URI) of this item. **AtomPubClient** creates this property after new resource is created.

The Uniform Resource Identifier (URI) of the item.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the most recent time the item was modified. This property represents the **atom:updated** element.

The **atom:updated** element.

Gets the links contained in the item.

The collection of all the **atom:link** elements under **atom:entry**.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the date the item was published.

The **atom:published** element under **atom:entry** or the **pubDate** element under **item** element in *RSS 2.0*.

Gets or sets information about the rights of an item. This property represents the **atom:rights** element.

The **atom:rights** element.

Gets or sets the source feed of the item. This property represents the **atom:source** element or the **source** element in *RSS 2.0*.

The **atom:source** element or the **source** element in *RSS 2.0*.

Gets or sets a summary of the item.

The **atom:summary** element or the **description** element in *RSS 2.0*.

Gets or sets the title of the item.

The **atom:title** element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Initializes the object from the given feed string, which can be in either *RSS 2.0* or *Atom 1.0* format.

The feed string, which can be in either *RSS 2.0* or *Atom 1.0* format.

Initializes the object from the given DOM object, which can contain XML content in either *RSS 2.0* or *Atom 1.0* format.

The DOM object, which can contain XML content in either *RSS 2.0* or *Atom 1.0* format.

Represents a link within a syndication feed or item. This class encapsulates information in the **/rss/channel/link** or /**rss/channel/item/link** element in *RSS 2.0* or the **atom:link** element in *Atom 1.0*.

Creates a new SyndicationLink object.

Creates a new SyndicationLink with a **Uri**.

The Uri value.

Creates a new SyndicationLink object with a **Uri**, **Relationship**, **Title**, **MediaType**, and **Length**.

The Uri value. The relationship type. The title of the syndication link. The MediaType of the syndication link. The length, in bytes, of the syndication link.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the length of the linked resource, in bytes.

The **length** attribute on **atom:length**.

Gets or sets the media type of the linked resource. The string must have the pattern ".+/.+".

The **type** attribute on **atom:link**.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the relationship type of the link.

The **rel** attribute on **atom:link**.

Gets or sets the language of the resource pointed to by the **Uri** property. This property represents the **hreflang** attribute on **atom:link**. It must adhere to the pattern defined by .

The language of the resource.

Gets or sets the title of the syndication link.

The **atom:title** element.

Gets or sets the URI of the linked resource.

The **href** attribute on **atom:link**.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Implements the ISyndicationNode interface which represents a generic XML syndication element.

Creates a new SyndicationNode object.

Creates a new SyndicationNode object with the specified **NodeName**, **NodeNamespace**, and **NodeValue** property values.

The local name of the element. It must be valid according to XML 1.0. The namespace of the element. The text content of the element. If the element contains only child elements, this parameter is NULL.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Represents an author or contributor of syndication content.

Creates a SyndicationPerson object.

Creates a SyndicationPerson object with the specified **Name** property value.

The name of the SyndicationPerson. This parameter represents the **atom:name** element.

Creates a SyndicationPerson object with the specified **Name**, **Email**, and **Uri** property values.

The name of the SyndicationPerson. This parameter represents the **atom:name** element. Gets or sets the email address of the person. This property represents the **atom:email** element. Gets or sets the Uniform Resource Identifier (URI) of the person. This property represents the **atom:uri** element. It is the absolute URI resolved against the **xml:base** attribute, if it is present. If the **href** attribute is a relative URI string and there is no **xml:base** attribute, this property is NULL because relative URI is not supported by the runtime URI class.

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the email address of the person.

The **atom:email** element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets the name of the syndication person.

The **atom:name** element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets or sets the Uniform Resource Identifier (URI) of the person. This property represents the **atom:uri** element. It is the absolute Uniform Resource Identifier (URI) resolved against the **xml:base** attribute, if it is present.

The Uniform Resource Identifier (URI) of the person.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Implements the ISyndicationText interface that encapsulates elements in *RSS 2.0* or *Atom 1.0* that can have either text, HTML, or XHTML. In *Atom 1.0*, this object maps to an **atomTextConstruct** in the schema, which can be **atom:title**, **atom:subtitle**, **atom:rights**, or **atom:summary** elements.

Creates a new SyndicationText object.

Creates a new SyndicationText object with the specified **Text** property value.

The content of a text content construct like **atom:title**.

Creates a new SyndicationText object with the specified **Text** and **Type** property values.

The content of a text content construct like **atom:title**. The type of the content. This value can be "text", "html", and "xhtml".

Gets the list of custom attributes of the element.

A list of attributes of the element.

Gets or sets the base URI for the element. This property represents the **xml:base** attribute on the element. It may be inherited from an ancestor element.

The **xml:base** attribute on the element.

Gets the list of child elements within the element.

The list of child elements within the element.

Gets or sets the language of the element. This property represents the **xml:lang** attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

The **xml:lang** attribute on the element.

Gets or sets the local name of the element.

The local name of the element. Must be valid according to XML 1.0.

Gets or sets the namespace of the element.

The namespace of the element.

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

The text content of the element.

Gets the content of a text content construct like **atom:title**.

The text content.

Gets or sets the type of the content.

This value can be "text", "html", "xhtml" or other media types.

Gets or sets the XML content.

The XML content within the **atom:content** element.

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are *Atom 1.0* and *RSS 2.0*.

The format of the data. The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Specifies the text types supported for syndication content.

HTML (escaped markup)

Plain text

XML (not escaped)

Contains progress information for a data transfer operation.

The number of bytes received.

The number of bytes sent.

The total number of bytes that will be received during the transfer operation.

The total number of bytes that will be sent during the transfer operation.

Provides a control that hosts HTML content in an app.

Gets a value that indicates whether there is at least one page in the backward navigation history.

**true** if the IWebViewControl can navigate backward; otherwise, **false**.

Gets a value that indicates whether there is at least one page in the forward navigation history.

**true** if the IWebViewControl can navigate forward; otherwise, **false**.

Gets a value that indicates whether the IWebViewControl contains an element that supports full screen.

A value that indicates whether the IWebViewControl contains an element that supports full screen.

Gets or sets the color to use as the IWebViewControl background when the HTML content does not specify a color.

The background color.

Gets a collection of permission requests that are waiting to be granted or denied.

A collection of WebViewDeferredPermissionRequest objects that are waiting to be granted or denied.

Gets the title of the page currently displayed in the IWebViewControl.

The page title.

Gets a WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

A WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

Gets or sets the Uniform Resource Identifier (URI) source of the HTML content to display in the IWebViewControl.

The Uniform Resource Identifier (URI) source of the HTML content to display in the IWebViewControl.

Occurs when the status of whether the IWebViewControl currently contains a full screen element or not changes.

Occurs when the IWebViewControl has started loading new content.

Occurs when the IWebViewControl has finished parsing the current HTML content.

Occurs when a frame in the IWebViewControl has finished parsing its current HTML content.

Occurs when a frame in the IWebViewControl has finished parsing its current HTML content.

Occurs when a frame in the IWebViewControl has finished loading its content.

Occurs before a frame in the IWebViewControl navigates to new content.

Occurs periodically while the IWebViewControl executes JavaScript, letting you halt the script.

Occurs when the IWebViewControl has finished loading the current content or if navigation has failed.

Occurs before the IWebViewControl navigates to new content.

Occurs when a user performs an action in the IWebViewControl that causes content to be opened in a new window.

Occurs when an action in an IWebViewControl requires that permission be granted.

Occurs when the content contained in the IWebViewControl passes a string to the application by using JavaScript.

Occurs when the IWebViewControl shows a warning page for content that was reported as unsafe by SmartScreen Filter.

Occurs when an attempt is made to navigate to a Uniform Resource Identifier (URI) using a scheme that IWebViewControl doesn't support.

Occurs when the IWebViewControl attempts to download an unsupported file.

Allows the interception of an HTTP request. This event is triggered every time an HTTP request is made.

Creates a URI that you can pass to NavigateToLocalStreamUri

A unique identifier for the content the URI is referencing. This defines the root of the URI. The path to the resource, relative to the root. The URI created by combining and normalizing the contentIdentifier and relativePath.

Creates an image of the current IWebViewControl contents and writes it to the specified stream.

The stream to write the image to. An asynchronous action to await the capture operation.

Asynchronously gets a DataPackage that contains the selected content within the IWebViewControl.

When this method completes, it returns the selected content as a DataPackage.

Returns the deferred permission request with the specified Id.

The Id of the deferred permission request. The deferred permission request with the specified Id.

Navigates the IWebViewControl to the previous page in the navigation history.

Navigates the IWebViewControl to the next page in the navigation history.

Executes the specified script function from the currently loaded HTML, with specific arguments, as an asynchronous action.

The name of the script function to invoke. A string array that packages arguments to the script function. When this method returns, the string result of the script invocation.

Loads the HTML content at the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) to load.

Loads local web content at the specified URI using an IUriToStreamResolver.

A URI identifying the local HTML content to load. A resolver that converts the URI into a stream to load.

Loads the specified HTML content as a new document.

The HTML content to display in the IWebViewControl.

Navigates the IWebViewControl to a URI with a POST request and HTTP headers.

The details of the HTTP request.

Reloads the current content in the IWebViewControl.

Halts the current IWebViewControl navigation or download.

Provides a control that hosts HTML content in an app. This interface requires IWebViewControl.

Injects a script into the IWebViewControl just after ContentLoading but before any other script is run on the page.

Provides data for the IWebViewControl.ContentLoading event.

Gets the Uniform Resource Identifier (URI) of the content the IWebViewControl is loading.

The Uniform Resource Identifier (URI) of the content.

Represents a deferred request for permissions in an IWebViewControl.

Gets the identifier for the permission request.

The identifier for the permission request.

Gets a value that indicates the type of permission that's requested.

An enumeration value that indicates the type of permission requested.

Gets the Uniform Resource Identifier (URI) of the content where the permission request originated.

The Uniform Resource Identifier (URI) of the content where the permission request originated.

Grants the requested permission.

Denies the requested permission.

Provides data for the DOMContentLoaded event.

Gets the Uniform Resource Identifier (URI) of the content the IWebView is loading.

The Uniform Resource Identifier (URI) of the content.

Provides data for the IWebViewControl.LongRunningScriptDetected event.

Gets the number of milliseconds that the IWebViewControl has been executing a long-running script.

The number of milliseconds the script has been running.

Halts a long-running script executing in a IWebViewControl.

**true** to halt the script; otherwise, **false**.

Provides data for the NavigationCompleted and FrameNavigationCompleted events.

Gets a value that indicates whether the navigation completed successfully.

**true** if the navigation completed successfully; otherwise, **false**.

Gets the Uniform Resource Identifier (URI) of the IWebViewControl content.

The Uniform Resource Identifier (URI) of the content.

If the navigation was unsuccessful, gets a value that indicates the reason.

A value that explains an unsuccessful navigation.

Provides data for the NavigationStarting and FrameNavigationStarting events.

Gets or sets a value indicating whether to cancel the IWebViewControl navigation.

**true** to cancel the navigation; otherwise, **false**.

Gets the Uniform Resource Identifier (URI) of the content the IWebViewControl is loading.

The Uniform Resource Identifier (URI) of the content.

Provides data for the NewWindowRequested event.

Gets or sets a value that marks the routed event as handled.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Provides a new `WebViewControl` as the target for a `window.open` script call from inside the requesting `WebViewControl`. The content in target webview is always considered cross-origin to the content in opener webview and vice versa and subject to cross-origin restrictions. The `WebViewControl` provided in the `NewWindow` property must be new, running on the same process as the opener webview and cannot have been navigated. If `NewWindow` is set, then the provided `WebViewControl` is used.

Gets the Uniform Resource Identifier (URI) of the content where the navigation was initiated.

The Uniform Resource Identifier (URI) of the content where the navigation was initiated.

Gets the Uniform Resource Identifier (URI) of the content the IWebViewControl is attempting to navigate to.

The Uniform Resource Identifier (URI) of the content the IWebViewControl is attempting to navigate to.

Gets a deferral.

Represents a request for permissions in a WebView.

Gets the identifier for the permission request.

The identifier for the permission request.

Gets a value that indicates the type of permission that's requested.

An enumeration value that indicates the type of permission requested.

Gets the current state of the permission request.

An enumeration value that indicates the current state of the permission request. The default is **Unknown**.

Gets the Uniform Resource Identifier (URI) of the content where the permission request originated.

The Uniform Resource Identifier (URI) of the content where the permission request originated.

Grants the requested permission.

Defers the permission request to be allowed or denied at a later time.

Denies the requested permission.

Provides event data for the IWebViewControl.PermissionRequested event.

Gets the WebViewControlPermissionRequest object that contains information about the request.

The WebViewControlPermissionRequest object that contains information about the request.

Defines constants that specify the state of a IWebViewControl.PermissionRequested event.

WebViewPermissionRequest.Allow was called. The permission request is allowed.

WebViewPermissionRequest.Defer was called. The permission request is deferred.

WebViewPermissionRequest.Deny was called. The permission request is denied.

The state of the permission request can't be determined.

Defines constants the specify the type of permission requested in a IWebViewControl.

Permission is for geolocation.

Permission is for the ImmersiveView.

Permission is for media.

Permission is for pointer lock.

Permission is for screen.

Permission is for unlimited **IndexedDB** data storage.

Permission is for web notifications.

Contains information for the Windows.Web.UI.IWebViewControl.ScriptNotify event.

Gets the Uri that originated the ScriptNotify.

The Uri that originated the ScriptNotify.

Gets the string value passed to the app.

The string value passed to the app.

Defines properties that enable or disable IWebViewControl features.

Gets or sets a value that indicates whether the use of IndexedDB is allowed.

**true** if IndexedDB is allowed; otherwise, **false**. The default is **true**.

Gets or sets a value that indicates whether the use of JavaScript is allowed.

**true** if JavaScript is allowed in the IWebViewControl; otherwise, **false**. The default is **true**.

Gets or sets whether ScriptNotify is allowed.

Whether ScriptNotify is allowed.

Provides data for the IWebViewControl.UnsupportedUriSchemeIdentified event.

Gets or sets a value that marks the routed event as handled. A **true** value for Handled prevents other handlers along the event route from handling the same event again.

**true** to mark the routed event handled. **false** to leave the routed event unhandled, which permits the event to potentially route further and be acted on by other handlers. The default is **false**.

Gets the Uniform Resource Identifier (URI) of the content the IWebViewControl attempted to navigate to.

The Uniform Resource Identifier (URI) of the content.

Provides data for the IWebViewControl.UnviewableContentIdentified event.

Gets the media type of content that can't be viewed.

The media type of content that can't be viewed.

Gets the Uniform Resource Identifier (URI) of the page that contains the link to the unviewable content.

The Uniform Resource Identifier (URI) of the referring page.

Gets the Uniform Resource Identifier (URI) of the content the IWebViewControl attempted to load.

The Uniform Resource Identifier (URI) of the content.

Provides data to the Windows.Web.UI.IWebViewControl.WebResourceRequested event.

Gets the intercepted HTTP request.

The intercepted HTTP request.

Gets or sets the HTTP response that will be sent to the Windows.Web.UI.IWebViewControl

The HTML response.

Gets a deferral.

An asynchronous operation that completes with the deferral.

This class is an implementation of an IWebViewControl.

Gets or sets the bounds of the control.

The bounds of the control.

Gets a value that indicates whether there is at least one page in the backward navigation history.

**true** if the control can navigate backward; otherwise, **false**.

Gets a value that indicates whether there is at least one page in the forward navigation history.

**true** if the IWebViewControl can navigate forward; otherwise, **false**.

Gets a value that indicates whether the control contains an element that supports full screen.

A value that indicates whether the IWebViewControl contains an element that supports full screen.

Gets or sets the color to use as the control background when the HTML content does not specify a color.

The background color.

Gets a collection of permission requests that are waiting to be granted or denied.

A collection of WebViewDeferredPermissionRequest objects that are waiting to be granted or denied.

Gets the title of the page currently displayed in the control.

The page title.

Gets or sets a value that indicates if this control is invisible.

Value that indicates if this control is invisible.

Gets the process that the control is hosted in.

The process that the control is hosted in.

Gets or sets the scale of the window.

The scale of the window.

Gets a WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

A WebViewControlSettings object that contains properties to enable or disable IWebViewControl features.

Gets or sets the URI source of the HTML content to display in the control.

The URI source of the HTML content to display in the control.

An event that is triggered when the accelerator key is pressed.

An event that is triggered when the status of whether the control currently contains a full screen element or not changes.

An event that is triggered when the control has started loading new content.

An event that is triggered when the control has finished parsing the current HTML content.

An event that is triggered when a frame in the control has finished parsing its current HTML content.

An event that is triggered when a frame in the control has finished parsing its current HTML content.

An event that is triggered when a frame in the control has finished loading its content.

An event that is triggered before a frame in the control navigates to new content.

Informs your app when the WebViewControl receives focus (due to the user clicking inside/outside the WebViewControl). Use in combination with the LostFocus event and programmatic focus changes using the WebViewControl.MoveFocus method.

An event that is triggered periodically while the control executes JavaScript, letting you halt the script.

Informs your app when the WebViewControl loses focus. May be initiated by the user clicking inside/outside the WebViewControl or by a programmatic focus change, such as the app calling SetFocus on a window that is not the WebViewControl or a MoveFocus method call.

An event that is triggered when a focus move is requested.

An event that is triggered when the control has finished loading the current content or if the navigation has failed.

An event that is triggered before the control navigates to new content.

An event that is triggered when a user performs an action in the control that causes content to be opened in a new window.

An event that is triggered when an action in the control requires that permission to be granted.

An event that is triggered when the content contained in the control passes a string to the app using `window.external.notify`.

An event that is triggered when the control shows a warning page for content that was reported as unsafe by SmartScreen Filter.

An event that is triggered when an attempt is made to navigate to a URI using a scheme that the control doesn't support.

An event that is triggered when the control attempts to download an unsupported file.

An event that is fired when an HTTP request is made.

Injects a script into a WebViewControl just after ContentLoading but before any other script is run on the page.

Creates a URI that you can pass to NavigateToLocalStreamUri

A unique identifier for the content the URI is referencing. This defines the root of the URI. The path to the resource, relative to the root. The URI created by combining and normalizing the contentIdentifier and relativePath.

Creates an image of the current control contents and writes it to the specified stream.

The stream to write the image to. An asynchronous action to await the capture operation.

Asynchronously gets a DataPackage that contains the selected content within the control.

When this method completes, it returns the selected content as a DataPackage.

Closes the control.

Returns the deferred permission request with the specified Id.

The Id of the deferred permission request. The deferred permission request with the specified Id.

Navigates the IWebViewControl to the previous page in the navigation history.

Navigates the IWebViewControl to the next page in the navigation history.

Executes the specified script function from the currently loaded HTML, with specific arguments, as an asynchronous action.

The name of the script function to invoke. A string array that packages arguments to the script function. When this method returns, the string result of the script invocation.

Move the focus.

The reason.

Loads the HTML content at the specified Uniform Resource Identifier (URI).

The Uniform Resource Identifier (URI) to load.

Loads local web content at the specified URI using an IUriToStreamResolver.

A URI identifying the local HTML content to load. A resolver that converts the URI into a stream to load.

Loads the specified HTML content as a new document.

The HTML content to display in the control.

Navigates the control to a URI with a POST request and HTTP headers.

The request.

Reloads the current content in the control.

Halts the current control navigation or download.

This class provides information for the Windows.Web.UI.Interop.WebViewControl.AcceleratorKeyPressed event.

Gets the event type.

The event type.

Gets or sets a value that marks the routed event as handled. A true value for Handled prevents other handlers along the event route from handling the same event again.

Setting Handled to true will prevent WebViewControl from receiving the key in the event.

Gets the key status.

The key status.

Gets the routing stage.

The routing stage.

Gets the virtual key.

The virtual key.

An enumeration that describes the accelerator key routing stage.

Routing stage is bubbling.

Routing stage is tunneling.

An enum that describes the reason for move the focus.

Focus was moved to the next.

Focus was moved to the previous.

Focus was moved programmatically.

This class contains information for the Windows.Web.UI.Interop.WebViewControl.MoveFocusRequested event.

Gets or sets the move focus reason.

The move focus reason.

This class represents the process that one or more Windows.Web.UI.Interop.WebViewControl classes will live in.

Creates an instance of **WebViewControlProcess**.

Creates an instance of **WebViewControlProcess** with options.

The process options. For more info, see Windows.Web.UI.Interop.WebViewControlProcessOptions.

Gets the enterprise ID of this proces.

The enterprise ID of this process.

Gets a boolean value indicating whether the privateNetworkClientServer capability is enabled in this process.

A boolean value indicating whether the privateNetworkClientServer capability is enabled in this process.

Gets the ID of this process.

The ID of this process.

Fires when this process is terminated.

Creates a Windows.Web.UI.Interop.WebViewControl within the context of this process.

The parent window. The initial bounds of the window. An asynchronous operation that completes with a Windows.Web.UI.Interop.WebViewControl.

Gets a vector containing all the Windows.Web.UI.Interop.WebViewControl objects hosted within this process.

A vector containing all the Windows.Web.UI.Interop.WebViewControl objects hosted within this process.

Terminates the process.

Represents the state of the Windows.Web.UI.Interop.WebViewControlProcess.

The process is in an unknown state.

The process is disabled.

The process is enabled.

This class contains options that can be set when creating a Windows.Web.UI.Interop.WebViewControl object.

Creates an instance of **WebViewControlProcessOptions**

Gets or sets the enterprise ID for apps that are WIP-enabled.

The enterprise ID for apps that are WIP-enabled.

Gets or sets a boolean value indicating whether the privateNetworkClientServer capability is enabled.

A boolean value indicating whether the privateNetworkClientServer capability is enabled.