3608 lines
211 KiB
XML
3608 lines
211 KiB
XML
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>InTheHand</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:InTheHand.ApplicationModel.DesignMode">
|
||
<summary>
|
||
Enables you to detect whether your app is in design mode in a visual designer.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DesignMode.DesignModeEnabled">
|
||
<summary>
|
||
Gets a value that indicates whether the process is running in design mode.
|
||
</summary>
|
||
<value>True if the process is running in design mode; otherwise false.</value>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Package">
|
||
<summary>
|
||
Provides information about a package.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.Current">
|
||
<summary>
|
||
Gets the package for the current app.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.Description">
|
||
<summary>
|
||
Gets the description of the package.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.DisplayName">
|
||
<summary>
|
||
Gets the display name of the package.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.Id">
|
||
<summary>
|
||
Gets the package identity of the current package.
|
||
</summary>
|
||
<value>The package identity.</value>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.InstalledDate">
|
||
<summary>
|
||
Gets the date the application package was installed on the user's phone.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.InstalledLocation">
|
||
<summary>
|
||
Gets the location of the installed package.
|
||
</summary>
|
||
<remarks>This folder is read-only except for Windows Desktop applications.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.IsDevelopmentMode">
|
||
<summary>
|
||
Indicates whether the package is installed in development mode.
|
||
</summary>
|
||
<remarks>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.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.Logo">
|
||
<summary>
|
||
Gets the logo of the package.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Package.PublisherDisplayName">
|
||
<summary>
|
||
Gets the publisher display name of the package.
|
||
</summary>
|
||
<remarks>Android and iOS don't provide a way to query the publisher at runtime.</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.PackageId">
|
||
<summary>
|
||
Provides package identification info, such as name, version, and publisher.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.Architecture">
|
||
<summary>
|
||
Gets the processor architecture for which the package was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.FullName">
|
||
<summary>
|
||
Gets the name of the package.
|
||
</summary>
|
||
<value>The package name.</value>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.Name">
|
||
<summary>
|
||
Gets the name of the package.
|
||
</summary>
|
||
<value>The package name.</value>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.ProductId">
|
||
<summary>
|
||
Gets the value of the ProductID attribute associated with this application package.
|
||
</summary>
|
||
<value>The value of the ProductID attribute associated with this application package.</value>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.Publisher">
|
||
<summary>
|
||
Gets the publisher of the package.
|
||
</summary>
|
||
<remarks>Not supported on iOS or Android.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.PackageId.Version">
|
||
<summary>
|
||
Gets the package version info.
|
||
</summary>
|
||
<value>The package version information.</value>
|
||
</member>
|
||
<member name="T:InTheHand.Data.Html.HtmlUtilities">
|
||
<summary>
|
||
Provides utility methods for use with HTML-formatted data.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Data.Html.HtmlUtilities.ConvertToText(System.String)">
|
||
<summary>
|
||
Converts HTML-formatted data to a string that contains the text content extracted from the HTML.
|
||
</summary>
|
||
<param name="html">A String containing HTML-formatted data.</param>
|
||
<returns>A String of text content.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.DateTimeOffsetHelper">
|
||
<summary>
|
||
Helper class for <see cref="T:System.DateTimeOffset"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.DateTimeOffsetHelper.FromUnixTimeSeconds(System.Int64)">
|
||
<summary>
|
||
Converts a Unix time expressed as the number of seconds that have elapsed since 1970-01-01T00:00:00Z to a <see cref="T:System.DateTimeOffset"/> value.
|
||
</summary>
|
||
<param name="seconds">A Unix time, expressed as the number of seconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC).
|
||
For Unix times before this date, its value is negative.</param>
|
||
<returns>A date and time value that represents the same moment in time as the Unix time. </returns>
|
||
</member>
|
||
<member name="M:InTheHand.DateTimeOffsetHelper.FromUnixTimeMilliseconds(System.Int64)">
|
||
<summary>
|
||
Converts a Unix time expressed as the number of milliseconds that have elapsed since 1970-01-01T00:00:00Z to a <see cref="T:System.DateTimeOffset"/> value.
|
||
</summary>
|
||
<param name="milliseconds">A Unix time, expressed as the number of milliseconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC).
|
||
For Unix times before this date, its value is negative.</param>
|
||
<returns>A date and time value that represents the same moment in time as the Unix time. </returns>
|
||
</member>
|
||
<member name="M:InTheHand.DateTimeOffsetHelper.ToUnixTimeSeconds(System.DateTimeOffset)">
|
||
<summary>
|
||
Returns the number of seconds that have elapsed since 1970-01-01T00:00:00Z.
|
||
</summary>
|
||
<param name="date">The DateTimeOffset value.</param>
|
||
<returns>The number of seconds that have elapsed since 1970-01-01T00:00:00Z. </returns>
|
||
<remarks>Unix time represents the number of seconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC).
|
||
It does not take leap seconds into account.
|
||
<para>This method first converts the current instance to UTC before returning its Unix time.
|
||
For date and time values before 1970-01-01T00:00:00Z, this method returns a negative value.</para></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.DateTimeOffsetHelper.ToUnixTimeMilliseconds(System.DateTimeOffset)">
|
||
<summary>
|
||
Returns the number of milliseconds that have elapsed since 1970-01-01T00:00:00.000Z.
|
||
</summary>
|
||
<param name="date">The DateTimeOffset value.</param>
|
||
<returns>The number of milliseconds that have elapsed since 1970-01-01T00:00:00.000Z.</returns>
|
||
<remarks>Unix time represents the number of seconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC).
|
||
It does not take leap seconds into account.
|
||
This method returns the number of milliseconds in Unix time.
|
||
<para>This method first converts the current instance to UTC before returning the number of milliseconds in its Unix time.
|
||
For date and time values before 1970-01-01T00:00:00Z, this method returns a negative value.</para></remarks>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Environment">
|
||
<summary>
|
||
Gives applications access to information about the environment in which they are running.
|
||
The only supported property of this class is <see cref="P:InTheHand.Devices.Environment.DeviceType"/>, which is used to determine if an application is running on an actual Windows Phone device or on the device emulator on a PC.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Environment.DeviceType">
|
||
<summary>
|
||
Gets the type of device on which the application is running.
|
||
Use this property to determine if your application is running on an actual device or on the device emulator.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.DeviceType">
|
||
<summary>
|
||
Defines the device type values used by the <see cref="P:InTheHand.Devices.Environment.DeviceType"/> property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.DeviceType.Device">
|
||
<summary>
|
||
The device type is an actual device.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.DeviceType.Emulator">
|
||
<summary>
|
||
The device type is a device emulator.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.BasicGeoposition">
|
||
<summary>
|
||
The basic information to describe a geographic position.
|
||
</summary>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.BasicGeoposition.op_Implicit(InTheHand.Devices.Geolocation.BasicGeoposition)~CoreLocation.CLLocationCoordinate2D">
|
||
<summary>
|
||
Converts a Pontoon BasicGeoposition to a CoreLocation CLLocationCoordinate2D.
|
||
</summary>
|
||
<param name="bg"></param>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.BasicGeoposition.op_Implicit(CoreLocation.CLLocationCoordinate2D)~InTheHand.Devices.Geolocation.BasicGeoposition">
|
||
<summary>
|
||
Converts a CoreLocation CLLocationCoordinate2D to a Pontoon BasicGeoposition.
|
||
</summary>
|
||
<param name="c"></param>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.BasicGeoposition.Altitude">
|
||
<summary>
|
||
The altitude of the geographic position in meters.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.BasicGeoposition.Latitude">
|
||
<summary>
|
||
The latitude of the geographic position.
|
||
The valid range of latitude values is from -90.0 to 90.0 degrees.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.BasicGeoposition.Longitude">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.BasicGeopositionExtensions">
|
||
<summary>
|
||
Provides extension methods for <see cref="T:InTheHand.Devices.Geolocation.BasicGeoposition"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.BasicGeopositionExtensions.GetDistanceTo(InTheHand.Devices.Geolocation.BasicGeoposition,InTheHand.Devices.Geolocation.BasicGeoposition)">
|
||
<summary>
|
||
Returns the distance between the latitude and longitude coordinates that are specified by this <see cref="T:InTheHand.Devices.Geolocation.BasicGeoposition"/> and another specified <see cref="T:InTheHand.Devices.Geolocation.BasicGeoposition"/>.
|
||
</summary>
|
||
<param name="b"></param>
|
||
<param name="other">The <see cref="T:InTheHand.Devices.Geolocation.BasicGeoposition"/> for the location to calculate the distance to.</param>
|
||
<returns>The distance between the two coordinates, in meters.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.Geocoordinate">
|
||
<summary>
|
||
Contains the information for identifying a geographic location.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.Accuracy">
|
||
<summary>
|
||
The accuracy of the location in meters.
|
||
</summary>
|
||
<value>The accuracy in meters.</value>
|
||
<remarks>The Windows Location Provider and the Windows Phone Location Services accuracy depends on the location data available.
|
||
For example,iIf Wifi is available, data is accurate to within 50 meters.
|
||
If Wifi is not available, the data could be accurate to within 10 miles or larger.
|
||
A GNSS device can provide data accurate to within a few meters.
|
||
However, its accuracy can vary if the GNSS sensor is obscured by buildings, trees, or cloud cover.
|
||
GNSS data may not be available at all within a building.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.AltitudeAccuracy">
|
||
<summary>
|
||
The accuracy of the altitude, in meters.
|
||
</summary>
|
||
<value>The accuracy of the altitude.</value>
|
||
<remarks>It is optional for a location provider to set this property.
|
||
If the property is not provided, the value will be NULL.
|
||
The Windows Location Provider and the Windows Phone Location Services do not set this property.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.Heading">
|
||
<summary>
|
||
The current heading in degrees relative to true north.
|
||
</summary>
|
||
<value>The current heading in degrees relative to true north.</value>
|
||
<remarks>It is optional for a location provider to set this property.
|
||
If the property is not provided, the value will be NULL.
|
||
The Windows Location Provider does not set this property.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.Point">
|
||
<summary>
|
||
The location of the Geocoordinate.
|
||
</summary>
|
||
<value>The location of the Geocoordinate.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.PositionSource">
|
||
<summary>
|
||
Gets the source used to obtain a Geocoordinate.
|
||
</summary>
|
||
<value>The source used to obtain a Geocoordinate.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.PositionSourceTimestamp">
|
||
<summary>
|
||
Gets the time at which the associated Geocoordinate position was calculated.
|
||
</summary>
|
||
<value>The time at which the associated Geocoordinate position was calculated.</value>
|
||
<remarks>When this property is not available, the value will be null.
|
||
<para>The timestamp returned by this property depends on how the location was obtained and may be completely unrelated to the system time on the device.
|
||
For example, if the position is obtained from the Global Navigation Satellite System (GNSS) the timestamp would be obtained from the satellites.
|
||
If the position was is obtained from Secure User Plane Location (SUPL), the timestamp would be obtained from SUPL servers.
|
||
This means that the timestamps obtained from these services will be precise and, most importantly, consistent across all devices regardless of whether the system time on the devices is set correctly.</para></remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.Speed">
|
||
<summary>
|
||
The speed in meters per second.
|
||
</summary>
|
||
<value>The speed in meters per second.</value>
|
||
<remarks>It is optional for a location provider to set this property.
|
||
If the property is not provided, the value will be NULL.
|
||
The Windows Location Provider does not set this property.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geocoordinate.Timestamp">
|
||
<summary>
|
||
The system time at which the location was determined.
|
||
</summary>
|
||
<value>The system time at which the location was determined.</value>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.GeocoordinateExtensions">
|
||
<summary>
|
||
Provides extension methods for <see cref="T:InTheHand.Devices.Geolocation.Geocoordinate"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.GeocoordinateExtensions.GetDistanceTo(InTheHand.Devices.Geolocation.Geocoordinate,InTheHand.Devices.Geolocation.Geocoordinate)">
|
||
<summary>
|
||
Returns the distance between the latitude and longitude coordinates that are specified by this <see cref="T:InTheHand.Devices.Geolocation.Geocoordinate"/> and another specified <see cref="T:InTheHand.Devices.Geolocation.Geocoordinate"/>.
|
||
</summary>
|
||
<param name="g"></param>
|
||
<param name="other">The <see cref="T:InTheHand.Devices.Geolocation.Geocoordinate"/> for the location to calculate the distance to.</param>
|
||
<returns>The distance between the two coordinates, in meters.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.Geolocator">
|
||
<summary>
|
||
Provides access to the current geographic location.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.Geolocator.#ctor">
|
||
<summary>
|
||
Initializes a new Geolocator object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geolocator.DesiredAccuracy">
|
||
<summary>
|
||
The accuracy level at which the Geolocator provides location updates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geolocator.LocationStatus">
|
||
<summary>
|
||
The status that indicates the ability of the Geolocator to provide location updates.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geolocator.MovementThreshold">
|
||
<summary>
|
||
Gets and sets 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.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geolocator.ReportInterval">
|
||
<summary>
|
||
The requested minimum time interval between location updates, in milliseconds.
|
||
If your application requires updates infrequently, set this value so that you only receive location updates when needed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.Geolocator.GetGeopositionAsync">
|
||
<summary>
|
||
Starts an asynchronous operation to retrieve the current location of the device.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="E:InTheHand.Devices.Geolocation.Geolocator.StatusChanged">
|
||
<summary>
|
||
Raised when the ability of the Geolocator to provide updated location changes.
|
||
</summary>
|
||
</member>
|
||
<member name="E:InTheHand.Devices.Geolocation.Geolocator.PositionChanged">
|
||
<summary>
|
||
Raised when the location is updated.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.Geopoint">
|
||
<summary>
|
||
Describes a geographic point.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Geolocation.Geopoint.#ctor(InTheHand.Devices.Geolocation.BasicGeoposition)">
|
||
<summary>
|
||
Create a geographic point object for the given position.
|
||
</summary>
|
||
<param name="position">Create a geographic point object for the given position.</param>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geopoint.Position">
|
||
<summary>
|
||
The position of a geographic point.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.Geoposition">
|
||
<summary>
|
||
Represents a location that may contain latitude and longitude data or venue data.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.Geoposition.Coordinate">
|
||
<summary>
|
||
The latitude and longitude associated with a geographic location.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.PositionAccuracy">
|
||
<summary>
|
||
Indicates the requested accuracy level for the location data that the application uses.
|
||
</summary>
|
||
<seealso cref="P:InTheHand.Devices.Geolocation.Geolocator.DesiredAccuracy"/>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionAccuracy.Default">
|
||
<summary>
|
||
Optimize for power, performance, and other cost considerations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionAccuracy.High">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.PositionChangedEventArgs">
|
||
<summary>
|
||
Provides data for the <see cref="E:InTheHand.Devices.Geolocation.Geolocator.PositionChanged"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.PositionChangedEventArgs.Position">
|
||
<summary>
|
||
The location data associated with the <see cref="E:InTheHand.Devices.Geolocation.Geolocator.PositionChanged"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.PositionSource">
|
||
<summary>
|
||
Indicates the source used to obtain a <see cref="T:InTheHand.Devices.Geolocation.Geocoordinate"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.Cellular">
|
||
<summary>
|
||
The position was obtained from cellular network data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.Satellite">
|
||
<summary>
|
||
The position was obtained from satellite data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.WiFi">
|
||
<summary>
|
||
The position was obtained from Wi-Fi network data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.IPAddress">
|
||
<summary>
|
||
The position was obtained from an IP address.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.Unknown">
|
||
<summary>
|
||
The position was obtained from an unknown source.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.Default">
|
||
<summary>
|
||
The position was obtained from the user's manually-set location.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionSource.Obfuscated">
|
||
<summary>
|
||
The position was obtained via the Consentless Location feature and was therefore intentionally made inaccurate to a degree.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.PositionStatus">
|
||
<summary>
|
||
Indicates the ability of the <see cref="T:InTheHand.Devices.Geolocation.Geolocator"/> object to provide location data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.Ready">
|
||
<summary>
|
||
Location data is available.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.Initializing">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.NoData">
|
||
<summary>
|
||
No location data is available from any source.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.Disabled">
|
||
<summary>
|
||
Location settings are turned off.
|
||
This status indicates that the user has not granted the application permission to access location.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.NotInitialized">
|
||
<summary>
|
||
An operation to retrieve location has not yet been initialized.
|
||
LocationStatus will have this value if the application has not yet called <see cref="M:InTheHand.Devices.Geolocation.Geolocator.GetGeopositionAsync"/> or registered an event handler for the <see cref="E:InTheHand.Devices.Geolocation.Geolocator.PositionChanged"/> event.
|
||
LocationStatus may also have this value if your app doesn’t have permission to access location.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Devices.Geolocation.PositionStatus.NotAvailable">
|
||
<summary>
|
||
Location services is not available on this version of Windows.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Devices.Geolocation.StatusChangedEventArgs">
|
||
<summary>
|
||
Provides information for the <see cref="E:InTheHand.Devices.Geolocation.Geolocator.StatusChanged"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Geolocation.StatusChangedEventArgs.Status">
|
||
<summary>
|
||
The updated status of the <see cref="T:InTheHand.Devices.Geolocation.Geolocator"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Environment">
|
||
<summary>
|
||
Provides information about the Operating System.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
<seealso cref="T:System.Environment"/>
|
||
</member>
|
||
<member name="P:InTheHand.Environment.OSVersion">
|
||
<summary>
|
||
Gets an OperatingSystem object that contains the current platform identifier and version number.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Collections.IObservableMap`2">
|
||
<summary>
|
||
Notifies listeners of dynamic changes to a map, such as when items are added or removed.
|
||
</summary>
|
||
<typeparam name="K">The type of the keys in the map.</typeparam>
|
||
<typeparam name="V">The type of the values in the map.</typeparam>
|
||
</member>
|
||
<member name="E:InTheHand.Foundation.Collections.IObservableMap`2.MapChanged">
|
||
<summary>
|
||
Occurs when the map changes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Collections.MapChangedEventHandler`2">
|
||
<summary>
|
||
Represents the method that handles the changed event of an observable map.
|
||
</summary>
|
||
<typeparam name="K">The type of the keys in the map.</typeparam>
|
||
<typeparam name="V">The type of the values in the map.</typeparam>
|
||
<param name="sender"></param>
|
||
<param name="eventArgs"></param>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Collections.IMapChangedEventArgs`1">
|
||
<summary>
|
||
Provides data for the changed event of a map collection.
|
||
</summary>
|
||
<typeparam name="K">The type of the keys in the map.</typeparam>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Collections.IMapChangedEventArgs`1.CollectionChange">
|
||
<summary>
|
||
Gets the type of change that occurred in the map.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Collections.IMapChangedEventArgs`1.Key">
|
||
<summary>
|
||
Gets the key of the item that changed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Collections.IPropertySet">
|
||
<summary>
|
||
Represents a collection of key-value pairs, correlating several other collection interfaces.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Collections.CollectionChange">
|
||
<summary>
|
||
Describes the action that causes a change to a collection.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Foundation.Collections.CollectionChange.Reset">
|
||
<summary>
|
||
The collection is changed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Foundation.Collections.CollectionChange.ItemInserted">
|
||
<summary>
|
||
An item is added to the collection.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Foundation.Collections.CollectionChange.ItemRemoved">
|
||
<summary>
|
||
An item is removed from the collection.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Foundation.Collections.CollectionChange.ItemChanged">
|
||
<summary>
|
||
An item is changed in the collection.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Metadata.ApiInformation">
|
||
<summary>
|
||
Enables you to detect whether a specified member, type, or API contract is present so that you can safely make API calls across a variety of devices.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16)">
|
||
<summary>
|
||
Returns true or false to indicate whether the API contract with the specified name and major version number is present.
|
||
</summary>
|
||
<param name="contractName">The name of the API contract.</param>
|
||
<param name="majorVersion">The major version number of the API contract.</param>
|
||
<returns>True if the specified API contract is present; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsApiContractPresent(System.String,System.UInt16,System.UInt16)">
|
||
<summary>
|
||
Returns true or false to indicate whether the API contract with the specified name and major and minor version number is present.
|
||
</summary>
|
||
<param name="contractName">The name of the API contract.</param>
|
||
<param name="majorVersion">The major version number of the API contract.</param>
|
||
<param name="minorVersion">The minor version number of the API contract.</param>
|
||
<returns>True if the specified API contract is present; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsEnumNamedValuePresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified named constant is present for a specified enumeration.
|
||
</summary>
|
||
<param name="enumTypeName">The namespace-qualified name of the type.</param>
|
||
<param name="valueName">The name of the constant.</param>
|
||
<returns>True if the specified constant is present; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsEventPresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified event is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="eventName">The name of the event.</param>
|
||
<returns>True if the specified event is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified method is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="methodName">The name of the method.</param>
|
||
<returns>True if the specified method is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsMethodPresent(System.String,System.String,System.UInt32)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified method overload with the specified number of input parameters is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="methodName">The name of the method.</param>
|
||
<param name="inputParameterCount">The number of input parameters for the overload.</param>
|
||
<returns>True if the specified method is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsPropertyPresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified property (writeable or read-only) is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="propertyName">The name of the property.</param>
|
||
<returns>True if the specified property is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsReadOnlyPropertyPresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified read-only property is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="propertyName">The name of the property.</param>
|
||
<returns>True if the specified property is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsWriteablePropertyPresent(System.String,System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified writeable property is present for a specified type.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<param name="propertyName">The name of the property.</param>
|
||
<returns>True if the specified property is present for the type; otherwise, false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Metadata.ApiInformation.IsTypePresent(System.String)">
|
||
<summary>
|
||
Returns true or false to indicate whether a specified type is present.
|
||
</summary>
|
||
<param name="typeName">The namespace-qualified name of the type.</param>
|
||
<returns>True if the specified type is present; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Point">
|
||
<summary>
|
||
Represents x- and y-coordinate values that define a point in a two-dimensional plane.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Point.X">
|
||
<summary>
|
||
The horizontal position of the point.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Point.Y">
|
||
<summary>
|
||
The vertical position of the point.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.Rect">
|
||
<summary>
|
||
Contains number values that represent the location and size of a rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Foundation.Rect.#ctor(System.Double,System.Double,System.Double,System.Double)">
|
||
<summary>
|
||
Initializes a Rect structure that has the specified x-coordinate, y-coordinate, width, and height.
|
||
</summary>
|
||
<param name="x">The x-coordinate of the top-left corner of the rectangle.</param>
|
||
<param name="y">The y-coordinate of the top-left corner of the rectangle.</param>
|
||
<param name="width">The width of the rectangle.</param>
|
||
<param name="height">The height of the rectangle.</param>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Rect.X">
|
||
<summary>
|
||
The x-coordinate location of the left side of the rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Rect.Y">
|
||
<summary>
|
||
The y-coordinate location of the top side of the rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Rect.Width">
|
||
<summary>
|
||
A value that represents the Width of the rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Foundation.Rect.Height">
|
||
<summary>
|
||
A value that represents the Height of the rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Foundation.TypedEventHandler`2">
|
||
<summary>
|
||
Represents a method that handles general events.
|
||
</summary>
|
||
<typeparam name="TSender">The event source.</typeparam>
|
||
<typeparam name="TResult">The event data. If there is no event data, this parameter will be null.</typeparam>
|
||
<param name="sender">The event source.</param>
|
||
<param name="args">The event data. If there is no event data, this parameter will be null.</param>
|
||
</member>
|
||
<member name="T:InTheHand.Globalization.ApplicationLanguages">
|
||
<summary>
|
||
Specifies the language-related preferences that the app can use and maintain.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Globalization.ApplicationLanguages.Languages">
|
||
<summary>
|
||
Gets the ranked list of current runtime language values preferred by the user.
|
||
</summary>
|
||
<value>A computed list of languages that merges the app's declared supported languages (<see cref="P:InTheHand.Globalization.ApplicationLanguages.ManifestLanguages"/>) with the user's ranked list of preferred languages.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Globalization.ApplicationLanguages.ManifestLanguages">
|
||
<summary>
|
||
Gets the app's declared list of supported languages.
|
||
</summary>
|
||
<value>The list of supported languages declared in the app's manifest.</value>
|
||
</member>
|
||
<member name="T:InTheHand.Graphics.Display.DisplayInformation">
|
||
<summary>
|
||
Monitors and controls physical display information.
|
||
The class provides events to allow clients to monitor for changes in the display.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Graphics.Display.DisplayInformation.GetForCurrentView">
|
||
<summary>
|
||
Gets the current physical display information.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.Graphics.Display.DisplayInformation.CurrentOrientation">
|
||
<summary>
|
||
Gets the current orientation of a rectangular monitor.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Graphics.Display.DisplayInformation.RawDpiX">
|
||
<summary>
|
||
Gets the raw dots per inch (DPI) along the x axis of the display monitor.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Graphics.Display.DisplayInformation.RawDpiY">
|
||
<summary>
|
||
Gets the raw dots per inch (DPI) along the y axis of the display monitor.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Graphics.Display.DisplayInformation.RawPixelsPerViewPixel">
|
||
<summary>
|
||
Gets a value representing the number of raw (physical) pixels for each view (layout) pixel.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.Graphics.Display.DisplayOrientations">
|
||
<summary>
|
||
Describes the orientation of a rectangular monitor.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Graphics.Display.DisplayOrientations.None">
|
||
<summary>
|
||
No display orientation is specified.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Graphics.Display.DisplayOrientations.Landscape">
|
||
<summary>
|
||
Specifies that the monitor is oriented in landscape mode where the width of the display viewing area is greater than the height.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Graphics.Display.DisplayOrientations.Portrait">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Graphics.Display.DisplayOrientations.LandscapeFlipped">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Graphics.Display.DisplayOrientations.PortraitFlipped">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.MathHelper">
|
||
<summary>
|
||
Provides additional Math operations.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.MathHelper.Clamp``1(``0,``0,``0)">
|
||
<summary>
|
||
Restricts a value to be within a specified range.
|
||
</summary>
|
||
<param name="value">The value to clamp.</param>
|
||
<param name="minimum">The minimum value.
|
||
If value is less than min, min will be returned. </param>
|
||
<param name="maximum">The maximum value.
|
||
If value is greater than max, max will be returned. </param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.Networking.Connectivity.ConnectionProfile">
|
||
<summary>
|
||
Represents a network connection, which includes either the currently connected network or prior network connections.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Connectivity.ConnectionProfile.GetNetworkConnectivityLevel">
|
||
<summary>
|
||
Gets the network connectivity level for this connection.
|
||
This value indicates what network resources, if any, are currently available.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.Networking.Connectivity.NetworkConnectivityLevel">
|
||
<summary>
|
||
Defines the level of connectivity currently available.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="F:InTheHand.Networking.Connectivity.NetworkConnectivityLevel.None">
|
||
<summary>
|
||
No connectivity.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Networking.Connectivity.NetworkConnectivityLevel.LocalAccess">
|
||
<summary>
|
||
Local network access only.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Networking.Connectivity.NetworkConnectivityLevel.ConstrainedInternetAccess">
|
||
<summary>
|
||
Limited internet access.
|
||
<para>This value indicates captive portal connectivity, where local access to a web portal is provided, but access to the Internet requires that specific credentials are provided via the portal.
|
||
This level of connectivity is generally encountered when using connections hosted in public locations (e.g. coffee shops and book stores).</para>
|
||
Note This doesn't guarantee detection of a captive portal.
|
||
Windows Store apps should also test if the captive portal can be reached using a URL for the captive portal, or by attempting access to a public web site which will then redirect to the captive portal when Windows reports LocalAccess as the current NetworkConnectivityLevel.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Networking.Connectivity.NetworkConnectivityLevel.InternetAccess">
|
||
<summary>
|
||
Local and Internet access.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Networking.Connectivity.NetworkInformation">
|
||
<summary>
|
||
Provides access to network connection information for the local machine.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Connectivity.NetworkInformation.GetInternetConnectionProfile">
|
||
<summary>
|
||
Gets the connection profile associated with the internet connection currently used by the local machine.
|
||
</summary>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="E:InTheHand.Networking.Connectivity.NetworkInformation.NetworkStatusChanged">
|
||
<summary>
|
||
Occurs when the network status changes for a connection.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Networking.Connectivity.NetworkStatusChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles network status change notifications.
|
||
This method is called when any properties exposed by the <see cref="T:InTheHand.Networking.Connectivity.NetworkInformation"/> object changes while the app is active.
|
||
</summary>
|
||
<param name="sender"></param>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation">
|
||
<summary>
|
||
Provides the app the ability to retrieve device information from the local device.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item></list>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.#ctor">
|
||
<summary>
|
||
Creates an instance of an object that allows the caller app to retrieve device information from the local device.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.FriendlyName">
|
||
<summary>
|
||
Returns the friendly name of the local device.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.Id">
|
||
<summary>
|
||
Returns the identifier of the local device.
|
||
</summary>
|
||
<remarks>For Windows Phone (Silverlight) apps you must declare the ID_CAP_IDENTITY_DEVICE capability in your WMAppManifest.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.OperatingSystem">
|
||
<summary>
|
||
Returns the operating system of the local device.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.SystemManufacturer">
|
||
<summary>
|
||
Returns the system manufacturer of the local device. Use this only if the SystemSku is empty.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Security.ExchangeActivesyncProvisioning.EasClientDeviceInformation.SystemProductName">
|
||
<summary>
|
||
Returns the system product name of the local device.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.ApplicationData">
|
||
<summary>
|
||
Provides access to the application data store.
|
||
Application data consists of settings that are local.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.Current">
|
||
<summary>
|
||
Provides access to the app data store associated with the app's app package.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationData.ClearAsync">
|
||
<summary>
|
||
Removes all application data from the local, roaming, and temporary app data stores.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationData.ClearAsync(InTheHand.Storage.ApplicationDataLocality)">
|
||
<summary>
|
||
Removes all application data from the specified app data store.
|
||
</summary>
|
||
<param name="locality">One of the enumeration values.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.LocalFolder">
|
||
<summary>
|
||
Gets the root folder in the local app data store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.LocalSettings">
|
||
<summary>
|
||
Gets the application settings container in the local app data store.
|
||
</summary>
|
||
<value>The application settings container.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.RoamingFolder">
|
||
<summary>
|
||
Gets the root folder in the roaming app data store.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.RoamingSettings">
|
||
<summary>
|
||
Gets the application settings container in the local app data store.
|
||
</summary>
|
||
<value>The application settings container.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationData.TemporaryFolder">
|
||
<summary>
|
||
Gets the root folder in the temporary app data store.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.ApplicationDataContainer">
|
||
<summary>
|
||
Represents a container for app settings.
|
||
The methods and properties of this class support creating, deleting, enumerating, and traversing the container hierarchy.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainer.CreateContainer(System.String,InTheHand.Storage.ApplicationDataCreateDisposition)">
|
||
<summary>
|
||
Creates or opens the specified settings container in the current settings container.
|
||
</summary>
|
||
<param name="name">The name of the container.</param>
|
||
<param name="disposition">One of the enumeration values.</param>
|
||
<remarks>On iOS the name must be a value Shared App Group name and disposition must be Existing.</remarks>
|
||
<returns>The settings container.</returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainer.Locality">
|
||
<summary>
|
||
Gets the type (local or roaming) of the app data store that is associated with the current settings container.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainer.Name">
|
||
<summary>
|
||
Gets the name of the current settings container.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainer.Values">
|
||
<summary>
|
||
Gets an object that represents the settings in this settings container.
|
||
</summary>
|
||
<value>The settings map object.</value>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.ApplicationDataContainerSettings">
|
||
<summary>
|
||
Provides access to the settings in a settings container.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="E:InTheHand.Storage.ApplicationDataContainerSettings.MapChanged">
|
||
<summary>
|
||
Occurs when the map changes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Add(System.String,System.Object)">
|
||
<summary>
|
||
Adds an item to the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
<param name="key">The key of the item to add.</param>
|
||
<param name="value">The item value to add.</param>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.ContainsKey(System.String)">
|
||
<summary>
|
||
Returns a value that indicates whether a specified key exists in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
<param name="key">The key to check for in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.</param>
|
||
<returns>true if an item with that key exists in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>; otherwise, false. </returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainerSettings.Keys">
|
||
<summary>
|
||
Gets an ICollection object containing the keys of the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Remove(System.String)">
|
||
<summary>
|
||
Removes a specific item from the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
<param name="key">The key of the item to remove.</param>
|
||
<returns>true if the item was removed, otherwise false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.TryGetValue(System.String,System.Object@)">
|
||
<summary>
|
||
Returns a value that indicates whether a specified key exists in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
If an item with that key exists, the item is retrieved as an out parameter.
|
||
</summary>
|
||
<param name="key">The key to check for in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.</param>
|
||
<param name="value">The item, if it exists.
|
||
Contains null if the item does not exist in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.</param>
|
||
<returns>true if an item with that key exists in the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>; otherwise, false.</returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainerSettings.Values">
|
||
<summary>
|
||
Gets an <see cref="T:System.Collections.Generic.ICollection`1"/> object containing the values of the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainerSettings.Item(System.String)">
|
||
<summary>
|
||
Gets or sets the element value at the specified key index.
|
||
</summary>
|
||
<param name="key"></param>
|
||
<returns>The element value at the specified key index.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||
<summary>
|
||
Adds a new key-value pair to the ApplicationDataContainerSettings.
|
||
</summary>
|
||
<param name="item">The key-value pair to add.</param>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Clear">
|
||
<summary>
|
||
Removes all related application settings.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||
<summary>
|
||
Returns a value that indicates whether a specified key-value pair exists in the ApplicationDataContainerSettings.
|
||
</summary>
|
||
<param name="item">The key-value pair to check for in the ApplicationDataContainerSettings.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
|
||
<summary>
|
||
Copies the elements of the collection to an array, starting at a particular array index.
|
||
</summary>
|
||
<param name="array">The one-dimensional Array that is the destination of the elements copied from the collection.
|
||
The Array must have zero-based indexing.</param>
|
||
<param name="arrayIndex">The zero-based index in array at which copying begins. </param>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainerSettings.Count">
|
||
<summary>
|
||
Gets the number of elements contained in the collection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.ApplicationDataContainerSettings.IsReadOnly">
|
||
<summary>
|
||
Gets a value indicating whether the dictionary is read-only.
|
||
</summary>
|
||
<value>true if the dictionary is read-only; otherwise, false.</value>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.ApplicationDataContainerSettings.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||
<summary>
|
||
Removes a specific key-value pair from the <see cref="T:InTheHand.Storage.ApplicationDataContainerSettings"/>.
|
||
</summary>
|
||
<param name="item">The key-value pair to remove.</param>
|
||
<returns>true if the item was removed, otherwise false.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.ApplicationDataCreateDisposition">
|
||
<summary>
|
||
Specifies options for creating application data containers or returning existing containers.
|
||
<para>This enumeration is used by the <see cref="M:InTheHand.Storage.ApplicationDataContainer.CreateContainer(System.String,InTheHand.Storage.ApplicationDataCreateDisposition)"/> method.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataCreateDisposition.Always">
|
||
<summary>
|
||
Always returns the specified container.
|
||
Creates the container if it does not exist.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataCreateDisposition.Existing">
|
||
<summary>
|
||
Returns the specified container only if it already exists.
|
||
Raises an exception of type System.Exception if the specified container does not exist.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.ApplicationDataLocality">
|
||
<summary>
|
||
Provides access to the application data store.
|
||
Application data consists of settings that are local.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataLocality.Local">
|
||
<summary>
|
||
The data resides in the local application data store.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataLocality.Roaming">
|
||
<summary>
|
||
The data resides in the roaming application data store.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataLocality.Temporary">
|
||
<summary>
|
||
The data resides in the temporary application data store.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataLocality.LocalCache">
|
||
<summary>
|
||
The data resides in the local cache for the application data store.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.ApplicationDataLocality.SharedLocal">
|
||
<summary>
|
||
The data resides in the shared application data store.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.CreationCollisionOption">
|
||
<summary>
|
||
Represents a file.
|
||
Provides information about the file and its content, and ways to manipulate them.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.CreationCollisionOption.GenerateUniqueName">
|
||
<summary>
|
||
Automatically append a number to the base of the specified name if the file or folder already exists.
|
||
For example, if MyFile.txt already exists, then the new file is named MyFile(2).txt.
|
||
If MyFolder already exists, then the new folder is named MyFolder(2).
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.CreationCollisionOption.ReplaceExisting">
|
||
<summary>
|
||
Replace the existing item if the file or folder already exists.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.CreationCollisionOption.FailIfExists">
|
||
<summary>
|
||
Raise an exception of type System.Exception if the file or folder already exists.
|
||
Methods that don't explicitly pass a value from the CreationCollisionOption enumeration use the FailIfExists value as the default when you try to create, rename, copy, or move a file or folder.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.CreationCollisionOption.OpenIfExists">
|
||
<summary>
|
||
Return the existing item if the file or folder already exists.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.FileAttributes">
|
||
<summary>
|
||
Describes the attributes of a file or folder.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileAttributes.Normal">
|
||
<summary>
|
||
The item is normal.
|
||
That is, the item doesn't have any of the other values in the enumeration.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileAttributes.ReadOnly">
|
||
<summary>
|
||
The item is read-only.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileAttributes.Directory">
|
||
<summary>
|
||
The item is a directory.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileAttributes.Archive">
|
||
<summary>
|
||
The item is archived.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileAttributes.Temporary">
|
||
<summary>
|
||
The item is a temporary file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.FileIO">
|
||
<summary>
|
||
Provides helper methods for reading and writing files that are represented by objects of type <see cref="T:InTheHand.Storage.IStorageFile"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.AppendLinesAsync(InTheHand.Storage.IStorageFile,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Appends lines of text to the specified file.
|
||
</summary>
|
||
<param name="file">The file that the lines are appended to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.AppendLinesAsync(InTheHand.Storage.IStorageFile,System.Collections.Generic.IEnumerable{System.String},InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Appends lines of text to the specified file using the specified character encoding.
|
||
</summary>
|
||
<param name="file">The file that the lines are appended to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.AppendTextAsync(InTheHand.Storage.IStorageFile,System.String)">
|
||
<summary>
|
||
Appends text to the specified file.
|
||
</summary>
|
||
<param name="file">The file that the text is appended to.</param>
|
||
<param name="contents">The text to append.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.AppendTextAsync(InTheHand.Storage.IStorageFile,System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Appends text to the specified file using the specified character encoding.
|
||
</summary>
|
||
<param name="file">The file that the text is appended to.</param>
|
||
<param name="contents">The text to append.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.ReadLinesAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Reads the contents of the specified file and returns lines of text.
|
||
</summary>
|
||
<param name="file">The file to read.</param>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.ReadLinesAsync(InTheHand.Storage.IStorageFile,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Reads the contents of the specified file using the specified character encoding and returns lines of text.
|
||
</summary>
|
||
<param name="file">The file to read.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.ReadTextAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Reads the contents of the specified file and returns text.
|
||
</summary>
|
||
<param name="file">The file to read.</param>
|
||
<returns>When this method completes successfully, it returns the contents of the file as a text string.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.ReadTextAsync(InTheHand.Storage.IStorageFile,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Reads the contents of the specified file using the specified character encoding and returns text.
|
||
</summary>
|
||
<param name="file">The file to read.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>When this method completes successfully, it returns the contents of the file as a text string.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.WriteLinesAsync(InTheHand.Storage.IStorageFile,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Writes lines of text to the specified file.
|
||
</summary>
|
||
<param name="file">The file that the lines are written to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.WriteLinesAsync(InTheHand.Storage.IStorageFile,System.Collections.Generic.IEnumerable{System.String},InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Writes lines of text to the specified file using the specified character encoding.
|
||
</summary>
|
||
<param name="file">The file that the lines are written to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.WriteTextAsync(InTheHand.Storage.IStorageFile,System.String)">
|
||
<summary>
|
||
Writes text to the specified file.
|
||
</summary>
|
||
<param name="file">The file that the text is written to.</param>
|
||
<param name="contents">The text to write.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.FileIO.WriteTextAsync(InTheHand.Storage.IStorageFile,System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Writes text to the specified file using the specified character encoding.
|
||
</summary>
|
||
<param name="file">The file that the text is written to.</param>
|
||
<param name="contents">The text to write.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.FileProperties.BasicProperties">
|
||
<summary>
|
||
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).
|
||
</summary>
|
||
<seealso cref="M:InTheHand.Storage.IStorageItem.GetBasicPropertiesAsync"/>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.FileProperties.BasicProperties.DateModified">
|
||
<summary>
|
||
Gets the timestamp of the last time the file was modified.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.FileProperties.BasicProperties.Size">
|
||
<summary>
|
||
Gets the size of the file in bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.FileProperties.ThumbnailMode">
|
||
<summary>
|
||
Describes the purpose of the thumbnail to determine how to adjust the thumbnail image to retrieve.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileProperties.ThumbnailMode.MediaView">
|
||
<summary>
|
||
To display previews of picture or video files.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileProperties.ThumbnailMode.ListView">
|
||
<summary>
|
||
To display previews of files (or other items) in a list.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.FileProperties.ThumbnailMode.SingleItem">
|
||
<summary>
|
||
To display a preview of any single item (like a file, folder, or file group).
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.IStorageFile">
|
||
<summary>
|
||
Represents a file.
|
||
Provides information about the file and its contents, and ways to manipulate them.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.CopyAndReplaceAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Replaces the specified file with a copy of the current file.
|
||
</summary>
|
||
<param name="fileToReplace">The file to replace.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.CopyAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Creates a copy of the file in the specified folder.
|
||
</summary>
|
||
<param name="destinationFolder"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.CopyAsync(InTheHand.Storage.IStorageFolder,System.String)">
|
||
<summary>
|
||
Creates a copy of the file in the specified folder, using the desired name.
|
||
</summary>
|
||
<param name="destinationFolder"></param>
|
||
<param name="desiredNewName"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.MoveAndReplaceAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Moves the current file to the location of the specified file and replaces the specified file in that location.
|
||
</summary>
|
||
<param name="fileToReplace"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.MoveAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Moves the current file to the specified folder.
|
||
</summary>
|
||
<param name="destinationFolder"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFile.MoveAsync(InTheHand.Storage.IStorageFolder,System.String)">
|
||
<summary>
|
||
Moves the current file to the specified folder and renames the file according to the desired name.
|
||
</summary>
|
||
<param name="destinationFolder"></param>
|
||
<param name="desiredNewName"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageFile.ContentType">
|
||
<summary>
|
||
Gets the MIME type of the contents of the file.
|
||
</summary>
|
||
<value>The MIME type of the file contents.
|
||
For example, a music file might have the "audio/mpeg" MIME type.</value>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageFile.FileType">
|
||
<summary>
|
||
Gets the type (file name extension) of the file.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.IStorageFolder">
|
||
<summary>
|
||
Manipulates folders and their contents, and provides information about them.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.CreateFileAsync(System.String)">
|
||
<summary>
|
||
Creates a new file in the current folder.
|
||
</summary>
|
||
<param name="desiredName">The desired name of the file to create.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.CreateFileAsync(System.String,InTheHand.Storage.CreationCollisionOption)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="desiredName">The desired name of the file to create.</param>
|
||
<param name="options">The enum value that determines what to do if the desiredName is the same as the name of an existing file in the current folder.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.CreateFolderAsync(System.String)">
|
||
<summary>
|
||
Creates a new folder in the current folder.
|
||
</summary>
|
||
<param name="desiredName">The desired name of the folder to create.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.CreateFolderAsync(System.String,InTheHand.Storage.CreationCollisionOption)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="desiredName">The desired name of the folder to create.</param>
|
||
<param name="options">The enum value that determines what to do if the desiredName is the same as the name of an existing folder in the current folder.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetFileAsync(System.String)">
|
||
<summary>
|
||
Gets the specified file from the current folder.
|
||
</summary>
|
||
<param name="filename">The name (or path relative to the current folder) of the file to retrieve.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetFilesAsync">
|
||
<summary>
|
||
Gets the files from the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetFolderAsync(System.String)">
|
||
<summary>
|
||
Gets the specified folder from the current folder.
|
||
</summary>
|
||
<param name="name">The name of the child folder to retrieve.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetFoldersAsync">
|
||
<summary>
|
||
Gets the folders in the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetItemAsync(System.String)">
|
||
<summary>
|
||
Gets the specified item from the <see cref="T:InTheHand.Storage.IStorageFolder"/>.
|
||
</summary>
|
||
<param name="name">The name of the item to retrieve.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.GetItemsAsync">
|
||
<summary>
|
||
Gets the items from the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageFolder.TryGetItemAsync(System.String)">
|
||
<summary>
|
||
Try to get a single file or sub-folder from the current folder by using the name of the item.
|
||
</summary>
|
||
<param name="name">The name (or path relative to the current folder) of the file or sub-folder to try to retrieve.</param>
|
||
<returns>When this method completes successfully, it returns the file or folder (type <see cref="T:InTheHand.Storage.IStorageItem"/>).</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.IStorageItem">
|
||
<summary>
|
||
Manipulates storage items (files and folders) and their contents, and provides information about them.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.DeleteAsync">
|
||
<summary>
|
||
Deletes the current item.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.DeleteAsync(InTheHand.Storage.StorageDeleteOption)">
|
||
<summary>
|
||
Deletes the current item, optionally deleting it permanently.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.GetBasicPropertiesAsync">
|
||
<summary>
|
||
Gets the basic properties of the current item (like a file or folder).
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.IsOfType(InTheHand.Storage.StorageItemTypes)">
|
||
<summary>
|
||
Determines whether the current IStorageItem matches the specified StorageItemTypes value.
|
||
</summary>
|
||
<param name="type">The value to match against.</param>
|
||
<returns></returns>
|
||
<seealso cref="T:InTheHand.Storage.StorageItemTypes"/>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageItem.Attributes">
|
||
<summary>
|
||
Gets the attributes of a storage item.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageItem.DateCreated">
|
||
<summary>
|
||
Gets the date and time when the current item was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageItem.Name">
|
||
<summary>
|
||
Gets the name of the item including the file name extension if there is one.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.IStorageItem.Path">
|
||
<summary>
|
||
Gets the full file-system path of the item, if the item has a path.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.GetParentAsync">
|
||
<summary>
|
||
Gets the parent folder of the current storage item.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.IStorageItem.IsEqual(InTheHand.Storage.IStorageItem)">
|
||
<summary>
|
||
Indicates whether the current item is the same as the specified item.
|
||
</summary>
|
||
<param name="item">The <see cref="T:InTheHand.Storage.IStorageItem"/> object that represents a storage item to compare against.</param>
|
||
<returns>Returns true if the current storage item is the same as the specified storage item; otherwise false.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.KnownFolders">
|
||
<summary>
|
||
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).
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.KnownFolders.CameraRoll">
|
||
<summary>
|
||
Gets the Camera Roll folder.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 8.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.KnownFolders.DocumentsLibrary">
|
||
<summary>
|
||
Gets the Documents library.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.KnownFolders.MusicLibrary">
|
||
<summary>
|
||
Gets the Music library.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.KnownFolders.PicturesLibrary">
|
||
<summary>
|
||
Gets the Pictures library.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.KnownFolders.VideosLibrary">
|
||
<summary>
|
||
Gets the Videos library.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.NameCollisionOption">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.NameCollisionOption.GenerateUniqueName">
|
||
<summary>
|
||
Automatically append a number to the base of the specified name if the file or folder already exists.
|
||
For example, if MyFile.txt already exists, then the new file is named MyFile(2).txt.
|
||
If MyFolder already exists, then the new folder is named MyFolder(2).
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.NameCollisionOption.ReplaceExisting">
|
||
<summary>
|
||
Replace the existing item if the file or folder already exists.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.NameCollisionOption.FailIfExists">
|
||
<summary>
|
||
Raise an exception of type System.Exception if the file or folder already exists.
|
||
Methods that don't explicitly pass a value from the NameCollisionOption enumeration use the FailIfExists value as the default when you try to create, rename, copy, or move a file or folder.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.PathIO">
|
||
<summary>
|
||
Provides helper methods for reading and writing a file using the absolute path or URI of the file.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.AppendLinesAsync(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Appends lines of text to the file at the specified path or URI.
|
||
</summary>
|
||
<param name="absolutePath">The path or URI of the file that the lines are appended to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.AppendLinesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Appends lines of text to the file at the specified path or URI using the specified character encoding.
|
||
</summary>
|
||
<param name="absolutePath">The path or URI of the file that the lines are appended to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.AppendTextAsync(System.String,System.String)">
|
||
<summary>
|
||
Appends text to the file at the specified path or URI.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the text is appended to.</param>
|
||
<param name="contents">The text to append.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.AppendTextAsync(System.String,System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Appends text to the file at the specified path or URI using the specified character encoding.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the text is appended to.</param>
|
||
<param name="contents">The text to append.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.ReadLinesAsync(System.String)">
|
||
<summary>
|
||
Reads the contents of the file at the specified path or URI and returns lines of text.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file to read.</param>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.ReadLinesAsync(System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Reads the contents of the file at the specified path or URI using the specified character encoding and returns lines of text.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file to read.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.ReadTextAsync(System.String)">
|
||
<summary>
|
||
Reads the contents of the file at the specified path or URI and returns text.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file to read.</param>
|
||
<returns>When this method completes successfully, it returns the contents of the file as a text string.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.ReadTextAsync(System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Reads the contents of the file at the specified path or URI using the specified character encoding and returns text.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file to read.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>When this method completes successfully, it returns the contents of the file as a text string.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.WriteLinesAsync(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Writes lines of text to the file at the specified path or URI.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the lines are written to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.WriteLinesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Writes lines of text to the file at the specified path or URI using the specified character encoding.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the lines are written to.</param>
|
||
<param name="lines">The list of text strings to append as lines.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.WriteTextAsync(System.String,System.String)">
|
||
<summary>
|
||
Writes text to the file at the specified path or URI.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the text is written to.</param>
|
||
<param name="contents">The text to write.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.PathIO.WriteTextAsync(System.String,System.String,InTheHand.Storage.Streams.UnicodeEncoding)">
|
||
<summary>
|
||
Writes text to the file at the specified path or URI using the specified character encoding.
|
||
</summary>
|
||
<param name="absolutePath">The path of the file that the text is written to.</param>
|
||
<param name="contents">The text to write.</param>
|
||
<param name="encoding">The character encoding of the file.</param>
|
||
<returns>No object or value is returned when this method completes.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.StorageDeleteOption">
|
||
<summary>
|
||
Specifies whether a deleted item is moved to the Recycle Bin or permanently deleted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.StorageDeleteOption.Default">
|
||
<summary>
|
||
Specifies the default behavior.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.StorageDeleteOption.PermanentDelete">
|
||
<summary>
|
||
Permanently deletes the item.
|
||
The item is not moved to the Recycle Bin.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.StorageFile">
|
||
<summary>
|
||
Represents a file.
|
||
Provides information about the file and its content, and ways to manipulate them.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.GetFileFromPathAsync(System.String)">
|
||
<summary>
|
||
Gets a StorageFile object to represent the file at the specified path.
|
||
</summary>
|
||
<param name="path">The path of the file to get a StorageFile to represent.
|
||
If your path uses slashes, make sure you use backslashes(\).
|
||
Forward slashes(/) are not accepted by this method.</param>
|
||
<returns>When this method completes, it returns the file as a StorageFile.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.CopyAndReplaceAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Replaces the specified file with a copy of the current file.
|
||
</summary>
|
||
<param name="fileToReplace"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.CopyAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Creates a copy of the file in the specified folder.
|
||
</summary>
|
||
<param name="destinationFolder">The destination folder where the copy of the file is created.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.CopyAsync(InTheHand.Storage.IStorageFolder,System.String)">
|
||
<summary>
|
||
Creates a copy of the file in the specified folder and renames the copy.
|
||
</summary>
|
||
<param name="destinationFolder">The destination folder where the copy of the file is created.</param>
|
||
<param name="desiredNewName">The new name for the copy of the file created in the destinationFolder.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.DeleteAsync">
|
||
<summary>
|
||
Deletes the current file.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.DeleteAsync(InTheHand.Storage.StorageDeleteOption)">
|
||
<summary>
|
||
Deletes the current file, optionally deleting the item permanently.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.GetBasicPropertiesAsync">
|
||
<summary>
|
||
Gets the basic properties of the current file.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.GetThumbnailAsync(InTheHand.Storage.FileProperties.ThumbnailMode)">
|
||
<summary>
|
||
Retrieves an adjusted thumbnail image for the file, determined by the purpose of the thumbnail.
|
||
</summary>
|
||
<param name="mode">The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted.</param>
|
||
<returns>When this method completes successfully, it returns a <see cref="T:InTheHand.Storage.FileProperties.StorageItemThumbnail"/> that represents the thumbnail image or null if there is no thumbnail image associated with the file.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.GetParentAsync">
|
||
<summary>
|
||
Gets the parent folder of the current file.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.MoveAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Moves the current file to the specified folder and renames the file according to the desired name.
|
||
</summary>
|
||
<param name="destinationFolder">The destination folder where the file is moved.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.MoveAsync(InTheHand.Storage.IStorageFolder,System.String)">
|
||
<summary>
|
||
Moves the current file to the specified folder and renames the file according to the desired name.
|
||
</summary>
|
||
<param name="destinationFolder">The destination folder where the file is moved.</param>
|
||
<param name="desiredNewName">The desired name of the file after it is moved.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.MoveAndReplaceAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Moves the current file to the location of the specified file and replaces the specified file in that location.
|
||
</summary>
|
||
<param name="fileToReplace">The file to replace.</param>
|
||
<returns>No object or value is returned by this method.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.RenameAsync(System.String)">
|
||
<summary>
|
||
Renames the current file.
|
||
</summary>
|
||
<param name="desiredName">The desired, new name of the current item.</param>
|
||
<returns>No object or value is returned by this method when it completes.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.RenameAsync(System.String,InTheHand.Storage.NameCollisionOption)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="desiredName">The desired, new name of the current file.
|
||
<para>If there is an existing item in the current file's location that already has the specified desiredName, the specified <see cref="T:InTheHand.Storage.NameCollisionOption"/> determines how the system responds to the conflict.</para></param>
|
||
<param name="option">The enum value that determines how the system responds if the desiredName is the same as the name of an existing item in the current file's location.</param>
|
||
<returns>No object or value is returned by this method when it completes.</returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.Attributes">
|
||
<summary>
|
||
Gets the attributes of a file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.DateCreated">
|
||
<summary>
|
||
Gets the date and time when the current file was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.ContentType">
|
||
<summary>
|
||
Gets the MIME type of the contents of the file.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.FileType">
|
||
<summary>
|
||
Gets the type (file name extension) of the file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.Name">
|
||
<summary>
|
||
Gets the name of the file including the file name extension.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFile.Path">
|
||
<summary>
|
||
Gets the full file-system path of the current file, if the file has a path.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.IsEqual(InTheHand.Storage.IStorageItem)">
|
||
<summary>
|
||
Indicates whether the current file is equal to the specified file.
|
||
</summary>
|
||
<param name="item">The <see cref="T:InTheHand.Storage.IStorageItem"/> object that represents a file to compare against.</param>
|
||
<returns>Returns true if the current file is equal to the specified file; otherwise false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFile.IsOfType(InTheHand.Storage.StorageItemTypes)">
|
||
<summary>
|
||
Determines whether the current <see cref="T:InTheHand.Storage.StorageFile"/> matches the specified <see cref="T:InTheHand.Storage.StorageItemTypes"/> value.
|
||
</summary>
|
||
<param name="type">The value to match against.</param>
|
||
<returns>True if the <see cref="T:InTheHand.Storage.StorageFile"/> matches the specified value; otherwise false.</returns>
|
||
<seealso cref="T:InTheHand.Storage.StorageItemTypes"/>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.StorageFolder">
|
||
<summary>
|
||
Manages folders and their contents and provides information about them.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetFolderFromPathAsync(System.String)">
|
||
<summary>
|
||
Gets a StorageFile object to represent the file at the specified path.
|
||
</summary>
|
||
<param name="path">The path of the file to get a StorageFile to represent.
|
||
If your path uses slashes, make sure you use backslashes(\).
|
||
Forward slashes(/) are not accepted by this method.</param>
|
||
<returns>When this method completes, it returns the file as a StorageFile.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.CreateFileAsync(System.String)">
|
||
<summary>
|
||
Creates a new file with the specified name in the current folder.
|
||
</summary>
|
||
<param name="desiredName">The name of the new file to create in the current folder.</param>
|
||
<returns>When this method completes, it returns a StorageFile that represents the new file.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.CreateFileAsync(System.String,InTheHand.Storage.CreationCollisionOption)">
|
||
<summary>
|
||
Creates a new file with the specified name in the current folder.
|
||
</summary>
|
||
<param name="desiredName">The name of the new file to create in the current folder.</param>
|
||
<param name="options">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.</param>
|
||
<returns>When this method completes, it returns a StorageFile that represents the new file.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.CreateFolderAsync(System.String)">
|
||
<summary>
|
||
Creates a new subfolder with the specified name in the current folder.
|
||
</summary>
|
||
<param name="desiredName">The name of the new subfolder to create in the current folder.</param>
|
||
<returns>When this method completes, it returns a StorageFolder that represents the new subfolder.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.CreateFolderAsync(System.String,InTheHand.Storage.CreationCollisionOption)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="desiredName">The name of the new subfolder to create in the current folder.</param>
|
||
<param name="options">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.</param>
|
||
<returns>When this method completes, it returns a StorageFolder that represents the new subfolder.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.DeleteAsync">
|
||
<summary>
|
||
Deletes the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.DeleteAsync(InTheHand.Storage.StorageDeleteOption)">
|
||
<summary>
|
||
Deletes the current folder.
|
||
This method also specifies whether to delete the folder permanently.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetBasicPropertiesAsync">
|
||
<summary>
|
||
Gets the basic properties of the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetFileAsync(System.String)">
|
||
<summary>
|
||
Gets the file with the specified name from the current folder.
|
||
</summary>
|
||
<param name="filename"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetFilesAsync">
|
||
<summary>
|
||
Gets the files in the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetFolderAsync(System.String)">
|
||
<summary>
|
||
Gets the specified folder from the current folder.
|
||
</summary>
|
||
<param name="name">The name of the child folder to retrieve.</param>
|
||
<returns>When this method completes successfully, it returns a StorageFolder that represents the child folder.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetFoldersAsync">
|
||
<summary>
|
||
Gets the folders in the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetItemAsync(System.String)">
|
||
<summary>
|
||
Gets the file or folder with the specified name from the current folder.
|
||
</summary>
|
||
<param name="name">The name (or path relative to the current folder) of the file or folder to get.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetItemsAsync">
|
||
<summary>
|
||
Gets the items in the current folder.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.GetParentAsync">
|
||
<summary>
|
||
Gets the parent folder of the current folder.
|
||
</summary>
|
||
<returns>When this method completes, it returns the parent folder as a <see cref="T:InTheHand.Storage.StorageFolder"/>.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.TryGetItemAsync(System.String)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="name">The name (or path relative to the current folder) of the file or folder to get.</param>
|
||
<returns>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.</returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFolder.Attributes">
|
||
<summary>
|
||
Gets the attributes of the current folder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFolder.DateCreated">
|
||
<summary>
|
||
Gets the date and time that the current folder was created.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFolder.Name">
|
||
<summary>
|
||
Gets the name of the current folder.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.StorageFolder.Path">
|
||
<summary>
|
||
Gets the full path of the current folder in the file system, if the path is available.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.IsEqual(InTheHand.Storage.IStorageItem)">
|
||
<summary>
|
||
Indicates whether the current folder is equal to the specified folder.
|
||
</summary>
|
||
<param name="item">The <see cref="T:InTheHand.Storage.IStorageItem"/> object that represents the folder to compare against.</param>
|
||
<returns>Returns true if the current folder is equal to the specified folder; otherwise false.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolder.IsOfType(InTheHand.Storage.StorageItemTypes)">
|
||
<summary>
|
||
Indicates whether the current <see cref="T:InTheHand.Storage.StorageFolder"/> matches the specified <see cref="T:InTheHand.Storage.StorageItemTypes"/> value.
|
||
</summary>
|
||
<param name="type">The enum value that determines the object type to match against.</param>
|
||
<returns>True if the <see cref="T:InTheHand.Storage.StorageFolder"/> matches the specified <see cref="T:InTheHand.Storage.StorageItemTypes"/> value; otherwise false.</returns>
|
||
<seealso cref="T:InTheHand.Storage.StorageItemTypes"/>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.StorageFolderExtensions">
|
||
<summary>
|
||
Provides additional methods for <see cref="T:InTheHand.Storage.StorageFolder"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolderExtensions.DeleteAllItems(InTheHand.Storage.StorageFolder)">
|
||
<summary>
|
||
Deletes all contents of a folder without deleting the folder itself.
|
||
</summary>
|
||
<param name="folder"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Storage.StorageFolderExtensions.GetFolderSizeAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Returns the size, in bytes, of the folder and all of its contents.
|
||
</summary>
|
||
<param name="folder">The folder to measure</param>
|
||
<returns>The size, in bytes, of the folder and all of its contents.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.StorageItemTypes">
|
||
<summary>
|
||
Describes whether an item that implements the <see cref="T:InTheHand.Storage.IStorageItem"/> interface is a file or a folder.
|
||
</summary>
|
||
<seealso cref="M:InTheHand.Storage.IStorageItem.IsOfType(InTheHand.Storage.StorageItemTypes)"/>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.StorageItemTypes.None">
|
||
<summary>
|
||
A storage item that is neither a file nor a folder.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.StorageItemTypes.File">
|
||
<summary>
|
||
A file that is represented as a <see cref="T:InTheHand.Storage.StorageFile"/> instance.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.StorageItemTypes.Folder">
|
||
<summary>
|
||
A folder that is represented as a <see cref="T:InTheHand.Storage.StorageFolder"/> instance.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Storage.Streams.UnicodeEncoding">
|
||
<summary>
|
||
Specifies the type of character encoding for a stream.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.Streams.UnicodeEncoding.Utf8">
|
||
<summary>
|
||
The encoding is UTF-8.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.Streams.UnicodeEncoding.Utf16LE">
|
||
<summary>
|
||
The encoding is UTF-16, with the least significant byte first in the two eight-bit bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Storage.Streams.UnicodeEncoding.Utf16BE">
|
||
<summary>
|
||
The encoding is UTF-16, with the most significant byte first in the two eight-bit bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Display.DisplayRequest">
|
||
<summary>
|
||
Represents a display request.
|
||
</summary>
|
||
<remarks>
|
||
To conserve power and extend battery life, the system reduces power to the computer if it does not detect any user activity for a certain amount of time.
|
||
Depending on system power settings, the display may first be dimmed, a screen saver may be displayed, and eventually the display may be turned off as the system enters a low-power sleep state.
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Display.DisplayRequest.RequestActive">
|
||
<summary>
|
||
Activates a display request.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.System.Display.DisplayRequest.RequestRelease">
|
||
<summary>
|
||
Deactivates a display request.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Launcher">
|
||
<summary>
|
||
Starts the default app associated with the specified file or URI.
|
||
</summary>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Launcher.LaunchFileAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Starts the app associated with the specified file.
|
||
</summary>
|
||
<param name="file">The file.</param>
|
||
<returns>The launch operation.</returns>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Launcher.LaunchFolderAsync(InTheHand.Storage.IStorageFolder)">
|
||
<summary>
|
||
Launches File Explorer and displays the contents of the specified folder.
|
||
</summary>
|
||
<param name="folder">The folder to display in File Explorer.</param>
|
||
<returns>The result of the operation.</returns>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Launcher.LaunchUriAsync(System.Uri,InTheHand.System.LauncherOptions)">
|
||
<summary>
|
||
Starts the default app associated with the URI scheme name for the specified URI.
|
||
</summary>
|
||
<param name="uri">The URI.</param>
|
||
<param name="options">Ignored on Android and iOS.</param>
|
||
<returns>The launch operation.</returns>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Launcher.LaunchUriAsync(System.Uri)">
|
||
<summary>
|
||
Starts the default app associated with the URI scheme name for the specified URI.
|
||
</summary>
|
||
<param name="uri">The URI.</param>
|
||
<returns>The launch operation.</returns>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.System.Launcher.QueryUriSupportAsync(System.Uri,InTheHand.System.LaunchQuerySupportType)">
|
||
<summary>
|
||
Asynchronously query whether an app can be activated for the specified URI and launch type.
|
||
</summary>
|
||
<param name="uri">The URI.</param>
|
||
<param name="launchQuerySupportType">The type of launch for which to query support.</param>
|
||
<returns>Returns true if the default app for the URI scheme was launched; false otherwise.</returns>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>-</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.System.LauncherOptions">
|
||
<summary>
|
||
Placeholder to supply attributes for starting a task.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.LaunchQuerySupportStatus">
|
||
<summary>
|
||
Specifies whether an app is available that supports activation
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>-</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>-</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>-</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportStatus.Available">
|
||
<summary>
|
||
An app that handles the activation is available and may be activated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportStatus.AppNotInstalled">
|
||
<summary>
|
||
No app is installed to handle the activation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportStatus.AppUnavailable">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportStatus.NotSupported">
|
||
<summary>
|
||
The app does not handle the activation.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportStatus.Unknown">
|
||
<summary>
|
||
An unknown error was encountered while determining whether an app supports the activation.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.LaunchQuerySupportType">
|
||
<summary>
|
||
Specifies the type of activation to query for.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>-</description></item>
|
||
<item><term>iOS</term><description>-</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Store</term><description>-</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>-</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>-</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportType.Uri">
|
||
<summary>
|
||
Activate by URI but do not return a result to the calling app.
|
||
This is the default.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.LaunchQuerySupportType.UriForResults">
|
||
<summary>
|
||
Activate by URI and return a result to the calling app.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.ProcessorArchitecture">
|
||
<summary>
|
||
Specifies the processor architecture supported by an app.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="F:InTheHand.System.ProcessorArchitecture.X86">
|
||
<summary>
|
||
The x86 processor architecture.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.ProcessorArchitecture.Arm">
|
||
<summary>
|
||
The ARM processor architecture.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.ProcessorArchitecture.X64">
|
||
<summary>
|
||
The x64 processor architecture.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.ProcessorArchitecture.Neutral">
|
||
<summary>
|
||
A neutral processor architecture.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.ProcessorArchitecture.Unknown">
|
||
<summary>
|
||
An unknown processor architecture.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Profile.AnalyticsInfo">
|
||
<summary>
|
||
Provides information about the device for profiling purposes.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.System.Profile.AnalyticsInfo.DeviceForm">
|
||
<summary>
|
||
Gets the device form factor.
|
||
For example, the app could be running on a phone, tablet, desktop, and so on.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.System.Profile.AnalyticsInfo.VersionInfo">
|
||
<summary>
|
||
Gets version info about the device family.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Profile.AnalyticsVersionInfo">
|
||
<summary>
|
||
Provides version information about the device family.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.System.Profile.AnalyticsVersionInfo.DeviceFamily">
|
||
<summary>
|
||
Gets a string that represents the type of device the application is running on.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.System.Profile.AnalyticsVersionInfo.DeviceFamilyVersion">
|
||
<summary>
|
||
Gets the version within the device family.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ApplicationSettings.SettingsCommand">
|
||
<summary>
|
||
Creates a settings command object that represents a settings entry.
|
||
This settings command can be appended to the ApplicationCommands collection.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ApplicationSettings.SettingsCommand.#ctor(System.Object,System.String,InTheHand.UI.Popups.UICommandInvokedHandler)">
|
||
<summary>
|
||
Creates a new settings command.
|
||
</summary>
|
||
<param name="settingsCommandId">The ID of the command.</param>
|
||
<param name="label">The label for the command, which is displayed in the settings pane.</param>
|
||
<param name="handler">The event handler that is called when the user selects this command in the settings pane.</param>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ApplicationSettings.SettingsCommand.Id">
|
||
<summary>
|
||
Gets or sets the command ID.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ApplicationSettings.SettingsCommand.Invoked">
|
||
<summary>
|
||
Gets or sets the handler for the event that is raised when the user selects the command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ApplicationSettings.SettingsCommand.Label">
|
||
<summary>
|
||
Gets or sets the label for the command.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ApplicationSettings.SettingsPane">
|
||
<summary>
|
||
A static class that enables the app to control the Settings page.
|
||
The app can add or remove commands, receive a notification when the user opens the pane, or open the page programmatically.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ApplicationSettings.SettingsPane.GetForCurrentView">
|
||
<summary>
|
||
Gets a <see cref="T:InTheHand.UI.ApplicationSettings.SettingsPane"/> object that is associated with the current app.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ApplicationSettings.SettingsPane.Show">
|
||
<summary>
|
||
Displays the Settings page to the user.
|
||
</summary>
|
||
</member>
|
||
<member name="E:InTheHand.UI.ApplicationSettings.SettingsPane.CommandsRequested">
|
||
<summary>
|
||
Occurs when the user opens the settings pane.
|
||
Listening for this event lets the app initialize the setting commands and pause its UI until the user closes the pane.
|
||
During this event, append your SettingsCommand objects to the available ApplicationCommands vector to make them available to the SettingsPane UI.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ApplicationSettings.SettingsPaneCommandsRequest">
|
||
<summary>
|
||
Contains properties that are only available during the <see cref="E:InTheHand.UI.ApplicationSettings.SettingsPane.CommandsRequested"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ApplicationSettings.SettingsPaneCommandsRequest.ApplicationCommands">
|
||
<summary>
|
||
A vector that is available during the <see cref="E:InTheHand.UI.ApplicationSettings.SettingsPane.CommandsRequested"/> event.
|
||
Append SettingsCommand objects to it to make them available to the SettingsPane UI.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ApplicationSettings.SettingsPaneCommandsRequestedEventArgs">
|
||
<summary>
|
||
Contains arguments that are available from the event object during the <see cref="E:InTheHand.UI.ApplicationSettings.SettingsPane.CommandsRequested"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ApplicationSettings.SettingsPaneCommandsRequestedEventArgs.Request">
|
||
<summary>
|
||
An instance of <see cref="T:InTheHand.UI.ApplicationSettings.SettingsPaneCommandsRequest"/> that is made available during the <see cref="E:InTheHand.UI.ApplicationSettings.SettingsPane.CommandsRequested"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Color">
|
||
<summary>
|
||
Describes a color in terms of alpha, red, green, and blue channels.
|
||
Can be implicitly converted into a variety of platform-specific types.
|
||
</summary>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Platform Type</description></listheader>
|
||
<item><term>Android</term><description>Android.Graphics.Color</description></item>
|
||
<item><term>iOS, tvOS, macOS, watchOS</term><description>CoreGraphics.CGColor</description></item>
|
||
<item><term>iOS, tvOS, macOS</term><description>CoreImage.CIColor</description></item>
|
||
<item><term>iOS, tvOS</term><description>UIKit.UIColor</description></item>
|
||
<item><term>macOS</term><description>AppKit.NSColor</description></item>
|
||
<item><term>Windows UWP, Windows Store, Windows Phone Store</term><description>Windows.UI.Color</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>System.Windows.Media.Color</description></item></list>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Color.FromArgb(System.Byte,System.Byte,System.Byte)">
|
||
<summary>
|
||
Creates a new <see cref="T:InTheHand.UI.Color"/> structure by using the specified sRGB color channel values.
|
||
</summary>
|
||
<param name="r"></param>
|
||
<param name="g"></param>
|
||
<param name="b"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Color.FromArgb(System.Byte,System.Byte,System.Byte,System.Byte)">
|
||
<summary>
|
||
Creates a new <see cref="T:InTheHand.UI.Color"/> structure by using the specified sRGB alpha channel and color channel values.
|
||
</summary>
|
||
<param name="a"></param>
|
||
<param name="r"></param>
|
||
<param name="g"></param>
|
||
<param name="b"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Color.Equals(InTheHand.UI.Color)">
|
||
<summary>
|
||
Compares two <see cref="T:InTheHand.UI.Color"/> structures for equality.
|
||
</summary>
|
||
<param name="color">The <see cref="T:InTheHand.UI.Color"/> structure to compare to this <see cref="T:InTheHand.UI.Color"/>.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Color.ToArgb">
|
||
<summary>
|
||
Returns the color value as a UInt32 of the form 0xBBGGRRAA.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Color.ToString">
|
||
<summary>
|
||
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Color.A">
|
||
<summary>
|
||
Gets or sets the sRGB alpha channel value of the color.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Color.B">
|
||
<summary>
|
||
Gets or sets the sRGB blue channel value of the color.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Color.G">
|
||
<summary>
|
||
Gets or sets the sRGB green channel value of the color.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Color.R">
|
||
<summary>
|
||
Gets or sets the sRGB red channel value of the color.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.BadgeNotification">
|
||
<summary>
|
||
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 999 (beyond this truncation will occur)
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.BadgeNotificationCreator">
|
||
<summary>
|
||
Simplifies creation of badges without the need to build XML documents.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.BadgeNotificationCreator.CreateBadgeNotification(System.UInt32)">
|
||
<summary>
|
||
Creates a badge notification with the required numerical value.
|
||
</summary>
|
||
<param name="value">Value to show on the badge. Zero will hide the badge.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.BadgeUpdateManager">
|
||
<summary>
|
||
Creates <see cref="T:InTheHand.UI.Notifications.BadgeUpdater"/> objects that you use to manipulate a tile's badge overlay.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.BadgeUpdateManager.CreateBadgeUpdaterForApplication">
|
||
<summary>
|
||
Creates and initializes a new instance of the <see cref="T:InTheHand.UI.Notifications.BadgeUpdater"/>, which lets you change the appearance or content of the badge on the calling app's tile.
|
||
</summary>
|
||
<returns>The object you will use to send changes to the app tile's badge.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.BadgeUpdater">
|
||
<summary>
|
||
Updates a badge overlay on the specific tile that the updater is bound to.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>watchOS</term><description>watchOS 2.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.BadgeUpdater.Clear">
|
||
<summary>
|
||
Removes the badge from the tile that the updater is bound to.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.BadgeUpdater.Update(InTheHand.UI.Notifications.BadgeNotification)">
|
||
<summary>
|
||
Applies a change to the badge's number.
|
||
</summary>
|
||
<param name="notification">The object that supplies the new XML definition for the badge.</param>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Popups.IUICommand">
|
||
<summary>
|
||
Represents a command in a context menu or message dialog box.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.IUICommand.Id">
|
||
<summary>
|
||
Gets or sets the identifier of the command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.IUICommand.Invoked">
|
||
<summary>
|
||
Ges or sets the handler for the event that is fired when the user invokes the command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.IUICommand.Label">
|
||
<summary>
|
||
Gets or sets the label for the command.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Popups.UICommandInvokedHandler">
|
||
<summary>
|
||
Represents a callback function that handles the event that is fired when the user invokes a context menu command.
|
||
</summary>
|
||
<param name="command">Represents the invoked command.</param>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Popups.MessageDialog">
|
||
<summary>
|
||
Represents a dialog.
|
||
</summary>
|
||
<remarks>
|
||
The dialog has a command bar that can support up to three commands.
|
||
If you don't specify any commands, then a default command is added to close the dialog.
|
||
<para>The dialog dims the screen behind it and blocks touch events from passing to the app's canvas until the user responds.</para>
|
||
<para>Message dialogs should be used sparingly, and only for critical messages or simple questions that must block the user's flow.</para>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.MessageDialog.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:InTheHand.UI.Popups.MessageDialog"/> class to display an untitled message dialog box that can be used to ask your user simple questions.
|
||
</summary>
|
||
<param name="content">The message you want displayed to the user.</param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.MessageDialog.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:InTheHand.UI.Popups.MessageDialog"/> class to display a titled message dialog box that can be used to ask your user simple questions.
|
||
</summary>
|
||
<param name="content">The message you want displayed to the user.</param>
|
||
<param name="title">The title you want displayed on the dialog box.</param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.MessageDialog.ShowAsync">
|
||
<summary>
|
||
Begins an asynchronous operation showing a dialog.
|
||
</summary>
|
||
<returns>An object that represents the asynchronous operation.
|
||
For more on the async pattern, see Asynchronous programming in the Windows Runtime.</returns>
|
||
<remarks>In some cases, such as when the dialog is closed by the system out of your control, your result can be an empty command.
|
||
Returns either the command selected which destroyed the dialog, or an empty command.
|
||
For example, a dialog hosted in a charms window will return an empty command if the charms window has been dismissed.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.MessageDialog.Commands">
|
||
<summary>
|
||
Gets the set of commands that appear in the command bar of the message dialog.
|
||
</summary>
|
||
<remarks>This is the array of commands that makes the dialog actionable.
|
||
Get this array and add your dialog commands to it.</remarks>
|
||
<value>The commands.</value>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.MessageDialog.Content">
|
||
<summary>
|
||
Gets or sets the message to be displayed to the user.
|
||
</summary>
|
||
<value>The message to be displayed to the user.</value>
|
||
<remarks>Use the content to convey the objective of the dialog.
|
||
Present the message, error or blocking question as simply as possible without extraneous information.
|
||
<para>When a title is used, use the content to present additional information helpful to understanding or using the dialog.
|
||
You can use this area to provide more detail or define terminology.
|
||
Don't repeat the title with slightly different wording.</para></remarks>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.MessageDialog.CancelCommandIndex">
|
||
<summary>
|
||
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.
|
||
<para>Add the commands before you set the index.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.MessageDialog.DefaultCommandIndex">
|
||
<summary>
|
||
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 instead of a specific command, for example.
|
||
</summary>
|
||
<remarks>Add the commands before you set the index.</remarks>
|
||
<value>The index of the default command.</value>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.MessageDialog.Title">
|
||
<summary>
|
||
Gets or sets the title to display on the dialog box, if any.
|
||
</summary>
|
||
<value>The title you want to display on the dialog.
|
||
If the title is not set, this will return an empty string.</value>
|
||
<remarks>Use the title as a concise main instruction to convey the objective of the dialog.
|
||
<para>Long titles do not wrap and will be truncated.</para>
|
||
<para>If you're using the dialog to deliver a simple message, error or question, omit the title.
|
||
Rely on the <see cref="P:InTheHand.UI.Popups.MessageDialog.Content"/> to deliver that core information.</para></remarks>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Popups.UICommand">
|
||
<summary>
|
||
Represents a command in a context menu.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.UICommand.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:InTheHand.UI.Popups.UICommand"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.UICommand.#ctor(System.String,InTheHand.UI.Popups.UICommandInvokedHandler)">
|
||
<summary>
|
||
Initializes a new instance of the UICommand class, using the specified label and event handler.
|
||
</summary>
|
||
<param name="label">The label for the new command.</param>
|
||
<param name="action">The event handler for the new command. </param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Popups.UICommand.#ctor(System.String,InTheHand.UI.Popups.UICommandInvokedHandler,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the UICommand class, using the specified label, event handler, and command identifier.
|
||
</summary>
|
||
<param name="label">The label for the new command.</param>
|
||
<param name="action">The event handler for the new command.</param>
|
||
<param name="commandId">The command identifier for the new command.</param>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.UICommand.Id">
|
||
<summary>
|
||
Gets or sets the identifier of the command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.UICommand.Invoked">
|
||
<summary>
|
||
Gets or sets the handler for the event that is raised when the user selects the command.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Popups.UICommand.Label">
|
||
<summary>
|
||
Gets or sets the label for the command.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ViewManagement.UIColorType">
|
||
<summary>
|
||
Defines constants that specify known system color values.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIColorType.Background">
|
||
<summary>
|
||
The background color.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIColorType.Foreground">
|
||
<summary>
|
||
The foreground color.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIColorType.Accent">
|
||
<summary>
|
||
The accent color.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ViewManagement.UIElementType">
|
||
<summary>
|
||
Defines the set of user interface element types.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.ActiveCaption">
|
||
<summary>
|
||
An active caption element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.Background">
|
||
<summary>
|
||
A background element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.ButtonFace">
|
||
<summary>
|
||
A button face element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.ButtonText">
|
||
<summary>
|
||
The text displayed on a button.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.CaptionText">
|
||
<summary>
|
||
The text displayed in a caption.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.GrayText">
|
||
<summary>
|
||
Greyed text.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.Highlight">
|
||
<summary>
|
||
A highlighted user interface (UI) element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.HighlightText">
|
||
<summary>
|
||
Highlighted text.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.Hotlight">
|
||
<summary>
|
||
A hotlighted UI element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.InactiveCaption">
|
||
<summary>
|
||
An inactive caption element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.InactiveCaptionText">
|
||
<summary>
|
||
The text displayed in an inactive caption element.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.Window">
|
||
<summary>
|
||
A window.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.ViewManagement.UIElementType.WindowText">
|
||
<summary>
|
||
The text displayed in a window's UI decoration.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ViewManagement.UISettings">
|
||
<summary>
|
||
Contains a set of common app user interface settings and operations.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10 Mobile</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ViewManagement.UISettings.GetColorValue(InTheHand.UI.ViewManagement.UIColorType)">
|
||
<summary>
|
||
Returns the color value of the specified color type.
|
||
</summary>
|
||
<param name="desiredColor">An enumeration value that specifies the type of color to get a value for.</param>
|
||
<returns>The color value of the specified color type.</returns>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10 Mobile</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ViewManagement.UISettings.UIElementColor(InTheHand.UI.ViewManagement.UIElementType)">
|
||
<summary>
|
||
Gets the color used for a specific user interface element type, such as a button face or window text.
|
||
</summary>
|
||
<param name="desiredElement">The type of element for which the color will be obtained.</param>
|
||
<returns>The color of the element type, expressed as a 32-bit color value.</returns>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Windows UWP</term><description>Windows 10 Mobile</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item>
|
||
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Xaml.DispatcherTimer">
|
||
<summary>
|
||
Provides a timer that is integrated into the Dispatcher queue, which is processed at a specified interval of time.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>tvOS</term><description>tvOS 9.0 and later</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
||
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
||
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
||
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.0 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Xaml.DispatcherTimer.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:InTheHand.UI.Xaml.DispatcherTimer"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:InTheHand.UI.Xaml.DispatcherTimer.Tick">
|
||
<summary>
|
||
Occurs when the timer interval has elapsed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Xaml.DispatcherTimer.Interval">
|
||
<summary>
|
||
Gets or sets the amount of time between timer ticks.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Xaml.DispatcherTimer.IsEnabled">
|
||
<summary>
|
||
Gets a value that indicates whether the timer is running.
|
||
</summary>
|
||
<value>true if the timer is enabled and running; otherwise, false.</value>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Xaml.DispatcherTimer.Start">
|
||
<summary>
|
||
Starts the <see cref="T:InTheHand.UI.Xaml.DispatcherTimer"/>.
|
||
</summary>
|
||
<remarks>If the timer has already started, then it is restarted.</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Xaml.DispatcherTimer.Stop">
|
||
<summary>
|
||
Stops the <see cref="T:InTheHand.UI.Xaml.DispatcherTimer"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:System.IO.InTheHandRuntimeStorageExtensions">
|
||
<summary>
|
||
Contains extension methods for the IStorageFile and IStorageFolder interfaces for .NET interop.
|
||
</summary>
|
||
</member>
|
||
<member name="M:System.IO.InTheHandRuntimeStorageExtensions.OpenStreamForReadAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Retrieves a stream for reading from a specified file.
|
||
</summary>
|
||
<param name="windowsRuntimeFile"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:System.IO.InTheHandRuntimeStorageExtensions.OpenStreamForReadAsync(InTheHand.Storage.IStorageFolder,System.String)">
|
||
<summary>
|
||
Retrieves a stream for reading from a file in the specified parent folder.
|
||
</summary>
|
||
<param name="rootDirectory">The Windows Runtime IStorageFolder object that contains the file to read from.</param>
|
||
<param name="relativePath">The path, relative to the root folder, to the file to read from.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:System.IO.InTheHandRuntimeStorageExtensions.OpenStreamForWriteAsync(InTheHand.Storage.IStorageFile)">
|
||
<summary>
|
||
Retrieves a stream for writing to a specified file.
|
||
</summary>
|
||
<param name="windowsRuntimeFile">The Windows Runtime IStorageFile object to write to.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:System.IO.InTheHandRuntimeStorageExtensions.OpenStreamForWriteAsync(InTheHand.Storage.IStorageFolder,System.String,InTheHand.Storage.CreationCollisionOption)">
|
||
<summary>
|
||
Retrieves a stream for writing from a file in the specified parent folder.
|
||
</summary>
|
||
<param name="rootDirectory">The Windows Runtime IStorageFolder object that contains the file to write to.</param>
|
||
<param name="relativePath">The path, relative to the root folder, to the file to write to.</param>
|
||
<param name="creationCollisionOption"></param>
|
||
<returns></returns>
|
||
</member>
|
||
</members>
|
||
</doc>
|